releases

Set a workspace's release policy for a channel

Requires manage on the workspace — workspace admins only. Not update: a member who may edit an artifact is not thereby a member who may decide whether artifacts ship.

Every facet is a double option — absent leaves it alone, a value sets it, and null clears it back to the level below: the channel's definition for require_checks, the fail-safe default (auto, private, true) for mode, default_visibility and allow_version_override, which the channel does not carry. Clearing every facet leaves the row in place, so resolved_from still reads workspace; sources reads the level below for each. A workspace cannot raise the channel's allow_public ceiling; asking for public where the org has not opened it resolves back to private.

put/registry/v1/workspaces/{workspace_id}/release-policy/{channel}

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/workspaces/{workspace_id}/release-policy/{channel}
  • Auth: HTTP bearer

Path parameters

workspace_idstring required

Workspace handle (workspace_…)

channelstring required

Channel slug

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

allow_version_overrideboolean nullable

Whether version override.

default_visibilitystring nullable

Value of the default_visibility field.

modestring nullable

Value of the mode field.

require_checksboolean nullable

Value of the require_checks field.

Response

OK

allow_publicboolean required

Whether this channel may carry a public release at all — the org's ceiling. A workspace chooses within it and cannot raise it.

allow_version_overrideboolean required

Whether version override.

channelstring required

Value of the channel field.

default_visibilitystring required

private or public.

modestring required

auto or manual.

require_checksboolean required

Value of the require_checks field.

resolved_fromstring required

workspace, channel or default — which level answered. Advisory; it exists so an operator can see why a release behaved as it did.

workspace means the workspace has a policy row for this channel, not that it set anything: a row whose every facet is null still reports workspace. Whether any facet is set here, and which, is sources.

workspace_idstring required

Stable identifier of the related workspace resource.

Changes

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