Skip to content

Release

Release is a published bundle of the configuration of the Units in a Space that are assigned to a Target. It is created by publishing, taken out of service by withdrawing, and removed by deleting; its bundled content is never updated, though its Labels, Annotations, and DeleteGates can be. The bundle is stored as an OCI image (a tar.gz layer plus manifest) so it can be served to and consumed by the Target.

Operations

Method Endpoint Description
GET /release List of Releases across spaces
GET /space/{space_id}/release List ExtendedReleases
GET /space/{space_id}/release/{release_id} Get ExtendedRelease
GET /space/{space_id}/release/{release_id}/data Download the selected Release's bundle
POST /space/{space_id}/release Publish a Release
POST /space/{space_id}/release/{release_id}/withdraw Withdraw the selected Release
PATCH /space/{space_id}/release/{release_id} Patch the selected Release
PUT /space/{space_id}/release/{release_id} Update the selected Release
DELETE /space/{space_id}/release/{release_id} Delete the selected Release

List of Releases across spaces

GET /release

Retrieves a list of Releases across spaces in the Organization

Operation ID: ListAllReleases

Parameters

Query Parameters

Parameter Type Required Description
where string The specified string is an expression for the purpose of filtering the list of Releases returned. The expression syntax was inspired by SQL. It supports conjunctions using AND of relational expressions of the form attribute operator attribute_or_literal. The attribute names are case-sensitive and PascalCase, as in the JSON encoding. Strings support the following operators: <, >, <=, >=, =, !=, LIKE, NOT LIKE, ILIKE, ~~, !~~, ~, ~*, !~, !~*, IN, NOT IN. String pattern operators: LIKE and ~~ for pattern matching with % and _ wildcards, ILIKE for case-insensitive pattern matching, NOT LIKE and !~~ for negated pattern matching. String regex operators: ~ for regex matching, ~* for case-insensitive regex, !~ and !~* for regex not matching (case-sensitive and insensitive). Integers support the following operators: <, >, <=, >=, =, !=, IN, NOT IN. UUIDs and boolean attributes support equality and inequality only. UUID and time literals must be quoted as string literals. String literals are quoted with single quotes, such as 'string'. Time literals use the same form as when serialized as JSON, such as: CreatedAt > '2025-02-18T23:16:34'. Integer and boolean literals are also supported for attributes of those types. Arrays support the ? operator to to match any element of the array, as in ApprovedBy ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'. Arrays can perform LEN() to check for length, as in LEN(ApprovedBy) > 0. An attribute naming a list of other entities can be filtered on their attributes with a * segment, as in FromLink.*.Slug = 'upgrade-app', which holds when any element satisfies it. Without the * such a reference is an error, since it names no single value to compare. Map support the dot notation to specify a particular map key, as in Labels.tier = 'Backend'. Maps support IS NULL and IS NOT NULL with dot notation to check for key absence or presence, as in Labels.tier IS NULL (key doesn't exist) or Labels.tier IS NOT NULL (key exists). Comparison results can be tested with IS TRUE, IS FALSE, IS NOT TRUE, and IS NOT FALSE. These are useful for nullable columns: MergeSourceID = '<uuid>' IS NOT FALSE matches rows where MergeSourceID equals the value OR is NULL. The IN and NOT IN operators accept a comma-separated list of values in parentheses, such as Slug IN ('slugone', 'slugtwo') or Labels.environment IN ('prod', 'staging'). Conjunctions are supported using the AND operator. An example conjunction is: CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'. Supported attributes for filtering on Release: Annotations, CreatedAt, DeleteGates, Digest, Labels, ManifestDigest, OrganizationID, Published, ReleaseID, SpaceID, TagID, UnitCount, UpdatedAt. The whole string must be query-encoded.
filter string UUID of a Filter entity to apply to the Release list. The Filter must be in the same Organization as the user credentials. The Filter's From field must match the entity type being filtered (Release). For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
contains string Free text search that approximately matches the specified string against string fields and map keys/values. The search is case-insensitive and uses pattern matching to find entities containing the text. Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. For map fields (like Labels and Annotations), the search matches both map keys and values. The search uses OR logic across all searchable fields, so matching any field will return the entity. If both 'where' and 'contains' parameters are specified, they are combined with AND logic. Searchable fields for Release include string and map-type attributes from the queryable attributes list. The whole string must be query-encoded.
include string Include clause for expanding related entities in the response for Release. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for Release are OrganizationID, SpaceID, TagID. The whole string must be query-encoded.
select string Select clause for specifying which fields to include in the response for Release. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. If not specified, all fields are returned. Entity and parent IDs (like OrganizationID, SpaceID, ReleaseID) and Slug are always returned regardless of the select parameter. Fields used in where and contains filters, and fields named by order_by, are also automatically included. Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. The whole string must be query-encoded.

