List the data centers for your account. Default limit is the first 100 items; use pagination query parameters for listing more items.
Authorizations
AuthorizationstringRequired
You will need to base64 encode the string containing your credentials.
Note:
Query parameters
prettybooleanOptional
Controls whether the response is pretty-printed (with indentations and new lines).
Default: true
depthinteger · int32 · max: 10Optional
Controls the detail depth of the response objects.
GET /datacenters/[ID]
- depth=0: Only direct properties are included; children (servers and other elements) are not included.
- depth=1: Direct properties and children references are included.
- depth=2: Direct properties and children properties are included.
- depth=3: Direct properties and children properties and children's children are included.
- depth=... and so on
Default: 0
offsetinteger · int32Optional
The first element (from the complete list of the elements) to include in the response (used together with limit for pagination).
Creates new data centers, and data centers that already contain elements, such as servers and storage volumes.
Virtual data centers are the foundation of the platform; they act as logical containers for all other objects you create, such as servers and storage volumes. You can provision as many data centers as needed. Data centers have their own private networks and are logically segmented from each other to create isolation.
Authorizations
AuthorizationstringRequired
You will need to base64 encode the string containing your credentials.
Note:
Query parameters
prettybooleanOptional
Controls whether the response is pretty-printed (with indentations and new lines).
Default: true
depthinteger · int32 · max: 10Optional
Controls the detail depth of the response objects.
GET /datacenters/[ID]
- depth=0: Only direct properties are included; children (servers and other elements) are not included.
- depth=1: Direct properties and children references are included.
- depth=2: Direct properties and children properties are included.
- depth=3: Direct properties and children properties and children's children are included.
- depth=... and so on
Default: 0
Header parameters
X-Contract-Numberinteger · int32Optional
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Retrieve data centers by resource ID. This value is in the response body when the data center is created, and in the list of the data centers, returned by GET.
Authorizations
AuthorizationstringRequired
You will need to base64 encode the string containing your credentials.
Note:
Path parameters
datacenterIdstringRequired
The unique ID of the data center.
Query parameters
prettybooleanOptional
Controls whether the response is pretty-printed (with indentations and new lines).
Default: true
depthinteger · int32 · max: 10Optional
Controls the detail depth of the response objects.
GET /datacenters/[ID]
- depth=0: Only direct properties are included; children (servers and other elements) are not included.
- depth=1: Direct properties and children references are included.
- depth=2: Direct properties and children properties are included.
- depth=3: Direct properties and children properties and children's children are included.
- depth=... and so on
Default: 0
Header parameters
X-Contract-Numberinteger · int32Optional
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Modifies the properties of the specified data center, rename it, or change the description.
Authorizations
AuthorizationstringRequired
You will need to base64 encode the string containing your credentials.
Note:
Path parameters
datacenterIdstringRequired
The unique ID of the data center.
Query parameters
prettybooleanOptional
Controls whether the response is pretty-printed (with indentations and new lines).
Default: true
depthinteger · int32 · max: 10Optional
Controls the detail depth of the response objects.
GET /datacenters/[ID]
- depth=0: Only direct properties are included; children (servers and other elements) are not included.
- depth=1: Direct properties and children references are included.
- depth=2: Direct properties and children properties are included.
- depth=3: Direct properties and children properties and children's children are included.
- depth=... and so on
Default: 0
Header parameters
X-Contract-Numberinteger · int32Optional
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Delete the specified data center and all the elements it contains. This method is destructive and should be used carefully.
Authorizations
AuthorizationstringRequired
You will need to base64 encode the string containing your credentials.
Note:
Path parameters
datacenterIdstringRequired
The unique ID of the data center.
Query parameters
prettybooleanOptional
Controls whether the response is pretty-printed (with indentations and new lines).
Default: true
depthinteger · int32 · max: 10Optional
Controls the detail depth of the response objects.
GET /datacenters/[ID]
- depth=0: Only direct properties are included; children (servers and other elements) are not included.
- depth=1: Direct properties and children references are included.
- depth=2: Direct properties and children properties are included.
- depth=3: Direct properties and children properties and children's children are included.
- depth=... and so on
Default: 0
Header parameters
X-Contract-Numberinteger · int32Optional
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Updates the properties of the specified data center, rename it, or change the description.
Authorizations
AuthorizationstringRequired
You will need to base64 encode the string containing your credentials.
Note:
Path parameters
datacenterIdstringRequired
The unique ID of the data center.
Query parameters
prettybooleanOptional
Controls whether the response is pretty-printed (with indentations and new lines).
Default: true
depthinteger · int32 · max: 10Optional
Controls the detail depth of the response objects.
GET /datacenters/[ID]
- depth=0: Only direct properties are included; children (servers and other elements) are not included.
- depth=1: Direct properties and children references are included.
- depth=2: Direct properties and children properties are included.
- depth=3: Direct properties and children properties and children's children are included.
- depth=... and so on
Default: 0
Header parameters
X-Contract-Numberinteger · int32Optional
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Body
namestringOptional
The name of the resource.
Example: Production Datacenter
descriptionstringOptional
A description for the datacenter, such as staging, production.
Example: My Production Datacenter
locationstringRequired
The physical location where the datacenter will be created. This will be where all of your servers live. Property cannot be modified after datacenter creation (disallowed in update requests).
Example: us/las
versioninteger · int32Read-onlyOptional
The version of the data center; incremented with every change.
Example: 8
featuresstring[]Read-onlyOptional
List of features supported by the location where this data center is provisioned.
Example: ["SSD"]
secAuthProtectionbooleanOptional
Boolean value representing if the data center requires extra protection, such as two-step verification.
Example: true
ipv6CidrBlockstring · nullableRead-onlyOptional
This value is either 'null' or contains an automatically-assigned /56 IPv6 CIDR block if IPv6 is enabled on this virtual data center. It can neither be changed nor removed.
Example: 2001:db8:b06d:8f00::/56
defaultSecurityGroupIdstring · uuidOptional
This will become the default security group for the datacenter, replacing the old one if already exists. This security group must already exists prior to this request. Provide this field only if the createDefaultSecurityGroup field is missing. You cannot provide both of them
If this field is set on true and this datacenter has no default security group then a default security group, with predefined rules, will be created for this datacenter. Default value is false. Provide this field only if the defaultSecurityGroupId field is missing. You cannot provide both of them
