Prepare a managed-service disconnection review (browser session)

import requests

url = "https://api.platform.ankra.app/org/service-admission/instances/{instance_id}/disconnections"

payload = {
    "consumer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "expected_generation": 2,
    "keep_network_access": True,
    "connection_names_instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "connection_names_none": True
}
headers = {
    "cookie": "ankra_session=",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {cookie: 'ankra_session=', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    consumer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    expected_generation: 2,
    keep_network_access: true,
    connection_names_instance_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    connection_names_none: true
  })
};

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

curl --request POST \
  --url https://api.platform.ankra.app/org/service-admission/instances/{instance_id}/disconnections \
  --header 'Content-Type: application/json' \
  --cookie ankra_session= \
  --data '
{
  "consumer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expected_generation": 2,
  "keep_network_access": true,
  "connection_names_instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "connection_names_none": true
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "plan": {
    "schema_version": 123,
    "instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "actor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "service_name": "<string>",
    "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "generation": 123,
    "engine": "<string>",
    "protocol": "<string>",
    "consumer": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "namespace": "<string>"
    },
    "on_service_cluster": true,
    "credential": {
      "kind": "shared",
      "other_consumers": 123,
      "statement": "<string>",
      "cannot_guarantee": "<string>"
    },
    "connection_names": {
      "variables": [
        "<string>"
      ],
      "conventional": [
        "<string>"
      ],
      "carries_conventional": true,
      "choice_required": true,
      "choices": [
        {
          "instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "service_name": "<string>",
          "none": true,
          "installing": true
        }
      ],
      "choice": {
        "instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "service_name": "<string>",
        "none": true,
        "installing": true
      },
      "statement": "<string>"
    },
    "connection_secret": {
      "secret_name": "<string>",
      "delivered": true,
      "statement": "<string>"
    },
    "workloads": {
      "state": "known",
      "attached_by_ankra": [
        "<string>"
      ],
      "written_by_hand": [
        "<string>"
      ],
      "statement": "<string>"
    },
    "network": {
      "namespace": "<string>",
      "narrows": true,
      "keep_network_access": true,
      "reason": "narrows",
      "port": 123,
      "statement": "<string>"
    },
    "data": "<string>",
    "timing": {
      "mode": "after_next_deploy",
      "deploy_now_offered": true,
      "now_offered": true,
      "statement": "<string>"
    },
    "kept": [
      "<string>"
    ],
    "rotation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  },
  "digest": "<string>",
  "state": "pending",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "confirmed_at": "2023-11-07T05:31:56Z",
  "phase": "draining",
  "settled_at": "2023-11-07T05:31:56Z",
  "outcome": {
    "connection_secret": "removed",
    "network": "narrowed",
    "removed_namespaces": [
      "<string>"
    ],
    "observed_at": "2023-11-07T05:31:56Z",
    "network_reason": "<string>"
  },
  "running_pods": {
    "count": 123,
    "names": [
      "<string>"
    ]
  }
}

Services

Prepare a managed-service disconnection review (browser session)

Requires the applications rollout flag, applications.deploy, clusters.operate on the service’s cluster, and clusters.operate and clusters.read on the application environment’s cluster, all intersected with live token scopes: the authority connecting it needed. Resolves, on the primary database, what disconnecting one application environment from a running managed service does: the variables it stops receiving and, when this service gives the protocol’s conventional names (DATABASE_URL, …) while another service of the protocol is connected, the choices for who gives them next; that the shared credential is not revoked and how to make sure the application can no longer authenticate; whether the environment’s release delivered the connection Secret; which deployed workloads read it, separating references Ankra attached (the next deploy removes them and rolls the workloads) from references written by hand; whether the namespace leaves the service’s client port; when it takes effect; and what stays. It stores an actor-bound plan with a digest and a ten-minute expiry. Nothing changes. timing now is refused while every application of the service shares one credential. Refused while the service installs or retires, while a deploy of the environment is in flight, while the environment is already being disconnected, and for another generation. An actor may hold at most 10 open disconnection reviews and an organisation 50.

POST

org

service-admission

instances

{instance_id}

disconnections

Prepare a managed-service disconnection review (browser session)

import requests

url = "https://api.platform.ankra.app/org/service-admission/instances/{instance_id}/disconnections"

payload = {
    "consumer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "expected_generation": 2,
    "keep_network_access": True,
    "connection_names_instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "connection_names_none": True
}
headers = {
    "cookie": "ankra_session=",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {cookie: 'ankra_session=', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    consumer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    expected_generation: 2,
    keep_network_access: true,
    connection_names_instance_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    connection_names_none: true
  })
};

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