Responses

Status Description Content-Type Schema
200 OK application/json Array of ExtendedRelease
400 Release request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 Release not found. application/json StandardErrorResponse
500 Something went wrong while processing Release. application/json StandardErrorResponse
default Unexpected error. application/json StandardErrorResponse

List ExtendedReleases

GET /space/{space_id}/release

List ExtendedReleases

Operation ID: ListExtendedReleases

Parameters

Path Parameters

Parameter Type Required Description
space_id string ✓ Unique identifier for a space_id

Query Parameters

Parameter Type Required Description
where string The specified string is an expression for the purpose of filtering the list of Releases returned. The expression syntax was inspired by SQL. It supports conjunctions using AND of relational expressions of the form attribute operator attribute_or_literal. The attribute names are case-sensitive and PascalCase, as in the JSON encoding. Strings support the following operators: <, >, <=, >=, =, !=, LIKE, NOT LIKE, ILIKE, ~~, !~~, ~, ~*, !~, !~*, IN, NOT IN. String pattern operators: LIKE and ~~ for pattern matching with % and _ wildcards, ILIKE for case-insensitive pattern matching, NOT LIKE and !~~ for negated pattern matching. String regex operators: ~ for regex matching, ~* for case-insensitive regex, !~ and !~* for regex not matching (case-sensitive and insensitive). Integers support the following operators: <, >, <=, >=, =, !=, IN, NOT IN. UUIDs and boolean attributes support equality and inequality only. UUID and time literals must be quoted as string literals. String literals are quoted with single quotes, such as 'string'. Time literals use the same form as when serialized as JSON, such as: CreatedAt > '2025-02-18T23:16:34'. Integer and boolean literals are also supported for attributes of those types. Arrays support the ? operator to to match any element of the array, as in ApprovedBy ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'. Arrays can perform LEN() to check for length, as in LEN(ApprovedBy) > 0. An attribute naming a list of other entities can be filtered on their attributes with a * segment, as in FromLink.*.Slug = 'upgrade-app', which holds when any element satisfies it. Without the * such a reference is an error, since it names no single value to compare. Map support the dot notation to specify a particular map key, as in Labels.tier = 'Backend'. Maps support IS NULL and IS NOT NULL with dot notation to check for key absence or presence, as in Labels.tier IS NULL (key doesn't exist) or Labels.tier IS NOT NULL (key exists). Comparison results can be tested with IS TRUE, IS FALSE, IS NOT TRUE, and IS NOT FALSE. These are useful for nullable columns: MergeSourceID = '<uuid>' IS NOT FALSE matches rows where MergeSourceID equals the value OR is NULL. The IN and NOT IN operators accept a comma-separated list of values in parentheses, such as Slug IN ('slugone', 'slugtwo') or Labels.environment IN ('prod', 'staging'). Conjunctions are supported using the AND operator. An example conjunction is: CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'. Supported attributes for filtering on Release: Annotations, CreatedAt, DeleteGates, Digest, Labels, ManifestDigest, OrganizationID, Published, ReleaseID, SpaceID, TagID, UnitCount, UpdatedAt. The whole string must be query-encoded.
filter string UUID of a Filter entity to apply to the Release list. The Filter must be in the same Organization as the user credentials. The Filter's From field must match the entity type being filtered (Release). For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
contains string Free text search that approximately matches the specified string against string fields and map keys/values. The search is case-insensitive and uses pattern matching to find entities containing the text. Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. For map fields (like Labels and Annotations), the search matches both map keys and values. The search uses OR logic across all searchable fields, so matching any field will return the entity. If both 'where' and 'contains' parameters are specified, they are combined with AND logic. Searchable fields for Release include string and map-type attributes from the queryable attributes list. The whole string must be query-encoded.
include string Include clause for expanding related entities in the response for Release. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for Release are OrganizationID, SpaceID, TagID. The whole string must be query-encoded.
select string Select clause for specifying which fields to include in the response for Release. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. If not specified, all fields are returned. Entity and parent IDs (like OrganizationID, SpaceID, ReleaseID) and Slug are always returned regardless of the select parameter. Fields used in where and contains filters, and fields named by order_by, are also automatically included. Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. The whole string must be query-encoded.

