Get AWS onboarding details
import requests
url = "https://platform.ankra.app/api/v1/credentials/aws/onboarding"
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/credentials/aws/onboarding', 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/credentials/aws/onboarding \
--header 'Authorization: Bearer <token>'{
"configured": true,
"scope": "cost",
"external_id": "<string>",
"region": "<string>",
"launch_stack_url": "<string>",
"trust_principal_arn": "<string>",
"template_url": "<string>"
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "Cluster not found"
}AWS Credentials
Get AWS onboarding details
Bearer PAT authentication. Generates an external ID and the CloudFormation launch-stack URL for the requested scope (cost, provisioning, or self_managed for the AnkraSelfManagedProvisioning role the k3s / kubeadm lane uses). Unknown scopes answer 400.
GET
/
api
/
v1
/
credentials
/
aws
/
onboarding
Get AWS onboarding details
import requests
url = "https://platform.ankra.app/api/v1/credentials/aws/onboarding"
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/credentials/aws/onboarding', 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/credentials/aws/onboarding \
--header 'Authorization: Bearer <token>'{
"configured": true,
"scope": "cost",
"external_id": "<string>",
"region": "<string>",
"launch_stack_url": "<string>",
"trust_principal_arn": "<string>",
"template_url": "<string>"
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "Cluster not found"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
PAT organisation override.
Query Parameters
Credential scope: cost (default), provisioning, or self_managed.