Bind an explicit application namespace

import requests

url = "https://platform.ankra.app/api/v1/org/service-admission/consumers"

payload = {
    "application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "namespace": "<string>",
    "allow_planned": True,
    "local_only": True,
    "expected_revision": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    application_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    cluster_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    namespace: '<string>',
    allow_planned: true,
    local_only: true,
    expected_revision: 1
  })
};

fetch('https://platform.ankra.app/api/v1/org/service-admission/consumers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request POST \
  --url https://platform.ankra.app/api/v1/org/service-admission/consumers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "namespace": "<string>",
  "allow_planned": true,
  "local_only": true,
  "expected_revision": 1
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "namespace": "<string>",
  "region": "<string>",
  "data_boundary": "<string>",
  "policy_revision": 2,
  "binding_revision": 2,
  "binding_kind": "planned",
  "installation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "local_only": true
}

Services

Bind an explicit application namespace

Requires the applications rollout flag and live membership intersected with token scopes. Cluster policy reads require clusters.read and writes clusters.write. Consumer reads require applications.read and clusters.read; binding requires applications.deploy, clusters.operate and clusters.read. Locations are organisation declarations, not independently verified. No service deployment is executed. Updates require the current revision; zero creates only. Browser mutations require CSRF.

POST

/

api

/

v1

/

org

/

service-admission

/

consumers

Bind an explicit application namespace

import requests

url = "https://platform.ankra.app/api/v1/org/service-admission/consumers"

payload = {
    "application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "namespace": "<string>",
    "allow_planned": True,
    "local_only": True,
    "expected_revision": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    application_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    cluster_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    namespace: '<string>',
    allow_planned: true,
    local_only: true,
    expected_revision: 1
  })
};

fetch('https://platform.ankra.app/api/v1/org/service-admission/consumers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request POST \
  --url https://platform.ankra.app/api/v1/org/service-admission/consumers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "namespace": "<string>",
  "allow_planned": true,
  "local_only": true,
  "expected_revision": 1
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "namespace": "<string>",
  "region": "<string>",
  "data_boundary": "<string>",
  "policy_revision": 2,
  "binding_revision": 2,
  "binding_kind": "planned",
  "installation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "local_only": true
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

application_id

string<uuid>

required

cluster_id

string<uuid>

required

namespace

string

required

Required string length: 1 - 63

Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

allow_planned

boolean

required

local_only

boolean

required

expected_revision

integer<int64>

required

Required range: x >= 0

Response

Success

id

string<uuid>

required

application_id

string<uuid>

required

organisation_id

string<uuid>

required

cluster_id

string<uuid>

required

namespace

string

required

region

string

required

Required string length: 1 - 63

Pattern: ^[a-z][a-z0-9]*(-[a-z0-9]+)*$

data_boundary

string

required

Required string length: 1 - 63

Pattern: ^[a-z][a-z0-9]*(-[a-z0-9]+)*$

policy_revision

integer<int64>

required

Required range: x >= 1

binding_revision

integer<int64>

required

Required range: x >= 1

binding_kind

enum<string>

required

Available options:

planned,

installation

installation_id

string<uuid>

required

Nil UUID for a planned binding. An installation identity does not imply readiness.

local_only

boolean

required