Skip to main content
PUT
Declare cluster service placement policy (browser session)

Authorizations

ankra_session
string
cookie
required

Browser session. Mutations also require X-Ankra-CSRF.

Path Parameters

cluster_id
string<uuid>
required

Body

application/json
expected_revision
integer<int64>
required
Required range: x >= 0
region
string
required

Physical cloud region of the placement, for example eu-north-1. It locates infrastructure; it is not the data-location promise, which is data_boundary.

Required string length: 1 - 63
Pattern: ^[a-z][a-z0-9]*(-[a-z0-9]+)*$
data_boundary
string
required

Boundary the data is permitted to stay within, for example eu. Sharing a service across clusters is decided by this boundary, never by the physical region.

Required string length: 1 - 63
Pattern: ^[a-z][a-z0-9]*(-[a-z0-9]+)*$
local_only
boolean
required

Response

Success

cluster_id
string<uuid>
required
region
string
required

Physical cloud region of the placement, for example eu-north-1. It locates infrastructure; it is not the data-location promise, which is data_boundary.

Required string length: 1 - 63
Pattern: ^[a-z][a-z0-9]*(-[a-z0-9]+)*$
data_boundary
string
required

Boundary the data is permitted to stay within, for example eu. Sharing a service across clusters is decided by this boundary, never by the physical region.

Required string length: 1 - 63
Pattern: ^[a-z][a-z0-9]*(-[a-z0-9]+)*$
local_only
boolean
required
revision
integer<int64>
required
Required range: x >= 1
source
enum<string>
required
Available options:
organisation_declared
updated_at
string<date-time>
required