Detect a cluster's platform operators
import requests
url = "https://platform.ankra.app/api/v1/org/applications/{application_id}/deploy/clusters/{cluster_id}/platform"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.ankra.app/api/v1/org/applications/{application_id}/deploy/clusters/{cluster_id}/platform', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://platform.ankra.app/api/v1/org/applications/{application_id}/deploy/clusters/{cluster_id}/platform \
--header 'Authorization: Bearer <token>'{
"existing_platform": {
"prometheus_operator": true,
"external_secrets_operator": true,
"cert_manager": true,
"cnpg": true,
"cnpg_in_draft_id": "<string>",
"prometheus_operator_in_draft_id": "<string>",
"external_secrets_operator_in_draft_id": "<string>",
"cert_manager_in_draft_id": "<string>"
},
"error": "<string>"
}Applications
Detect a cluster's platform operators
Reports whether Prometheus Operator, External Secrets Operator, cert-manager and CloudNativePG are already on the cluster or proposed in one of its drafts, so a deploy does not install a second copy. A detection that fails answers 200 with error set.
GET
/
api
/
v1
/
org
/
applications
/
{application_id}
/
deploy
/
clusters
/
{cluster_id}
/
platform
Detect a cluster's platform operators
import requests
url = "https://platform.ankra.app/api/v1/org/applications/{application_id}/deploy/clusters/{cluster_id}/platform"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.ankra.app/api/v1/org/applications/{application_id}/deploy/clusters/{cluster_id}/platform', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://platform.ankra.app/api/v1/org/applications/{application_id}/deploy/clusters/{cluster_id}/platform \
--header 'Authorization: Bearer <token>'{
"existing_platform": {
"prometheus_operator": true,
"external_secrets_operator": true,
"cert_manager": true,
"cnpg": true,
"cnpg_in_draft_id": "<string>",
"prometheus_operator_in_draft_id": "<string>",
"external_secrets_operator_in_draft_id": "<string>",
"cert_manager_in_draft_id": "<string>"
},
"error": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The application's id.
The target cluster.
Response
What the cluster already runs.
The platform operators found on a cluster, or the error that stopped the check.