Responses

Status Description Content-Type Schema
200 OK application/json Array of ExtendedRelease
400 ExtendedRelease request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 ExtendedRelease not found. application/json StandardErrorResponse
500 Something went wrong while processing ExtendedRelease. application/json StandardErrorResponse
default Unexpected error. application/json StandardErrorResponse

Get ExtendedRelease

GET /space/{space_id}/release/{release_id}

Get ExtendedRelease

Operation ID: GetExtendedRelease

Parameters

Path Parameters

Parameter Type Required Description
space_id string ✓ Unique identifier for a space_id
release_id string ✓ Unique identifier for a release_id

Query Parameters

Parameter Type Required Description
include string Include clause for expanding related entities in the response for Release. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for Release are OrganizationID, SpaceID, TagID. The whole string must be query-encoded.
select string Select clause for specifying which fields to include in the response for Release. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. If not specified, all fields are returned. Entity and parent IDs (like OrganizationID, SpaceID, ReleaseID) and Slug are always returned regardless of the select parameter. Fields used in where and contains filters, and fields named by order_by, are also automatically included. Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. The whole string must be query-encoded.

Responses

Status Description Content-Type Schema
200 Release with additional related entities expanded based on the request's include parameter. application/json ExtendedRelease
400 ExtendedRelease request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 ExtendedRelease not found. application/json StandardErrorResponse
500 Something went wrong while processing ExtendedRelease. application/json StandardErrorResponse
default Unexpected error. application/json StandardErrorResponse

Download the selected Release's bundle

GET /space/{space_id}/release/{release_id}/data

Download the gzip tarball a Release published. The bundle is not part of the Release entity -- a list of Releases should not carry a copy of every tarball -- and the response carries the Digest as an ETag.

Operation ID: DownloadReleaseData

Parameters

Path Parameters

Parameter Type Required Description
space_id string ✓ Unique identifier for a space_id
release_id string ✓ Unique identifier for a release_id

Responses

Status Description Content-Type Schema
200 OK application/gzip string
400 Release request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 Release not found. application/json StandardErrorResponse
500 Something went wrong while processing Release. application/json StandardErrorResponse
default Unexpected error. application/json StandardErrorResponse

Publish a Release

POST /space/{space_id}/release

Publish a Release for the consuming Target, bundling the Units/Revisions of the Space in the path. Optionally pins each Unit to a tagged Revision via TagID.

Operation ID: PublishRelease

Parameters

Path Parameters

Parameter Type Required Description
space_id string ✓ Unique identifier for a space_id

Request Body

Content-Type: application/json

Schema: ReleasePublishRequest

Responses

