au3 admin — Command Reference
CLI command group: au3 admin
Administrative commands for managing compute environments, compute environment tenants, and toolbelt publishing.
au3 admin compute-environment
au3 admin compute-environment list
List compute environments
Option
Type
Required
Default
Notes
--fields
string
Comma-separate list of fields to display
--filter
string
Filter in JSON/YAML format or path to file containing filter
--sort
string
Ordered list of fields to sort by in JSON/YAML format or path to file containing sorting
--search
string
Search in JSON/YAML format or path to file containing search
--limit
100
Number of results to fetch
--skip
Number of results to skip
--all
boolean
false
Whether to fetch results from all pages
--stream
boolean
false
Whether to print results as they are received without buffering (as JSON)
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 admin compute-environment view
View compute environment
Option
Type
Required
Default
Notes
--id
string
✅
--fields
string
comma-separate list of fields to display
--update-spec
boolean
print in the form which is usable for the update command
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 admin compute-environment create
Create compute environment
Option
Type
Required
Default
Notes
--id
string
✅
Compute Environment id
--name
string
✅
Object name with 2-64 characters
--description
string
Object description with 0 or 2-256 characters
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 admin compute-environment update
Update compute environment
Option
Type
Required
Default
Notes
--spec-schema
boolean
view the schema for update
--spec
string
spec in JSON/YAML format or path to file containing spec
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
--spec payload reference
Schema ID: UpdateComputeEnvironmentArgumentDto
This section documents the --spec payload accepted by au3 admin compute-environment update. Run admin compute-environment update --spec-schema to fetch this schema live from the CLI at any time.
Tip: additionalProperties: false — the schema rejects any field not listed below.
Top-Level Fields
Field
Type
Required
Notes
id
string
Compute Environment id — Pattern: ^ce-[0-9A-Za-z]+[0-9A-Za-z_-]*$ — e.g. ce-env-01
version
integer
Object version number
name
string
Object name with 2-64 characters — 2–64 characters
description
string
Object description with 0 or 2-256 characters — Pattern: (^$)|(^.{2,256}$) — 0–256 characters
created_at
string
Datetime the object was created at — Format: date-time — e.g. 2026-09-03T19:51:34.403Z
created_by
object
created_req
string
Request the object was created by — Pattern: ^req-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}(\.[0-9]+)*$ — e.g. req-123e4567-e89b-41d2-a345-678901234567.0.10
updated_at
string
Datetime the object was updated at — Format: date-time — e.g. 2026-09-03T19:51:34.403Z
updated_by
object
updated_req
string
Request the object was updated by — Pattern: ^req-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}(\.[0-9]+)*$ — e.g. req-123e4567-e89b-41d2-a345-678901234567.0.10
last_heartbeat_at
string
Datetime the agent last sent a heartbeat — Format: date-time — e.g. 2026-09-03T19:51:34.403Z
state
enum
Choices: active, inactive
deployment_config
string
Stringified JSON
deployment_config_updated_at
string
Datetime the object was updated at — Format: date-time — e.g. 2026-09-03T19:51:34.403Z
deployment_config_updated_by
object
deployment_config_updated_req
string
Request the object was updated by — Pattern: ^req-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}(\.[0-9]+)*$ — e.g. req-123e4567-e89b-41d2-a345-678901234567.0.10
gateway
object
warehouse_storage
object
Configuration for storage of warehouse data
bucket_storage
object
Configuration for storage of bucket data
artifact_storage
object
Configuration for storage of task artifact data
gateway_gitlab_artifact_cache
object
Configuration for storage of cached Gitlab data
tasks
object
exasol
object
Exasol-specific configuration
starrocks
object
StarRocks-specific configuration
graylog
object
ai
object
AI model provider configuration
milvus
object
Milvus vector database configuration
limits
array
multi_part_upload_options
object
accelerated_worker
object
created_by
The created_by object is a discriminated union. One of the following 2 shapes applies.
Variant 1
Field
Type
Required
Notes
Variant 2
Field
Type
Required
Notes
updated_by
The updated_by object is a discriminated union. One of the following 2 shapes applies.
Variant 1
Field
Type
Required
Notes
Variant 2
Field
Type
Required
Notes
deployment_config_updated_by
The deployment_config_updated_by object is a discriminated union. One of the following 2 shapes applies.
Variant 1
Field
Type
Required
Notes
Variant 2
Field
Type
Required
Notes
gateway
Field
Type
Required
Notes
api_url
string
Gateway API url
warehouse_storage
Configuration for storage of warehouse data
Field
Type
Required
Notes
endpoint
string
Hostname of the object storage service
port
number
TCP/IP port number. Optional, defaults to 80 for HTTP and 443 for HTTPs.
access_key
string
Access key (user ID) of an account in the S3 service
secret_key
string
Secret key (password) of an account in the S3 service
use_ssl
boolean
Whether to enable secure (HTTPS) access
region
string
Region of the object storage service
fetch_options
object
bucket
string
Bucket containing warehouse storage
prefix
string
Prefix for objects in the bucket — Pattern: ^[\/\a-zA-Z0-9_.\-: ]+$ — 0–256 characters — e.g. /file/path
fetch_options
Field
Type
Required
Notes
concurrency
integer
Number of concurrent fetches to use — Min 1 — Default: 10
bucket_storage
Configuration for storage of bucket data
Field
Type
Required
Notes
endpoint
string
Hostname of the object storage service
port
number
TCP/IP port number. Optional, defaults to 80 for HTTP and 443 for HTTPs.
access_key
string
Access key (user ID) of an account in the S3 service
secret_key
string
Secret key (password) of an account in the S3 service
use_ssl
boolean
Whether to enable secure (HTTPS) access
region
string
Region of the object storage service
fetch_options
object
bucket
string
Bucket containing bucket storage
prefix
string
Prefix for objects in the bucket — Pattern: ^[\/\a-zA-Z0-9_.\-: ]+$ — 0–256 characters — e.g. /file/path
fetch_options
Field
Type
Required
Notes
concurrency
integer
Number of concurrent fetches to use — Min 1 — Default: 10
artifact_storage
Configuration for storage of task artifact data
Field
Type
Required
Notes
endpoint
string
Hostname of the object storage service
port
number
TCP/IP port number. Optional, defaults to 80 for HTTP and 443 for HTTPs.
access_key
string
Access key (user ID) of an account in the S3 service
secret_key
string
Secret key (password) of an account in the S3 service
use_ssl
boolean
Whether to enable secure (HTTPS) access
region
string
Region of the object storage service
fetch_options
object
bucket
string
Bucket containing task artifact storage
prefix
string
Prefix for objects in the bucket — Pattern: ^[\/\a-zA-Z0-9_.\-: ]+$ — 0–256 characters — e.g. /file/path
fetch_options
Field
Type
Required
Notes
concurrency
integer
Number of concurrent fetches to use — Min 1 — Default: 10
gateway_gitlab_artifact_cache
Configuration for storage of cached Gitlab data
Field
Type
Required
Notes
endpoint
string
Hostname of the object storage service
port
number
TCP/IP port number. Optional, defaults to 80 for HTTP and 443 for HTTPs.
access_key
string
Access key (user ID) of an account in the S3 service
secret_key
string
Secret key (password) of an account in the S3 service
use_ssl
boolean
Whether to enable secure (HTTPS) access
region
string
Region of the object storage service
fetch_options
object
bucket
string
Bucket containing Gitlab storage
prefix
string
Prefix for objects in the bucket — Pattern: ^[\/\a-zA-Z0-9_.\-: ]+$ — 0–256 characters — e.g. /file/path
gitlab_registry
string
Gitlab package registry url
gitlab_token
string
Gitlab package registry token
beta_versions
boolean
Whether to include beta versions in the artifact cache
fetch_options
Field
Type
Required
Notes
concurrency
integer
Number of concurrent fetches to use — Min 1 — Default: 10
exasol
Exasol-specific configuration
Field
Type
Required
Notes
version
string
Exasol release version
hosts
array
Host addresses to connect to — e.g. exa01.aunalytics.com:8563
schema
string
Exasol schema id
credentials
object
ingestion_method
enum
Choices: batched-insert, s3-parquet — Default: batched-insert
batched_insert_batch_size
integer
Default: 25000
s3_parquet_ingestion
object
accelerated_worker
object
deployments
object
default_deployment
string
Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$
credentials
Field
Type
Required
Notes
read
object
Credentials to use when querying the database
write
object
Credentials to use when migrating or loading to the database
read
Credentials to use when querying the database
Field
Type
Required
Notes
username
string
password
string
write
Credentials to use when migrating or loading to the database
Field
Type
Required
Notes
username
string
password
string
s3_parquet_ingestion
Field
Type
Required
Notes
endpoint
string
Hostname of the object storage service
port
number
TCP/IP port number. Optional, defaults to 80 for HTTP and 443 for HTTPs.
access_key
string
Access key (user ID) of an account in the S3 service
secret_key
string
Secret key (password) of an account in the S3 service
use_ssl
boolean
Whether to enable secure (HTTPS) access
region
string
Region of the object storage service
fetch_options
object
bucket
string
Bucket containing exasol import storage
prefix
string
Prefix for objects in the bucket — Pattern: ^[\/\a-zA-Z0-9_.\-: ]+$ — 0–256 characters — e.g. /file/path
exasol_import_script_id
string
Identifier for import script relative to Exasol schema — e.g. CLOUD_STORAGE_EXTENSION.IMPORT_PATH
exasol_import_bucket
string
Bucket id relative to Exasol — e.g. au3-s3
exasol_s3_endpoint
string
S3 URL relative to Exasol — e.g. https://netapp-s3-lif.aunsight.com
exasol_s3_connection
string
Id of connection relative to Exasol schema — e.g. AU3_S3_NETAPP
fetch_options
Field
Type
Required
Notes
concurrency
integer
Number of concurrent fetches to use — Min 1 — Default: 10
accelerated_worker
Field
Type
Required
Notes
ensure_pool
boolean
Whether to proactively create connection pools in accelerated-workers
deployments
Map keyed by field name matching pattern ^[a-zA-Z][a-zA-Z0-9_]*$.
Field
Type
Required
Notes
version
string
Exasol release version
hosts
array
Host addresses to connect to — e.g. exa01.aunalytics.com:8563
schema
string
Exasol schema id
credentials
object
ingestion_method
enum
Choices: batched-insert, s3-parquet — Default: batched-insert
batched_insert_batch_size
integer
Default: 25000
s3_parquet_ingestion
object
accelerated_worker
object
credentials
Field
Type
Required
Notes
read
object
Credentials to use when querying the database
write
object
Credentials to use when migrating or loading to the database
read
Credentials to use when querying the database
Field
Type
Required
Notes
username
string
password
string
write
Credentials to use when migrating or loading to the database
Field
Type
Required
Notes
username
string
password
string
s3_parquet_ingestion
Field
Type
Required
Notes
endpoint
string
Hostname of the object storage service
port
number
TCP/IP port number. Optional, defaults to 80 for HTTP and 443 for HTTPs.
access_key
string
Access key (user ID) of an account in the S3 service
secret_key
string
Secret key (password) of an account in the S3 service
use_ssl
boolean
Whether to enable secure (HTTPS) access
region
string
Region of the object storage service
fetch_options
object
bucket
string
Bucket containing exasol import storage
prefix
string
Prefix for objects in the bucket — Pattern: ^[\/\a-zA-Z0-9_.\-: ]+$ — 0–256 characters — e.g. /file/path
exasol_import_script_id
string
Identifier for import script relative to Exasol schema — e.g. CLOUD_STORAGE_EXTENSION.IMPORT_PATH
exasol_import_bucket
string
Bucket id relative to Exasol — e.g. au3-s3
exasol_s3_endpoint
string
S3 URL relative to Exasol — e.g. https://netapp-s3-lif.aunsight.com
exasol_s3_connection
string
Id of connection relative to Exasol schema — e.g. AU3_S3_NETAPP
fetch_options
Field
Type
Required
Notes
concurrency
integer
Number of concurrent fetches to use — Min 1 — Default: 10
accelerated_worker
Field
Type
Required
Notes
ensure_pool
boolean
Whether to proactively create connection pools in accelerated-workers
starrocks
StarRocks-specific configuration
Field
Type
Required
Notes
deployments
object
default_deployment
string
Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$
deployments
Map keyed by field name matching pattern ^[a-zA-Z][a-zA-Z0-9_]*$.
Field
Type
Required
Notes
version
string
StarRocks release version
hosts
array
Host addresses to connect to
port
integer
MySQL protocol port — Min 1 — Max 65535 — Default: 9030
database
string
StarRocks database id
ssl
boolean
Whether to require TLS for the MySQL protocol connection — Default: False
ssl_reject_unauthorized
boolean
Whether to reject unverifiable TLS certificates — Default: False
credentials
object
ingestion_method
enum
Choices: batched-insert, s3-parquet — Default: batched-insert
batched_insert_batch_size
integer
Max 10000 — Default: 10000
s3_parquet_ingestion
object
accelerated_worker
object
credentials
Field
Type
Required
Notes
read
object
Credentials to use when querying the database
write
object
Credentials to use when migrating or loading to the database
read
Credentials to use when querying the database
Field
Type
Required
Notes
username
string
password
string
write
Credentials to use when migrating or loading to the database
Field
Type
Required
Notes
username
string
password
string
s3_parquet_ingestion
Field
Type
Required
Notes
endpoint
string
Hostname of the object storage service
port
number
TCP/IP port number. Optional, defaults to 80 for HTTP and 443 for HTTPs.
access_key
string
Access key (user ID) of an account in the S3 service
secret_key
string
Secret key (password) of an account in the S3 service
use_ssl
boolean
Whether to enable secure (HTTPS) access
region
string
Region of the object storage service
fetch_options
object
bucket
string
Bucket containing starrocks import storage
prefix
string
Prefix for objects in the bucket — Pattern: ^[\/\a-zA-Z0-9_.\-: ]+$ — 0–256 characters — e.g. /file/path
starrocks_import_bucket
string
Bucket id relative to starrocks — e.g. au3-s3
starrocks_s3_endpoint
string
S3 URL relative to starrocks — e.g. https://netapp-s3-lif.aunsight.com
fetch_options
Field
Type
Required
Notes
concurrency
integer
Number of concurrent fetches to use — Min 1 — Default: 10
accelerated_worker
Field
Type
Required
Notes
ensure_pool
boolean
Whether to proactively create connection pools in accelerated-workers
graylog
Field
Type
Required
Notes
write_address
string
Address to sending GELF logs to. Can be http:// or tcp:// — e.g. http://graylog.aunalytics.com:9999/gelf
query_token
string
API token for getting logs out of graylog
query_address
string
API address for getting logs out of graylog — e.g. https://graylog.aunalytics.com:9000/api/
query_max_limit
integer
Max number of messages to return per query — e.g. 200
query_default_limit
integer
Default number of messages to return per query — e.g. 100
ai
AI model provider configuration
Field
Type
Required
Notes
liteLLM
object
liteLLM
Field
Type
Required
Notes
proxy_url
string
LiteLLM proxy URL used for model provider requests
use_case
object
use_case
Field
Type
Required
Notes
accelerated_warehouse_vector_search
object
accelerated_warehouse_vector_search
Field
Type
Required
Notes
api_key
string
API key to use when calling LiteLLM for accelerated warehouse vector search
default
object
default
Field
Type
Required
Notes
embedding_dense
object
embedding_sparse
object
embedding_dense
Field
Type
Required
Notes
model
string
Default dense embedding model for accelerated warehouse vector search — e.g. nomic-embed-text-v1.5
dimensions
integer
Dense embedding vector dimensions for Milvus collection schema creation — Min 1 — e.g. 768
embedding_sparse
Field
Type
Required
Notes
model
string
Default sparse embedding model for accelerated warehouse vector search
milvus
Milvus vector database configuration
Field
Type
Required
Notes
clusters
object
Milvus clusters available to this compute environment
default
object
ingestion_method
enum
Choices: batched-insert, s3-parquet — Default: batched-insert
batched_insert_batch_size
integer
Default: 5000
s3_parquet_ingestion
object
clusters
Milvus clusters available to this compute environment
Map keyed by field name matching pattern ^[a-zA-Z][a-zA-Z0-9_]*$.
Field
Type
Required
Notes
uri
string
Milvus cluster URI — e.g. https://milvus-grpc.aunsight.com
token
string
Milvus access token
db_name
string
Milvus database name
default
Field
Type
Required
Notes
cluster
string
Default Milvus cluster id — e.g. main
embedding_dense_index
enum
Default dense vector index type — Choices: HNSW_COSINE, IVF_FLAT_COSINE, FLAT_COSINE, AUTOINDEX_COSINE
embedding_sparse_index
enum
Default sparse vector index type — Choices: IP
s3_parquet_ingestion
Field
Type
Required
Notes
endpoint
string
Hostname of the object storage service
port
number
TCP/IP port number. Optional, defaults to 80 for HTTP and 443 for HTTPs.
access_key
string
Access key (user ID) of an account in the S3 service
secret_key
string
Secret key (password) of an account in the S3 service
use_ssl
boolean
Whether to enable secure (HTTPS) access
region
string
Region of the object storage service
fetch_options
object
bucket
string
Bucket containing warehouse storage
prefix
string
Prefix for objects in the bucket — Pattern: ^[\/\a-zA-Z0-9_.\-: ]+$ — 0–256 characters — e.g. /file/path
fetch_options
Field
Type
Required
Notes
concurrency
integer
Number of concurrent fetches to use — Min 1 — Default: 10
limits (array items)
Field
Type
Required
Notes
id
string
Id for the limit. Must be unique within the env. — Pattern: ^[a-zA-Z][a-zA-Z0-9_-]*$
name
string
Object name with 2-64 characters — 2–64 characters
description
string
Object description with 0 or 2-256 characters — Pattern: (^$)|(^.{2,256}$) — 0–256 characters
enabled
boolean
key_attributes
array
List of task attributes to combine to form the pool key
include_filter
object
Optional filter to determine whether the limit is applicable to an incoming task
exclude_filter
object
Optional filter to determine whether the limit is not applicable to an incoming task
max_concurrency
integer
Max number of tasks to allow concurrently per pool — Min 1
multi_part_upload_options
Field
Type
Required
Notes
bucket
object
warehouse
object
bucket
Field
Type
Required
Notes
concurrency
integer
Concurrency for uploading parts — Min 1 — Max 25 — Default: 10
part_size_threshold
integer
Part size threshold in bytes — Min 5000000 — Max 1000000000 — Default: 10000000
parts_max
integer
Maximum number of parts — Min 1 — Max 10000 — Default: 1000
warehouse
Field
Type
Required
Notes
concurrency
integer
Concurrency for uploading parts — Min 1 — Max 25 — Default: 10
part_size_threshold
integer
Part size threshold in bytes — Min 5000000 — Max 1000000000 — Default: 10000000
parts_max
integer
Maximum number of parts — Min 1 — Max 10000 — Default: 1000
accelerated_worker
Field
Type
Required
Notes
enabled
boolean
Whether the accelerated worker pool is enabled
scale
integer
Number of accelerated workers to maintain in the pool — Min 1 — Default: 1
base_url
string
Base URL of the accelerated worker API
default_request_ttl
integer
Default time for a request to complete in milliseconds — Min 0
max_heartbeat_recency
integer
Max tolerated recency of accelerated worker heartbeat in milliseconds — Min 0 — Default: 30000
status
object
status
Field
Type
Required
Notes
last_heartbeat_at
string
Datetime the accelerated worker pool last sent a heartbeat — Format: date-time — e.g. 2026-09-03T19:51:34.403Z
Example Spec
name : <string>
description : <string>
au3 admin compute-environment create-session
Create compute environment session
Option
Type
Required
Default
Notes
--id
string
✅
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 admin compute-environment find-minimal-artifact-purge-prefixes
Computes the minimal artifact prefixes to delete given a before date and a list of s3 objects
Option
Type
Required
Default
Notes
--before
string
✅
Datetime to purge before
--objects
string
✅
File containing list of object in location prefix
--format
enum
count
Output format Choices: "full", "count", "prefix"
--task-only
boolean
false
Whether to only look for task ids or for artifact_storage/task/{{TASK_ID}} pattern
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 admin compute-environment-tenant
au3 admin compute-environment-tenant list
List compute environment tenants
Option
Type
Required
Default
Notes
--fields
string
Comma-separate list of fields to display
--filter
string
Filter in JSON/YAML format or path to file containing filter
--sort
string
Ordered list of fields to sort by in JSON/YAML format or path to file containing sorting
--search
string
Search in JSON/YAML format or path to file containing search
--limit
100
Number of results to fetch
--skip
Number of results to skip
--all
boolean
false
Whether to fetch results from all pages
--stream
boolean
false
Whether to print results as they are received without buffering (as JSON)
--merged
boolean
true
Whether to return merged object
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 admin compute-environment-tenant view
View compute environment tenant
Option
Type
Required
Default
Notes
--id
string
✅
--merged
boolean
true
whether to return merged object
--fields
string
comma-separate list of fields to display
--update-spec
boolean
print in the form which is usable for the update command
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 admin compute-environment-tenant create
Create compute environment tenant
Option
Type
Required
Default
Notes
--environment
string
✅
Compute Environment id
--organization
string
✅
Organization id
--name
string
✅
Object name with 2-64 characters
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 admin compute-environment-tenant update
Update compute environment tenant
Option
Type
Required
Default
Notes
--spec-schema
boolean
view the schema for update
--spec
string
spec in JSON/YAML format or path to file containing spec
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
--spec payload reference
Schema ID: UpdateComputeEnvironmentTenantArgumentDto
This section documents the --spec payload accepted by au3 admin compute-environment-tenant update. Run admin compute-environment-tenant update --spec-schema to fetch this schema live from the CLI at any time.
Tip: additionalProperties: false — the schema rejects any field not listed below.
Top-Level Fields
Field
Type
Required
Notes
id
string
Compute Environment Tenant id — Pattern: ^cet-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. cet-e0305f9e-55f6-4e86-8998-40e40bc784dd
version
integer
Object version number
environment
string
Compute Environment id — Pattern: ^ce-[0-9A-Za-z]+[0-9A-Za-z_-]*$ — e.g. ce-env-01
organization
string
Organization id — Pattern: ^org-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. org-bdd53ff8-8d18-47db-b962-bbd2d712eab9
name
string
Object name with 2-64 characters — 2–64 characters
created_at
string
Datetime the object was created at — Format: date-time — e.g. 2026-09-03T19:51:35.693Z
created_by
object
created_req
string
Request the object was created by — Pattern: ^req-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}(\.[0-9]+)*$ — e.g. req-123e4567-e89b-41d2-a345-678901234567.0.10
updated_at
string
Datetime the object was updated at — Format: date-time — e.g. 2026-09-03T19:51:35.693Z
updated_by
object
updated_req
string
Request the object was updated by — Pattern: ^req-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}(\.[0-9]+)*$ — e.g. req-123e4567-e89b-41d2-a345-678901234567.0.10
state
enum
Choices: active, inactive
gateway
object
warehouse_storage
object
Configuration for storage of warehouse data
bucket_storage
object
Configuration for storage of bucket data
artifact_storage
object
Configuration for storage of task artifact data
gateway_plugin_artifact_cache
object
Configuration for storage of cached Gitlab data
tasks
object
exasol
object
Exasol-specific configuration
starrocks
object
StarRocks-specific configuration
graylog
object
ai
object
AI model provider configuration
milvus
object
Milvus vector database configuration
multi_part_upload_options
object
created_by
The created_by object is a discriminated union. One of the following 2 shapes applies.
Variant 1
Field
Type
Required
Notes
Variant 2
Field
Type
Required
Notes
updated_by
The updated_by object is a discriminated union. One of the following 2 shapes applies.
Variant 1
Field
Type
Required
Notes
Variant 2
Field
Type
Required
Notes
gateway
Field
Type
Required
Notes
api_url
string
Gateway API url
warehouse_storage
Configuration for storage of warehouse data
Field
Type
Required
Notes
endpoint
string
Hostname of the object storage service
port
number
TCP/IP port number. Optional, defaults to 80 for HTTP and 443 for HTTPs.
access_key
string
Access key (user ID) of an account in the S3 service
secret_key
string
Secret key (password) of an account in the S3 service
use_ssl
boolean
Whether to enable secure (HTTPS) access
region
string
Region of the object storage service
fetch_options
object
bucket
string
Bucket containing warehouse storage
prefix
string
Prefix for objects in the bucket — Pattern: ^[\/\a-zA-Z0-9_.\-: ]+$ — 0–256 characters — e.g. /file/path
fetch_options
Field
Type
Required
Notes
concurrency
integer
Number of concurrent fetches to use — Min 1 — Default: 10
bucket_storage
Configuration for storage of bucket data
Field
Type
Required
Notes
endpoint
string
Hostname of the object storage service
port
number
TCP/IP port number. Optional, defaults to 80 for HTTP and 443 for HTTPs.
access_key
string
Access key (user ID) of an account in the S3 service
secret_key
string
Secret key (password) of an account in the S3 service
use_ssl
boolean
Whether to enable secure (HTTPS) access
region
string
Region of the object storage service
fetch_options
object
bucket
string
Bucket containing bucket storage
prefix
string
Prefix for objects in the bucket — Pattern: ^[\/\a-zA-Z0-9_.\-: ]+$ — 0–256 characters — e.g. /file/path
fetch_options
Field
Type
Required
Notes
concurrency
integer
Number of concurrent fetches to use — Min 1 — Default: 10
artifact_storage
Configuration for storage of task artifact data
Field
Type
Required
Notes
endpoint
string
Hostname of the object storage service
port
number
TCP/IP port number. Optional, defaults to 80 for HTTP and 443 for HTTPs.
access_key
string
Access key (user ID) of an account in the S3 service
secret_key
string
Secret key (password) of an account in the S3 service
use_ssl
boolean
Whether to enable secure (HTTPS) access
region
string
Region of the object storage service
fetch_options
object
bucket
string
Bucket containing task artifact storage
prefix
string
Prefix for objects in the bucket — Pattern: ^[\/\a-zA-Z0-9_.\-: ]+$ — 0–256 characters — e.g. /file/path
fetch_options
Field
Type
Required
Notes
concurrency
integer
Number of concurrent fetches to use — Min 1 — Default: 10
gateway_plugin_artifact_cache
Configuration for storage of cached Gitlab data
Field
Type
Required
Notes
endpoint
string
Hostname of the object storage service
port
number
TCP/IP port number. Optional, defaults to 80 for HTTP and 443 for HTTPs.
access_key
string
Access key (user ID) of an account in the S3 service
secret_key
string
Secret key (password) of an account in the S3 service
use_ssl
boolean
Whether to enable secure (HTTPS) access
region
string
Region of the object storage service
fetch_options
object
bucket
string
Bucket containing Gitlab storage
prefix
string
Prefix for objects in the bucket — Pattern: ^[\/\a-zA-Z0-9_.\-: ]+$ — 0–256 characters — e.g. /file/path
gitlab_registry
string
Gitlab package registry url
gitlab_token
string
Gitlab package registry token
beta_versions
boolean
Whether to include beta versions in the artifact cache
fetch_options
Field
Type
Required
Notes
concurrency
integer
Number of concurrent fetches to use — Min 1 — Default: 10
exasol
Exasol-specific configuration
Field
Type
Required
Notes
version
string
Exasol release version
hosts
array
Host addresses to connect to — e.g. exa01.aunalytics.com:8563
schema
string
Exasol schema id
credentials
object
ingestion_method
enum
Choices: batched-insert, s3-parquet — Default: batched-insert
batched_insert_batch_size
integer
Default: 25000
s3_parquet_ingestion
object
accelerated_worker
object
deployments
object
default_deployment
string
Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$
credentials
Field
Type
Required
Notes
read
object
Credentials to use when querying the database
write
object
Credentials to use when migrating or loading to the database
read
Credentials to use when querying the database
Field
Type
Required
Notes
username
string
password
string
write
Credentials to use when migrating or loading to the database
Field
Type
Required
Notes
username
string
password
string
s3_parquet_ingestion
Field
Type
Required
Notes
endpoint
string
Hostname of the object storage service
port
number
TCP/IP port number. Optional, defaults to 80 for HTTP and 443 for HTTPs.
access_key
string
Access key (user ID) of an account in the S3 service
secret_key
string
Secret key (password) of an account in the S3 service
use_ssl
boolean
Whether to enable secure (HTTPS) access
region
string
Region of the object storage service
fetch_options
object
bucket
string
Bucket containing exasol import storage
prefix
string
Prefix for objects in the bucket — Pattern: ^[\/\a-zA-Z0-9_.\-: ]+$ — 0–256 characters — e.g. /file/path
exasol_import_script_id
string
Identifier for import script relative to Exasol schema — e.g. CLOUD_STORAGE_EXTENSION.IMPORT_PATH
exasol_import_bucket
string
Bucket id relative to Exasol — e.g. au3-s3
exasol_s3_endpoint
string
S3 URL relative to Exasol — e.g. https://netapp-s3-lif.aunsight.com
exasol_s3_connection
string
Id of connection relative to Exasol schema — e.g. AU3_S3_NETAPP
fetch_options
Field
Type
Required
Notes
concurrency
integer
Number of concurrent fetches to use — Min 1 — Default: 10
accelerated_worker
Field
Type
Required
Notes
ensure_pool
boolean
Whether to proactively create connection pools in accelerated-workers
deployments
Map keyed by field name matching pattern ^[a-zA-Z][a-zA-Z0-9_]*$.
Field
Type
Required
Notes
version
string
Exasol release version
hosts
array
Host addresses to connect to — e.g. exa01.aunalytics.com:8563
schema
string
Exasol schema id
credentials
object
ingestion_method
enum
Choices: batched-insert, s3-parquet — Default: batched-insert
batched_insert_batch_size
integer
Default: 25000
s3_parquet_ingestion
object
accelerated_worker
object
credentials
Field
Type
Required
Notes
read
object
Credentials to use when querying the database
write
object
Credentials to use when migrating or loading to the database
read
Credentials to use when querying the database
Field
Type
Required
Notes
username
string
password
string
write
Credentials to use when migrating or loading to the database
Field
Type
Required
Notes
username
string
password
string
s3_parquet_ingestion
Field
Type
Required
Notes
endpoint
string
Hostname of the object storage service
port
number
TCP/IP port number. Optional, defaults to 80 for HTTP and 443 for HTTPs.
access_key
string
Access key (user ID) of an account in the S3 service
secret_key
string
Secret key (password) of an account in the S3 service
use_ssl
boolean
Whether to enable secure (HTTPS) access
region
string
Region of the object storage service
fetch_options
object
bucket
string
Bucket containing exasol import storage
prefix
string
Prefix for objects in the bucket — Pattern: ^[\/\a-zA-Z0-9_.\-: ]+$ — 0–256 characters — e.g. /file/path
exasol_import_script_id
string
Identifier for import script relative to Exasol schema — e.g. CLOUD_STORAGE_EXTENSION.IMPORT_PATH
exasol_import_bucket
string
Bucket id relative to Exasol — e.g. au3-s3
exasol_s3_endpoint
string
S3 URL relative to Exasol — e.g. https://netapp-s3-lif.aunsight.com
exasol_s3_connection
string
Id of connection relative to Exasol schema — e.g. AU3_S3_NETAPP
fetch_options
Field
Type
Required
Notes
concurrency
integer
Number of concurrent fetches to use — Min 1 — Default: 10
accelerated_worker
Field
Type
Required
Notes
ensure_pool
boolean
Whether to proactively create connection pools in accelerated-workers
starrocks
StarRocks-specific configuration
Field
Type
Required
Notes
deployments
object
default_deployment
string
Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$
deployments
Map keyed by field name matching pattern ^[a-zA-Z][a-zA-Z0-9_]*$.
Field
Type
Required
Notes
version
string
StarRocks release version
hosts
array
Host addresses to connect to
port
integer
MySQL protocol port — Min 1 — Max 65535 — Default: 9030
database
string
StarRocks database id
ssl
boolean
Whether to require TLS for the MySQL protocol connection — Default: False
ssl_reject_unauthorized
boolean
Whether to reject unverifiable TLS certificates — Default: False
credentials
object
ingestion_method
enum
Choices: batched-insert, s3-parquet — Default: batched-insert
batched_insert_batch_size
integer
Max 10000 — Default: 10000
s3_parquet_ingestion
object
accelerated_worker
object
credentials
Field
Type
Required
Notes
read
object
Credentials to use when querying the database
write
object
Credentials to use when migrating or loading to the database
read
Credentials to use when querying the database
Field
Type
Required
Notes
username
string
password
string
write
Credentials to use when migrating or loading to the database
Field
Type
Required
Notes
username
string
password
string
s3_parquet_ingestion
Field
Type
Required
Notes
endpoint
string
Hostname of the object storage service
port
number
TCP/IP port number. Optional, defaults to 80 for HTTP and 443 for HTTPs.
access_key
string
Access key (user ID) of an account in the S3 service
secret_key
string
Secret key (password) of an account in the S3 service
use_ssl
boolean
Whether to enable secure (HTTPS) access
region
string
Region of the object storage service
fetch_options
object
bucket
string
Bucket containing starrocks import storage
prefix
string
Prefix for objects in the bucket — Pattern: ^[\/\a-zA-Z0-9_.\-: ]+$ — 0–256 characters — e.g. /file/path
starrocks_import_bucket
string
Bucket id relative to starrocks — e.g. au3-s3
starrocks_s3_endpoint
string
S3 URL relative to starrocks — e.g. https://netapp-s3-lif.aunsight.com
fetch_options
Field
Type
Required
Notes
concurrency
integer
Number of concurrent fetches to use — Min 1 — Default: 10
accelerated_worker
Field
Type
Required
Notes
ensure_pool
boolean
Whether to proactively create connection pools in accelerated-workers
graylog
Field
Type
Required
Notes
write_address
string
Address to sending GELF logs to. Can be http:// or tcp:// — e.g. http://graylog.aunalytics.com:9999/gelf
query_token
string
API token for getting logs out of graylog
query_address
string
API address for getting logs out of graylog — e.g. https://graylog.aunalytics.com:9000/api/
query_max_limit
integer
Max number of messages to return per query — e.g. 200
query_default_limit
integer
Default number of messages to return per query — e.g. 100
ai
AI model provider configuration
Field
Type
Required
Notes
liteLLM
object
liteLLM
Field
Type
Required
Notes
proxy_url
string
LiteLLM proxy URL used for model provider requests
use_case
object
use_case
Field
Type
Required
Notes
accelerated_warehouse_vector_search
object
accelerated_warehouse_vector_search
Field
Type
Required
Notes
api_key
string
API key to use when calling LiteLLM for accelerated warehouse vector search
default
object
default
Field
Type
Required
Notes
embedding_dense
object
embedding_sparse
object
embedding_dense
Field
Type
Required
Notes
model
string
Default dense embedding model for accelerated warehouse vector search — e.g. nomic-embed-text-v1.5
dimensions
integer
Dense embedding vector dimensions for Milvus collection schema creation — Min 1 — e.g. 768
embedding_sparse
Field
Type
Required
Notes
model
string
Default sparse embedding model for accelerated warehouse vector search
milvus
Milvus vector database configuration
Field
Type
Required
Notes
clusters
object
Milvus clusters available to this compute environment
default
object
ingestion_method
enum
Choices: batched-insert, s3-parquet — Default: batched-insert
batched_insert_batch_size
integer
Default: 5000
s3_parquet_ingestion
object
clusters
Milvus clusters available to this compute environment
Map keyed by field name matching pattern ^[a-zA-Z][a-zA-Z0-9_]*$.
Field
Type
Required
Notes
uri
string
Milvus cluster URI — e.g. https://milvus-grpc.aunsight.com
token
string
Milvus access token
db_name
string
Milvus database name
default
Field
Type
Required
Notes
cluster
string
Default Milvus cluster id — e.g. main
embedding_dense_index
enum
Default dense vector index type — Choices: HNSW_COSINE, IVF_FLAT_COSINE, FLAT_COSINE, AUTOINDEX_COSINE
embedding_sparse_index
enum
Default sparse vector index type — Choices: IP
s3_parquet_ingestion
Field
Type
Required
Notes
endpoint
string
Hostname of the object storage service
port
number
TCP/IP port number. Optional, defaults to 80 for HTTP and 443 for HTTPs.
access_key
string
Access key (user ID) of an account in the S3 service
secret_key
string
Secret key (password) of an account in the S3 service
use_ssl
boolean
Whether to enable secure (HTTPS) access
region
string
Region of the object storage service
fetch_options
object
bucket
string
Bucket containing warehouse storage
prefix
string
Prefix for objects in the bucket — Pattern: ^[\/\a-zA-Z0-9_.\-: ]+$ — 0–256 characters — e.g. /file/path
fetch_options
Field
Type
Required
Notes
concurrency
integer
Number of concurrent fetches to use — Min 1 — Default: 10
multi_part_upload_options
Field
Type
Required
Notes
bucket
object
warehouse
object
bucket
Field
Type
Required
Notes
concurrency
integer
Concurrency for uploading parts — Min 1 — Max 25 — Default: 10
part_size_threshold
integer
Part size threshold in bytes — Min 5000000 — Max 1000000000 — Default: 10000000
parts_max
integer
Maximum number of parts — Min 1 — Max 10000 — Default: 1000
warehouse
Field
Type
Required
Notes
concurrency
integer
Concurrency for uploading parts — Min 1 — Max 25 — Default: 10
part_size_threshold
integer
Part size threshold in bytes — Min 5000000 — Max 1000000000 — Default: 10000000
parts_max
integer
Maximum number of parts — Min 1 — Max 10000 — Default: 1000
Example Spec
Publish toolbelt version
Option
Type
Required
Default
Notes
--spec-schema
boolean
view the schema for publish
--spec
string
spec in JSON/YAML format or path to file containing spec
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
--spec payload reference
Schema ID: PublishToolbeltVersionArgumentDto
This section documents the --spec payload accepted by au3 admin toolbelt publish-version. Run admin toolbelt publish-version --spec-schema to fetch this schema live from the CLI at any time.
Top-Level Fields
Field
Type
Required
Notes
token
string
✅
Authentication token
base_url
string
Base url to upload the packages to — Default: https://gitlab.aunsight.com/api/v4/projects/14/packages/generic
artifacts
object
✅
version
string
✅
Semantic version string — Pattern: ^([a-zA-Z_]+(-beta)?)|([0-9]+(\.[0-9]+){0,2}(-beta)?)$
artifacts
Field
Type
Required
Notes
linux
object
osx
object
windows
object
linux
Field
Type
Required
Notes
arm64
string
✅
Path to the toolbelt arm64 pkg binary
toolbelt
string
✅
Path to the toolbelt pkg binary
osx
Field
Type
Required
Notes
arm64
string
✅
Path to the toolbelt arm64 pkg binary
toolbelt
string
✅
Path to the toolbelt x64 pkg binary
windows
Field
Type
Required
Notes
arm64
string
✅
Path to the toolbelt arm64 pkg binary
toolbelt
string
✅
Path to the toolbelt pkg binary
Example Spec
token : <string>
artifacts : {}
version : <string>
Generated from au3 admin --help and subcommand help output.