Skip to content

Release tags overview ​

Release tags are the workspace-level tag catalog for releases.

The release tag object ​

Attributes ​

  • commit_hash string

    The commit hash.

  • created_at string (date-time)

    When the record was created.

  • created_by_id string (uuid)

    The user who created the record.

  • description string

    Free-form description.

  • git_tag string

    The git tag.

  • id string (uuid)

    Unique identifier.

  • version string

    Version string, for example 1.4.0.

Response200
json
{
  "commit_hash": "example",
  "created_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "description": "What this is for.",
  "git_tag": "example",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "version": "1.4.0"
}

Endpoints ​

MethodPathDescription
GET/api/v2/workspaces/{slug}/releases/tags/List release tags
GET/api/v2/workspaces/{slug}/releases/tags/{pk}/Get a release tag
POST/api/v2/workspaces/{slug}/releases/tags/Create a release tag
PATCH/api/v2/workspaces/{slug}/releases/tags/{pk}/Update a release tag
DELETE/api/v2/workspaces/{slug}/releases/tags/{pk}/Delete a release tag

Response shaping ​

Every release tag read accepts ?fields= for sparse responses — see Sparse fields. Errors follow the shared problem+json contract.