Status Description Content-Type Schema
200 Release is a published bundle of the configuration of the Units in a Space that are assigned to a Target. It is created by publishing, taken out of service by withdrawing, and removed by deleting; its bundled content is never updated, though its Labels, Annotations, and DeleteGates can be. The bundle is stored as an OCI image (a tar.gz layer plus manifest) so it can be served to and consumed by the Target. application/json Release
400 Release request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 Release not found. application/json StandardErrorResponse
409 Release data conflict. Data has changed since last read. application/json StandardErrorResponse
422 A Unit to be bundled has outstanding apply gates application/json StandardErrorResponse
500 Something went wrong while processing Release. application/json StandardErrorResponse
default Unexpected error. application/json StandardErrorResponse

Withdraw the selected Release

POST /space/{space_id}/release/{release_id}/withdraw

Withdraw the selected Release, clearing its Published flag so it is no longer available for download. The Release itself is retained; delete it to remove it entirely.

Operation ID: WithdrawRelease

Parameters

Path Parameters

Parameter Type Required Description
space_id string ✓ Unique identifier for a space_id
release_id string ✓ Unique identifier for a release_id

Responses

Status Description Content-Type Schema
200 Release is a published bundle of the configuration of the Units in a Space that are assigned to a Target. It is created by publishing, taken out of service by withdrawing, and removed by deleting; its bundled content is never updated, though its Labels, Annotations, and DeleteGates can be. The bundle is stored as an OCI image (a tar.gz layer plus manifest) so it can be served to and consumed by the Target. application/json Release
400 Release request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 Release not found. application/json StandardErrorResponse
409 Release data conflict. Data has changed since last read. application/json StandardErrorResponse
422 A Unit in the Release's bundle has outstanding destroy gates application/json StandardErrorResponse
500 Something went wrong while processing Release. application/json StandardErrorResponse
default Unexpected error. application/json StandardErrorResponse

Patch the selected Release

PATCH /space/{space_id}/release/{release_id}

Apply a JSON merge patch to the selected Release's Labels, Annotations, and DeleteGates. Patching is how a Label, Annotation, or DeleteGate is removed: send null for its key. The read-only fields of a Release, including the bundled content, the name it is stored under, and the Published flag, cannot be patched.

Operation ID: PatchRelease

Parameters

Path Parameters

Parameter Type Required Description
space_id string ✓ Unique identifier for a space_id
release_id string ✓ Unique identifier for a release_id

Request Body

Content-Type: application/merge-patch+json

Responses

Status Description Content-Type Schema
200 Release is a published bundle of the configuration of the Units in a Space that are assigned to a Target. It is created by publishing, taken out of service by withdrawing, and removed by deleting; its bundled content is never updated, though its Labels, Annotations, and DeleteGates can be. The bundle is stored as an OCI image (a tar.gz layer plus manifest) so it can be served to and consumed by the Target. application/json Release
400 Release request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 Release not found. application/json StandardErrorResponse
409 Release data conflict. Data has changed since last read. application/json StandardErrorResponse
500 Something went wrong while processing Release. application/json StandardErrorResponse
default Unexpected error. application/json StandardErrorResponse

Update the selected Release

PUT /space/{space_id}/release/{release_id}

Update the selected Release's Labels, Annotations, and DeleteGates. The bundled content of a Release is never updated, and neither are the read-only fields describing it: withdraw the Release to take it out of service, and publish a new one to change what is bundled or what the bundle is named.

Operation ID: UpdateRelease

Parameters

Path Parameters

Parameter Type Required Description
space_id string ✓ Unique identifier for a space_id
release_id string ✓ Unique identifier for a release_id

Request Body

Content-Type: application/json

Schema: Release

Responses

Status Description Content-Type Schema
200 Release is a published bundle of the configuration of the Units in a Space that are assigned to a Target. It is created by publishing, taken out of service by withdrawing, and removed by deleting; its bundled content is never updated, though its Labels, Annotations, and DeleteGates can be. The bundle is stored as an OCI image (a tar.gz layer plus manifest) so it can be served to and consumed by the Target. application/json Release
400 Release request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 Release not found. application/json StandardErrorResponse
409 Release data conflict. Data has changed since last read. application/json StandardErrorResponse
500 Something went wrong while processing Release. application/json StandardErrorResponse
default Unexpected error. application/json StandardErrorResponse

