releases

Release a version onto a channel

Ships one version of one artifact line on one channel. Absent version_id takes the line's head; absent channel takes the account's default channel (latest).

    The published **number** and the **semver** are allocated here, not at write time — a version that has never been released has neither, which is the whole reason they live on the release. An absent `version_label` auto-bumps the line's minor.

Requires manage on the artifact's workspace, or update plus being the artifact's owner. A machine-created artifact has no owner, so only the admin arm applies to it.

post/registry/v1/artifacts/{artifact_kind}/{artifact_id}/releases

Request

  • Base URL: https://api.atlan.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.atlan.com/registry/v1/artifacts/{artifact_kind}/{artifact_id}/releases
  • Auth: HTTP bearer

Path parameters

artifact_kindstring required

Kind handle

artifact_idstring required

Artifact handle

Headers

Content-Encoding'base64' | 'gzip, base64'

Codings applied to the request body, outermost last. Send base64, or gzip, base64 to compress first; the body is decoded before it is read and Content-Type still names the inner media type. Omit for an unencoded body.

Request body

channelstring nullable

The channel. Absent takes the account's default channel.

notesstring nullable

Value of the notes field.

version_idstring nullable

The version to ship: a ver_… handle, or absent for the head.

version_labelstring nullable

The semver to publish under. Absent auto-bumps the line's minor at promotion.

visibilitystring nullable

private (default) or public.

Response

Created

artifact_idstring required

Stable identifier of the related artifact resource.

channelstring required

Value of the channel field.

content_hashstring nullable

Value of the content_hash field.

created_atstring required

When the row was minted, RFC 3339 like every other timestamp on this API. For an auto policy's row this is when it was queued; released_at is when it shipped.

created_bystring required

Who minted the release row. For an explicit cut, who released it; for an auto policy's row, whoever made the write that queued it.

is_currentboolean required

Whether current.

kindstring required

Domain discriminator for this resource.

notesstring nullable

Value of the notes field.

reasonstring nullable

Value of the reason field.

release_idstring required

rel_….

release_statusstring required

Value of the release_status field.

released_atstring nullable

When this version first shipped on this channel, RFC 3339. Not moved by a later supersession or by being promoted back after a withdrawal. Absent while pending, on a release discarded before it shipped, and — until a follow-up backfill — on a release promoted while this field was being rolled out.

released_bystring nullable

Who first shipped this version on this channel. Absent while pending, and on a release discarded before it ever shipped.

updated_atstring required

When that last transition happened, RFC 3339. release_status says which it was.

updated_bystring required

Who made the last transition — promotion, supersession, withdrawal or a promote-back.

version_idstring required

ver_… — the version shipped.

version_labelstring nullable

The semver. Absent while pending, for version_ordinal's reason.

version_ordinalinteger nullable

The published version number. Absent while the release is pending: an unshipped version has no number, which is the whole reason this field is on a release and not an artifact.

visibilitystring required

Value of the visibility field.

withdrawn_atstring nullable

When it was withdrawn, RFC 3339. Present only when release_status is withdrawn.

withdrawn_bystring nullable

Who withdrew it. Present only when release_status is withdrawn.

workspace_idstring required

Stable identifier of the related workspace resource.

Changes

No recorded changes to this operation across all 1 revision of this API.