Get a list of datacenters

Get the datacenters that are available for the account (or organization).

Token Permissions: [ dc:get ]

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1
Defaults to 1

The page number to retrieve.

integer
1 to 100
Defaults to 100

The number of datacenters to return per page.

string
Defaults to name:asc,datacenterType:asc

The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order. Define the sort order using the following string: fieldname:asc/desc where:

  • fieldname—The field name of the query parameter to sort by.
  • asc—Sort the selected field name in ascending order.
  • desc—Sort the selected field name in descending order.

You can use multiple query parameters to refine the sorting order.

string
enum

Filter the returned query results by datacenter type. The filtering options include:

  • 'Empty'—Returns all datacenter types.
  • 'Unknown'—Returns any datacenters where the datacenterType is not set.
  • 'SolacePublic'—Known as Public Regions. Public Regions are cloud-based, managed datacenters shared between customers.
  • 'SolaceDedicated'—Known as Dedicated Regions. Dedicated Regions are cloud-based, managed datacenters dedicated to a single-customer.
  • 'CustomerControlled'—Cloud-based Customer-Controlled Regions.
  • 'CustomerOnPrem'—On-premises Customer-Controlled Regions.
Allowed:
string
enum

Filter the returned query results by Kubernetes provider type. The filtering options include:

  • 'aks'-Azure Kubernetes Service.
  • eks’-AWS Elastic Kubernetes Service.
  • gce’-Google Kubernetes Engine.
  • k8s’-Other Kubernetes provider.
  • aws’-(deprecated) VM-based on Amazon Web Services.
  • azure’-(deprecated) VM-based on Azure.
Allowed:
string

Filter the returned query results by an environment's unique identifier. You cannot filter public datacenters using an environment's unique identifier.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json