Skip to main content

apiome tags

Global options such as --base-url, --tenant and --json go before the command — see CLI reference. Exit codes are listed in Exit codes.

apiome tags​

List, inspect, create, move and delete version tags (named pointers to versions).

apiome tags [OPTIONS] COMMAND [ARGS]...

Subcommands: create, delete, list, show, update.

apiome tags create​

Create a version tag pointing at a version (POST /v1/version-tags/{tenant}/{project}).

Exit 6 when the project already has a tag with that name — move it with tags update instead.

apiome tags create [OPTIONS] PROJECT [TAG]

Arguments

ArgumentTypeRequiredDescription
PROJECT_REFtextyesProject slug or UUID.
TAGtextTag name, lower-cased: a letter, then letters, digits or hyphens (2–41).

Options

OptionTypeDefaultRequiredDescription
--versiontextVersion the tag points to: label (2.1.0 or v2.1.0) or revision UUID.
--descriptiontextWhat the tag is for (stored as its message).
--from-filepathJSON tag object (e.g. an edited tags show --json): name, version, description, channel, immutable.
--yes, -yflagSkip the confirmation an immutable tag asks for.

apiome tags delete​

Delete a version tag after you type its name (DELETE /v1/version-tags/{tenant}/{project}/{tag_id}).

Only the tag goes: the version it points to is not touched. An immutable tag cannot be deleted (exit 6).

apiome tags delete [OPTIONS] PROJECT TAG

Arguments

ArgumentTypeRequiredDescription
PROJECT_REFtextyesProject slug or UUID.
TAG_REFtextyesTag name (exact) or tag UUID.

Options

OptionTypeDefaultRequiredDescription
--yes, -yflagSkip the typed confirmation.

apiome tags list​

List a project's version tags and the version each points to (GET /v1/version-tags/{tenant}/{project}).

apiome tags list [OPTIONS] PROJECT

Arguments

ArgumentTypeRequiredDescription
PROJECT_REFtextyesProject slug or UUID.

Options

OptionTypeDefaultRequiredDescription
--limitinteger range50Show at most this many tags.
--allflagShow every tag (ignores --limit).

apiome tags show​

Show one version tag: the version it points to, its channel, locks and dates.

The server keeps only the current pointer, so no move history is shown.

apiome tags show [OPTIONS] PROJECT TAG

Arguments

ArgumentTypeRequiredDescription
PROJECT_REFtextyesProject slug or UUID.
TAG_REFtextyesTag name (exact) or tag UUID.

apiome tags update​

Move a version tag to another version (PATCH /v1/version-tags/{tenant}/{project}/{tag_id}).

Shows where the tag points now and, best-effort, who may be affected — mock requests in the last 7 days, frozen-snapshot downloads and other tags on the current version — then asks to continue.

apiome tags update [OPTIONS] PROJECT TAG

Arguments

ArgumentTypeRequiredDescription
PROJECT_REFtextyesProject slug or UUID.
TAG_REFtextyesTag name (exact) or tag UUID.

Options

OptionTypeDefaultRequiredDescription
--versiontextyesVersion to move the tag to: label (2.1.0 or v2.1.0) or revision UUID.
--descriptiontextNew description (the tag's message); pass '' to clear it.
--dry-runflagShow the move and its blast radius; change nothing.
--yes, -yflagSkip the confirmation.