List AWS VPCs
import requests
url = "https://platform.ankra.app/api/v1/clusters/aws/vpcs"
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/clusters/aws/vpcs', 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/clusters/aws/vpcs \
--header 'Authorization: Bearer <token>'{
"vpcs": [
{
"id": "<string>",
"name": "<string>",
"cidr": "<string>",
"is_default": true,
"dhcp_domain_name": "<string>",
"dhcp_domain_name_state": "set"
}
]
}{
"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 Clusters
List AWS VPCs
Bearer PAT authentication; RBAC permission clusters.read. Lists the region’s VPCs with their CIDR and DHCP domain-name state (set / empty / unknown). Answers 404 while the organisation’s aws_provider feature flag is off.
GET
/
api
/
v1
/
clusters
/
aws
/
vpcs
List AWS VPCs
import requests
url = "https://platform.ankra.app/api/v1/clusters/aws/vpcs"
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/clusters/aws/vpcs', 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/clusters/aws/vpcs \
--header 'Authorization: Bearer <token>'{
"vpcs": [
{
"id": "<string>",
"name": "<string>",
"cidr": "<string>",
"is_default": true,
"dhcp_domain_name": "<string>",
"dhcp_domain_name_state": "set"
}
]
}{
"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
The organisation's AWS credential (a keys credential, or a role onboarded with the provisioning or self_managed scope).
AWS region slug, e.g. eu-west-1.
Response
Successful response
Show child attributes
Show child attributes