curl --request POST \
  --url https://api.platform.ankra.app/org/service-admission/instances/{instance_id}/disconnections \
  --header 'Content-Type: application/json' \
  --cookie ankra_session= \
  --data '
{
  "consumer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expected_generation": 2,
  "keep_network_access": true,
  "connection_names_instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "connection_names_none": true
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "plan": {
    "schema_version": 123,
    "instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "actor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "service_name": "<string>",
    "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "generation": 123,
    "engine": "<string>",
    "protocol": "<string>",
    "consumer": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "namespace": "<string>"
    },
    "on_service_cluster": true,
    "credential": {
      "kind": "shared",
      "other_consumers": 123,
      "statement": "<string>",
      "cannot_guarantee": "<string>"
    },
    "connection_names": {
      "variables": [
        "<string>"
      ],
      "conventional": [
        "<string>"
      ],
      "carries_conventional": true,
      "choice_required": true,
      "choices": [
        {
          "instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "service_name": "<string>",
          "none": true,
          "installing": true
        }
      ],
      "choice": {
        "instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "service_name": "<string>",
        "none": true,
        "installing": true
      },
      "statement": "<string>"
    },
    "connection_secret": {
      "secret_name": "<string>",
      "delivered": true,
      "statement": "<string>"
    },
    "workloads": {
      "state": "known",
      "attached_by_ankra": [
        "<string>"
      ],
      "written_by_hand": [
        "<string>"
      ],
      "statement": "<string>"
    },
    "network": {
      "namespace": "<string>",
      "narrows": true,
      "keep_network_access": true,
      "reason": "narrows",
      "port": 123,
      "statement": "<string>"
    },
    "data": "<string>",
    "timing": {
      "mode": "after_next_deploy",
      "deploy_now_offered": true,
      "now_offered": true,
      "statement": "<string>"
    },
    "kept": [
      "<string>"
    ],
    "rotation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  },
  "digest": "<string>",
  "state": "pending",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "confirmed_at": "2023-11-07T05:31:56Z",
  "phase": "draining",
  "settled_at": "2023-11-07T05:31:56Z",
  "outcome": {
    "connection_secret": "removed",
    "network": "narrowed",
    "removed_namespaces": [
      "<string>"
    ],
    "observed_at": "2023-11-07T05:31:56Z",
    "network_reason": "<string>"
  },
  "running_pods": {
    "count": 123,
    "names": [
      "<string>"
    ]
  }
}

Authorizations

ankra_session

string

required

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

Path Parameters

instance_id

string<uuid>

required

Body

application/json

What a person states when preparing a disconnection. Every field is required; connection_names_instance_id may be null.

consumer_id

string<uuid>

required

The consumer to disconnect, among the instance's consumers.

expected_generation

integer<int64>

required

The instance generation the person reviewed.

Required range: x >= 1

timing

enum<string>

required

after_next_deploy: the application keeps working until its next deploy. now is refused while every application of the service shares one credential.

Available options:

after_next_deploy,

now

keep_network_access

boolean

required

True keeps the namespace admitted on the service's client port.

connection_names_instance_id

string<uuid> | null

required

Only when the review asks for a choice: the other connected service that gives the conventional names from now on; null otherwise.

connection_names_none

boolean

required

Only when the review asks for a choice: true when no service gives the conventional names from now on.

Response

The stored disconnection review, its plan and digest.

One disconnection of an application environment from a managed service, as its preparing actor sees it.

string<uuid>

required

instance_id

string<uuid>

required

plan

object

required

The reviewed statement of what a disconnection removes, keeps and cannot do. Every field is resolved by the server; the digest covers all of it.

Show child attributes

digest

string

required

Pattern: ^sha256:[a-f0-9]{64}$

state

enum<string>

required

Available options:

pending,

expired,

in_progress,

settled

created_at

string<date-time>

required

expires_at

string<date-time>

required

confirmed_at

string<date-time> | null

required

phase

enum<string> | null

required

Available options:

draining,

removing,

revoking,

null

settled_at

string<date-time> | null

required

outcome

object | null

required

What the settled disconnection observed, and only what it observed.

Show child attributes

running_pods

object | null

required

The pods in the environment's namespace that read the connection Secret now, read when the disconnection is served; not part of the plan or its digest. Null once settled, for an environment on another cluster, and when it could not be read.

Show child attributes

API reference

Endpoints

Prepare a managed-service disconnection review (browser session)

Authorizations

Path Parameters

Body

Response