apiome versions
Global options such as --base-url, --tenant and --json go before the command — see CLI reference. Exit codes are listed in Exit codes.
apiome versions
List and fetch project versions.
apiome versions [OPTIONS] COMMAND [ARGS]...
Subcommands: get, list, publish, unpublish.
apiome versions get
Fetch one version (GET /v1/versions/{tenant_slug}/{project_id}/{version_id}).
apiome versions get [OPTIONS] VERSION_ID
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
VERSION_ID | uuid | yes | Version record UUID. |
Options
| Option | Type | Default | Required | Description |
|---|---|---|---|---|
--project-id | uuid | yes | Parent project UUID. |
apiome versions list
List project versions (GET /v1/versions/{tenant_slug}/{project_id}).
apiome versions list [OPTIONS]
Options
| Option | Type | Default | Required | Description |
|---|---|---|---|---|
--project-id | uuid | Restrict results to one project (required unless listing all projects). |
apiome versions publish
Publish a version (POST …/{version_record_id}/publish).
apiome versions publish [OPTIONS] VERSION
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
VERSION | text | yes | Version UUID, or a slug/label when --project is supplied. |
Options
| Option | Type | Default | Required | Description |
|---|---|---|---|---|
--project | text | yes | Project UUID or slug. | |
--visibility, -v | text | public | Publish visibility: 'public' (catalog) or 'private' (tenant-protected). |
apiome versions unpublish
Return a published version to draft (POST …/{version_record_id}/unpublish).
apiome versions unpublish [OPTIONS] VERSION
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
VERSION | text | yes | Version UUID, or a slug/label when --project is supplied. |
Options
| Option | Type | Default | Required | Description |
|---|---|---|---|---|
--project | text | yes | Project UUID or slug. |