Skip to main content
POST
Create location

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

Serializer for Location model.

name
string
required
Maximum string length: 255
slug
string
required
Maximum string length: 50
Pattern: ^[-a-zA-Z0-9_]+$
site
string<uuid>
required
annotations
object

Key-value annotations. Keys must start with a lowercase letter and contain only lowercase alphanumeric segments joined by hyphens or underscores (e.g. 'org-id', 'gpu_ready').

tags
string[]

Tags for the resource. Must start with a lowercase letter and contain only lowercase alphanumeric segments joined by hyphens or underscores (e.g. 'gpu-ready', 'needs_review'). Stored deduplicated and sorted.

description
string
status
enum<string>
  • planned - Planned
  • staging - Staging
  • active - Active
  • decommissioning - Decommissioning
  • retired - Retired
  • unknown - Unknown
Available options:
planned,
staging,
active,
decommissioning,
retired,
unknown
parent
string<uuid> | null

Response

Serializer for Location model.

id
string<uuid>
required
read-only
parent_name
string
required
read-only
site_name
string
required
read-only

Serializer for location links.

created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
name
string
required
Maximum string length: 255
slug
string
required
Maximum string length: 50
Pattern: ^[-a-zA-Z0-9_]+$
site
string<uuid>
required
annotations
object

Key-value annotations. Keys must start with a lowercase letter and contain only lowercase alphanumeric segments joined by hyphens or underscores (e.g. 'org-id', 'gpu_ready').

tags
string[]

Tags for the resource. Must start with a lowercase letter and contain only lowercase alphanumeric segments joined by hyphens or underscores (e.g. 'gpu-ready', 'needs_review'). Stored deduplicated and sorted.

description
string
status
enum<string>
  • planned - Planned
  • staging - Staging
  • active - Active
  • decommissioning - Decommissioning
  • retired - Retired
  • unknown - Unknown
Available options:
planned,
staging,
active,
decommissioning,
retired,
unknown
parent
string<uuid> | null