Error
A valid request URL is required to generate request examples{
"api_url": "<string>",
"created_at": "<string>",
"firewall": {
"allow_http": true,
"allowed_cidrs": {},
"allowed_domains": [
"<string>"
]
},
"fleet_oidc": {
"audience": "<string>",
"email_claim": "<string>",
"groups_claim": "<string>",
"is_enabled": true,
"issuer_url": "<string>",
"provider": "<string>",
"subject_claim": "<string>",
"tenant_claim": "<string>",
"tenant_mappings": {}
},
"id": "<string>",
"maintenance_window": "<string>",
"name": "<string>",
"provisioning_settings": {
"additional_tags": {},
"byovpc": {
"private_app_subnet_ids": [
"<string>"
],
"private_db_subnet_ids": [
"<string>"
],
"public_subnet_ids": [
"<string>"
],
"vpc_id": "<string>"
},
"cloud": "AWS",
"is_byoiam_enabled": true,
"is_eks_api_privatelink_disabled": true,
"is_public_load_balancer": true,
"role_arn": "<string>",
"vpc_cidr": "<string>"
},
"region": "<string>",
"status": "requested",
"status_updated_at": "<string>",
"ttl": {
"enabled": true,
"long_days": 123,
"short_days": 123
},
"workspaces": [
{
"id": "<string>",
"name": "<string>"
}
]
}{
"detail": "<string>",
"details": {
"adapter": "<string>",
"item_type": "<string>",
"run_id": "<string>"
},
"error_class": "PARSE_FAILURE",
"instance": "<string>",
"remedy": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"details": {
"adapter": "<string>",
"item_type": "<string>",
"run_id": "<string>"
},
"error_class": "PARSE_FAILURE",
"instance": "<string>",
"remedy": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"details": {
"adapter": "<string>",
"item_type": "<string>",
"run_id": "<string>"
},
"error_class": "PARSE_FAILURE",
"instance": "<string>",
"remedy": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}Get a data plane
Returns a data plane and its saved provisioning settings in any lifecycle state. Requires BYOC and organization management permission.
GET
/
orgs
/
current
/
data-planes
/
{id}
Error
A valid request URL is required to generate request examples{
"api_url": "<string>",
"created_at": "<string>",
"firewall": {
"allow_http": true,
"allowed_cidrs": {},
"allowed_domains": [
"<string>"
]
},
"fleet_oidc": {
"audience": "<string>",
"email_claim": "<string>",
"groups_claim": "<string>",
"is_enabled": true,
"issuer_url": "<string>",
"provider": "<string>",
"subject_claim": "<string>",
"tenant_claim": "<string>",
"tenant_mappings": {}
},
"id": "<string>",
"maintenance_window": "<string>",
"name": "<string>",
"provisioning_settings": {
"additional_tags": {},
"byovpc": {
"private_app_subnet_ids": [
"<string>"
],
"private_db_subnet_ids": [
"<string>"
],
"public_subnet_ids": [
"<string>"
],
"vpc_id": "<string>"
},
"cloud": "AWS",
"is_byoiam_enabled": true,
"is_eks_api_privatelink_disabled": true,
"is_public_load_balancer": true,
"role_arn": "<string>",
"vpc_cidr": "<string>"
},
"region": "<string>",
"status": "requested",
"status_updated_at": "<string>",
"ttl": {
"enabled": true,
"long_days": 123,
"short_days": 123
},
"workspaces": [
{
"id": "<string>",
"name": "<string>"
}
]
}{
"detail": "<string>",
"details": {
"adapter": "<string>",
"item_type": "<string>",
"run_id": "<string>"
},
"error_class": "PARSE_FAILURE",
"instance": "<string>",
"remedy": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"details": {
"adapter": "<string>",
"item_type": "<string>",
"run_id": "<string>"
},
"error_class": "PARSE_FAILURE",
"instance": "<string>",
"remedy": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"details": {
"adapter": "<string>",
"item_type": "<string>",
"run_id": "<string>"
},
"error_class": "PARSE_FAILURE",
"instance": "<string>",
"remedy": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}Authorizations
API KeyOrganization IDBearer Auth
Path Parameters
Data plane ID
Response
Data plane
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
requested, provisioning, provisioning_failed, active, updating, inactive, deprovisioning, deleted, revoked Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?

