Sign in

v62

latestOpenAPI 3.1.0Dual (AGPL3.0, Commercial License Available)raw.githubusercontent.com2026-08-03211303932.5 KB
Tags

Create a new tag

Creates a tag scoped to your organization. Tag names must be unique within the organization.

Validation

  • Name must be 1-100 characters (empty names are rejected)
  • Name must be unique within your organization
post/api/v1/tags

Request body

color'Pink' | 'Rose' | 'Red' | 'Amber' | 'Orange' | 'Green' | 'Emerald' | 'Teal' | 'Cyan' | 'Blue' | 'Indigo' | 'Purple' | 'Fuchsia' | 'Violet' | 'Sky' | 'Gray' | 'Lime' | 'Yellow' required
descriptionstring nullable

Free-text notes about the tag.

is_applicationboolean

Whether this tag groups an application, so it drives the application view.

namestring required

Human-facing name for this tag.

organization_idstring uuid required

The organization that owns this record.

created_atstring date-time required

When this record was first created.

idstring uuid required

Server-assigned unique identifier.

lineage_idstring uuid nullable

Stable identifier shared by every revision of the same entity across its history.

updated_atstring date-time required

When this record was last modified.

valid_fromstring date-time

Start of the interval this revision was current for (SCD2 history).

valid_tostring date-time nullable

End of the interval this revision was current for. null while it is the live revision.

Example request

{
  "color": "Green",
  "created_at": "2026-01-15T10:30:00Z",
  "description": "Production environment resources",
  "id": "550e8400-e29b-41d4-a716-44665544000a",
  "is_application": false,
  "lineage_id": null,
  "name": "production",
  "organization_id": "550e8400-e29b-41d4-a716-446655440001",
  "updated_at": "2026-01-15T10:30:00Z",
  "valid_from": "2026-01-15T10:30:00Z",
  "valid_to": null
}

Response

Tag created successfully

errorstring nullable

Human-readable failure message. Omitted on success.

successboolean required

true when the request succeeded. false responses carry error instead of data.

Example response

{
  "data": {
    "color": "Green",
    "created_at": "2026-01-15T10:30:00Z",
    "description": "Production environment resources",
    "id": "550e8400-e29b-41d4-a716-44665544000a",
    "is_application": false,
    "lineage_id": null,
    "name": "production",
    "organization_id": "550e8400-e29b-41d4-a716-446655440001",
    "updated_at": "2026-01-15T10:30:00Z",
    "valid_from": "2026-01-15T10:30:00Z",
    "valid_to": null
  },
  "meta": {
    "api_version": 1,
    "server_version": "0.17.7"
  }
}