Skip to main content

Infrastructure Endpoints

List Cloud Providers

Returns a list of available Cloud Providers. These are Frame IaaS cloud providers, such as Amazon, Azure, and Google, using Nutanix-managed subscriptions.

GET/cloud_providers
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/cloud_providers"

List Datacenters

Provides a list of datacenters associated with the cloud service along with what Frame Image Families and Instance Types are available in each datacenter.

GET/datacenters

Request Parameters

ParameterDescriptionParam TypeData TypeRequired
external_cloud_service_idFilters results based on the ID of a Cloud Service provider (BYO Infrastructure). If you're not using Nutanix IaaS and you instead brought your own cloud provider, this is what you want.Search QueryStringFalse
external_cloud_provider_idFilters results based on the Nutanix IaaS Cloud Provider ID for AWS, Azure, GCP, or Nutanix.Search QueryStringFalse
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/datacenters?external_cloud_service_id=gateway-prod.1337""

List Image Families

Returns all image families and their supported instance types.

GET/image_families

Request Parameters

ParameterDescriptionParam TypeData TypeRequired
cloud_provider_nameFilter results by the Cloud Provider's name, e.g. “amazon”, “azure”, “google”, or “nutanix”.Search QueryStringFalse
byoDetermines wether or not to filter by BYO (Bring your own infrastructure) or not.Search QueryBooleanFalse
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/image_families?external_data_center_id=${external_datacenter_id}&cloud_provider_name=amazon"

List Cloud Services

Returns a list of registered Cloud Service Providers configured with Frame.

GET/cloud_services

Request Parameters

NameDescriptionParam TypeData TypeRequired
organization_idFilters results based on a provided Nutanix Organization ID.Search QueryStringTrue
nameFilters results based on a Cloud Service's “name” field.Search QueryStringFalse
cloud_provider_nameFilters results based on the specified cloud provider: amazon, azure, google, or nutanixSearch QueryStringFalse
activeFilters results by their active status - useful for filtering out inactive cloud services.Search QueryBooleanFalse
omit_defaultIf true, omits Frame's default Cloud Services from the results.Search QueryBooleanFalse
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/cloud_services"

List Cloud Service VPCs

Returns a list of VPCs and their Subnets for a Cloud Service & Datacenter by ID.

GET/cloud_services/:cloud_service_id/vpcs

Request Parameters

ParameterDescriptionParam TypeData TypeRequired
cloud_service_idID of the Cloud Services hosting VPCs.Search QueryStringTrue
datacenter_idID of the Datacenter that you'd like to list VPCs from.Search QueryStringTrue
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/cloud_services