Delete the selected Release

DELETE /space/{space_id}/release/{release_id}

Delete the selected Release, removing it and its stored bundle

Operation ID: DeleteRelease

Parameters

Path Parameters

Parameter Type Required Description
space_id string ✓ Unique identifier for a space_id
release_id string ✓ Unique identifier for a release_id

Responses

Status Description Content-Type Schema
200 Response for successful delete operation application/json DeleteResponse
400 Release request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 Release not found. application/json StandardErrorResponse
409 Release data conflict. Data has changed since last read. application/json StandardErrorResponse
422 Release could not be deleted. application/json StandardErrorResponse
500 Something went wrong while processing Release. application/json StandardErrorResponse
default Unexpected error. application/json StandardErrorResponse

Schemas

DeleteResponse

Response for successful delete operation

Properties

Property Type Required Description
Error ResponseError
Message string Response message.

ExtendedRelease

Release with additional related entities expanded based on the request's include parameter.

Properties

Property Type Required Description
Organization Organization
Release Release
Space Space
Tag Tag

Release

Release is a published bundle of the configuration of the Units in a Space that are assigned to a Target. It is created by publishing, taken out of service by withdrawing, and removed by deleting; its bundled content is never updated, though its Labels, Annotations, and DeleteGates can be. The bundle is stored as an OCI image (a tar.gz layer plus manifest) so it can be served to and consumed by the Target.

Properties

Property Type Required Description
Annotations object An optional map of Annotation key/value pairs for tools to attach information to entities.
BridgeWorkerID string (uuid)
BundleBaseName string Base filename used for the Release's stored bundle, without the .tar.gz suffix. Set at publish time and recorded in the Release's OCI manifest, so it cannot be changed afterwards. (readonly)
CreatedAt string (date-time) The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
CursorID integer (int64) An auto-incrementing sequence number used for pagination.
DataSize integer (int64)
DeleteGates object An optional set of gates that, if any is present, will block deletion.
Digest string OCI content digest (sha256:...) of the Release's stored tar.gz bundle.
EntityType string The type of entity.
Labels object An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them.
ManifestDigest string OCI digest (sha256:...) of the Release's OCI image manifest.
OrganizationID string (uuid)
Published boolean Whether the Release is currently served to its consuming Target. Set when the Release is published and cleared when it is withdrawn; a withdrawn Release is retained until deleted.
ReleaseID string (uuid) Unique identifier for a Release.
ReleaseNum integer (int64) Monotonically increasing sequence number of the Release within its Target, assigned at publish time. The highest ReleaseNum is the latest Release for the Target.
SpaceID string (uuid)
SpaceSlug string Slug of the Space this entity belongs to.
TagID string (uuid) Tag identifying the bundled Revision of each Unit in the Release. When publishing supplied a TagID, this is that Tag. Otherwise publishing creates a Tag named release- in the Release's Space, applies it to each bundled Revision, and sets it here.
UnitCount integer (int64) Number of Units bundled in the Release, captured at publish time.
UpdatedAt string (date-time) The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format.
Version integer (int64) An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update.

ReleasePublishRequest

Properties

Property Type Required Description
Annotations object An optional map of Annotation key/value pairs for tools to attach information to entities.
BundleBaseName string Optional override of the name of the Release's tar.gz bundle.
DeleteGates object An optional set of gates that, if any is present, will block deletion
Labels object An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them.
TagID string (uuid) Optional Tag ID identifying the tagged Revision to bundle. For each Unit assigned to the Space's ReleaseTarget, the highest-numbered Revision carrying this Tag is bundled at that Revision instead of the Unit's head Revision. A Unit with no matching tagged Revision falls back to its head Revision. When omitted, each Unit is bundled at its head Revision and publishing creates a Tag named release-, applies it to each bundled Revision, and sets it as the Release's TagID.

StandardErrorResponse

Error response details.

Properties

Property Type Required Description
Code string HTTP status code of the response.
Message string Message returned with the response.