Confirm a managed-service disconnection by its digest
import requests
url = "https://platform.ankra.app/api/v1/org/service-admission/instances/{instance_id}/disconnections/{disconnection_id}/confirm"
payload = { "digest": "<string>" }
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({digest: '<string>'})
};
fetch('https://platform.ankra.app/api/v1/org/service-admission/instances/{instance_id}/disconnections/{disconnection_id}/confirm', 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/instances/{instance_id}/disconnections/{disconnection_id}/confirm \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"digest": "<string>"
}
'{
"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
Confirm a managed-service disconnection by its digest
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. Accepts only the stored disconnection and the digest its actor reviewed, resolves the plan again under the same locks and refuses when anything it covers moved, or when the plan asks for a choice of who gives the conventional names and none was made. In one transaction it takes the consumer off the instance’s plan, records the connection release entry the environment’s stored release renders for it so every deploy keeps that Secret byte for byte while pods still read it, records the choice for the conventional names, and audits it. The platform’s disconnect lane then removes the Secret once no pod and no deployed workload reads it, takes the namespace off the client port when the plan said so, and settles. A retry returns the same record.
POST
/
api
/
v1
/
org
/
service-admission
/
instances
/
{instance_id}
/
disconnections
/
{disconnection_id}
/
confirm
Confirm a managed-service disconnection by its digest
import requests
url = "https://platform.ankra.app/api/v1/org/service-admission/instances/{instance_id}/disconnections/{disconnection_id}/confirm"
payload = { "digest": "<string>" }
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({digest: '<string>'})
};
fetch('https://platform.ankra.app/api/v1/org/service-admission/instances/{instance_id}/disconnections/{disconnection_id}/confirm', 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/instances/{instance_id}/disconnections/{disconnection_id}/confirm \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"digest": "<string>"
}
'{
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Pattern:
^sha256:[a-f0-9]{64}$Response
The confirmed disconnection.
One disconnection of an application environment from a managed service, as its preparing actor sees it.
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
Show child attributes
Pattern:
^sha256:[a-f0-9]{64}$Available options:
pending, expired, in_progress, settled Available options:
draining, removing, revoking, null What the settled disconnection observed, and only what it observed.
Show child attributes
Show child attributes
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
Show child attributes