--- title: Récupérer les centres de données slug: recuperer-les-centres-de-donnees docTags: createdAt: 2026-06-04T15:50:56.155Z --- { "id": "gZk3U73noHH6yBzempGSg", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}", "servers": [ { "url": "https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}" } ], "name": "Retrieve data centers", "description": "

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.

", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "datacenterId", "type": "string", "description": "The unique ID of the data center." } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "optional", "name": "X-Contract-Number", "type": "integer", "description": "

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

", "format": "int32" } ], "queryParameters": [ { "kind": "optional", "name": "pretty", "type": "boolean", "description": "

Controls whether the response is pretty-printed (with indentations and new lines).

", "default": true }, { "kind": "optional", "name": "depth", "type": "integer", "description": "

Controls the detail depth of the response objects.\nGET /datacenters/[ID]\n- depth=0: Only direct properties are included; children (servers and other elements) are not included.\n- depth=1: Direct properties and children references are included.\n- depth=2: Direct properties and children properties are included.\n- depth=3: Direct properties and children properties and children's children are included.\n- depth=... and so on

", "default": 0, "format": "int32", "minimum": 0, "maximum": 10 } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "BasicAuthentication", "name": "BasicAuthentication", "kind": "optional", "type": "http", "description": "

You will need to base64 encode the string containing your credentials. \nNote:\n\n

", "scheme": "basic" }, { "id": "TokenAuthentication", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successful operation", "jsonExample": "", "isExpanded": true, "headers": [ { "kind": "optional", "name": "X-RateLimit-Remaining", "type": "integer", "description": "The number of requests that can still be made without triggering a failure response.", "format": "int32" }, { "kind": "optional", "name": "X-RateLimit-Limit", "type": "integer", "description": "The average number of requests per minute allowed.", "format": "int32" }, { "kind": "optional", "name": "X-RateLimit-Burst", "type": "integer", "description": "The maximum number of concurrent API requests allowed.", "format": "int32" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Datacenter", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "metadata", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/DatacenterElementMetadata", "customType": "DatacenterElementMetadata", "schema": [ { "name": "etag", "kind": "optional", "type": "string", "readOnly": true, "description": "

Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter.

", "example": "45480eb3fbfc31f1d916c1eaa4abdcc3" }, { "name": "createdDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was created.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "createdBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who created the resource.", "example": "user@example.com" }, { "name": "createdByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who created the resource.", "example": "user@example.com" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was modified.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "lastModifiedBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who last modified the resource.", "example": "user@example.com" }, { "name": "lastModifiedByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who last modified the resource.", "example": "63cef532-26fe-4a64-a4e0-de7c8a506c90" }, { "name": "state", "kind": "optional", "type": "string", "readOnly": true, "description": "

State of the resource. AVAILABLE There are no pending modification requests for this item; BUSY There is at least one modification request pending and all following requests will be queued; INACTIVE Resource has been de-provisioned; DEPLOYING Resource state DEPLOYING - relevant for Kubernetes cluster/nodepool; ACTIVE Resource state ACTIVE - relevant for Kubernetes cluster/nodepool; FAILED Resource state FAILED - relevant for Kubernetes cluster/nodepool; SUSPENDED Resource state SUSPENDED - relevant for Kubernetes cluster/nodepool; FAILED_SUSPENDED Resource state FAILED_SUSPENDED - relevant for Kubernetes cluster; UPDATING Resource state UPDATING - relevant for Kubernetes cluster/nodepool; FAILED_UPDATING Resource state FAILED_UPDATING - relevant for Kubernetes cluster/nodepool; DESTROYING Resource state DESTROYING - relevant for Kubernetes cluster; FAILED_DESTROYING Resource state FAILED_DESTROYING - relevant for Kubernetes cluster/nodepool; TERMINATED Resource state TERMINATED - relevant for Kubernetes cluster/nodepool; HIBERNATING Resource state HIBERNATING - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool; MAINTENANCE Resource state MAINTENANCE - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool.

", "example": "AVAILABLE", "enum": [ "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED", "HIBERNATING", "FAILED_HIBERNATING", "MAINTENANCE", "FAILED_MAINTENANCE", "UNKNOWN" ] } ] }, { "name": "properties", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/DatacenterProperties", "customType": "DatacenterProperties", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "The name of the resource.", "example": "Production datacenter" }, { "name": "description", "kind": "optional", "type": "string", "description": "

A description for the datacenter, such as staging, production.

", "example": "My Production Datacenter" }, { "name": "location", "kind": "required", "type": "string", "description": "

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" }, { "name": "version", "kind": "optional", "type": "integer", "readOnly": true, "description": "

The version of the data center; incremented with every change.

", "example": 8, "format": "int32" }, { "name": "features", "kind": "optional", "type": "array", "readOnly": true, "description": "List of features supported by the location where this data center is provisioned.", "example": "[\"SSD\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "secAuthProtection", "kind": "optional", "type": "boolean", "description": "

Boolean value representing if the data center requires extra protection, such as two-step verification.

", "example": true }, { "name": "cpuArchitecture", "kind": "optional", "type": "array", "readOnly": true, "description": "Array of features and CPU families available in a location", "modelRef": "#/components/schemas/CpuArchitectureProperties", "customType": "CpuArchitectureProperties[]", "schema": [ { "name": "cpuFamily", "kind": "optional", "type": "string", "description": "A valid CPU family name.", "example": "INTEL_ICELAKE" }, { "name": "maxCores", "kind": "optional", "type": "integer", "description": "The maximum number of cores available.", "example": 62, "format": "int32" }, { "name": "maxRam", "kind": "optional", "type": "integer", "description": "The maximum RAM size in MB.", "example": 245760, "format": "int32" }, { "name": "vendor", "kind": "optional", "type": "string", "description": "A valid CPU vendor name.", "example": "AuthenticAMD" }, { "name": "enabledFeatures", "kind": "optional", "type": "array", "description": "A list of enabled CPU features.", "example": "[\"SEV-SNP\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "gpuArchitecture", "kind": "optional", "type": "array", "readOnly": true, "description": "The types of GPU cards that are available in the location where the data center is provisioned.", "modelRef": "#/components/schemas/GpuArchitectureProperties", "customType": "GpuArchitectureProperties[]", "schema": [ { "name": "vendor", "kind": "optional", "type": "string", "description": "

The vendor of the Graphics Processing Unit (GPU) card.

", "example": "NVIDIA" }, { "name": "model", "kind": "optional", "type": "string", "description": "

The model of the Graphics Processing Unit (GPU) card.

", "example": "A100" } ] }, { "name": "ipv6CidrBlock", "kind": "optional", "type": "string", "readOnly": true, "nullable": true, "description": "

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" }, { "name": "defaultSecurityGroupId", "kind": "optional", "type": "string", "description": "Optional property to define the default security group of the datacenter.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c", "format": "uuid" } ] }, { "name": "entities", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/DatacenterEntities", "customType": "DatacenterEntities", "schema": [ { "name": "servers", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Servers", "customType": "Servers", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "readOnly": true, "description": "Array of items in the collection.", "modelRef": "#/components/schemas/Server", "customType": "Server[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "metadata", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/DatacenterElementMetadata", "customType": "DatacenterElementMetadata", "schema": [ { "name": "etag", "kind": "optional", "type": "string", "readOnly": true, "description": "

Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter.

", "example": "45480eb3fbfc31f1d916c1eaa4abdcc3" }, { "name": "createdDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was created.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "createdBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who created the resource.", "example": "user@example.com" }, { "name": "createdByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who created the resource.", "example": "user@example.com" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was modified.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "lastModifiedBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who last modified the resource.", "example": "user@example.com" }, { "name": "lastModifiedByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who last modified the resource.", "example": "63cef532-26fe-4a64-a4e0-de7c8a506c90" }, { "name": "state", "kind": "optional", "type": "string", "readOnly": true, "description": "

State of the resource. AVAILABLE There are no pending modification requests for this item; BUSY There is at least one modification request pending and all following requests will be queued; INACTIVE Resource has been de-provisioned; DEPLOYING Resource state DEPLOYING - relevant for Kubernetes cluster/nodepool; ACTIVE Resource state ACTIVE - relevant for Kubernetes cluster/nodepool; FAILED Resource state FAILED - relevant for Kubernetes cluster/nodepool; SUSPENDED Resource state SUSPENDED - relevant for Kubernetes cluster/nodepool; FAILED_SUSPENDED Resource state FAILED_SUSPENDED - relevant for Kubernetes cluster; UPDATING Resource state UPDATING - relevant for Kubernetes cluster/nodepool; FAILED_UPDATING Resource state FAILED_UPDATING - relevant for Kubernetes cluster/nodepool; DESTROYING Resource state DESTROYING - relevant for Kubernetes cluster; FAILED_DESTROYING Resource state FAILED_DESTROYING - relevant for Kubernetes cluster/nodepool; TERMINATED Resource state TERMINATED - relevant for Kubernetes cluster/nodepool; HIBERNATING Resource state HIBERNATING - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool; MAINTENANCE Resource state MAINTENANCE - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool.

", "example": "AVAILABLE", "enum": [ "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED", "HIBERNATING", "FAILED_HIBERNATING", "MAINTENANCE", "FAILED_MAINTENANCE", "UNKNOWN" ] } ] }, { "name": "properties", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/ServerProperties", "customType": "ServerProperties", "schema": [ { "name": "templateUuid", "kind": "optional", "type": "string", "description": "

The ID of the template for creating CUBE or GPU servers. If a template has GPU cards assigned, then it can only be used to create GPU servers, otherwise it can only be used for CUBE servers. The available templates can be found on the templates resource.

", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "name", "kind": "optional", "type": "string", "description": "The name of the resource.", "example": "My resource" }, { "name": "hostname", "kind": "optional", "type": "string", "description": "

The hostname of the resource. Allowed characters are a-z, 0-9 and - (minus). Hostname should not start with minus and should not be longer than 63 characters.

", "example": "myHostname" }, { "name": "cores", "kind": "optional", "type": "integer", "description": "

The total number of cores for the server. It can not be supplied for the VMs that have to be created based on templates. For servers with Confidential Computing enabled, the number of cores must match the amount of cores required by the Confidential Computing image, and this field is immutable once the server has been created — update requests attempting to change it will be rejected.

", "example": 4, "format": "int32" }, { "name": "ram", "kind": "optional", "type": "integer", "description": "

The memory size for the server in MB, such as 2048. Size must be specified in multiples of 256 MB with a minimum of 256 MB; however, if you set ramHotPlug to TRUE then you must use a minimum of 1024 MB. If you set the RAM size more than 240GB, then ramHotPlug will be set to FALSE and can not be set to TRUE unless RAM size not set to less than 240GB. It can not be supplied for the VMs that have to be created based on templates. For servers with Confidential Computing enabled, this field is immutable once the server has been created — update requests attempting to change it will be rejected.

", "example": 4096, "format": "int32" }, { "name": "availabilityZone", "kind": "optional", "type": "string", "description": "

The availability zone in which the server should be provisioned. For CUBE and GPU servers, the only value accepted is 'AUTO'. For servers with Confidential Computing enabled, this field is immutable once the server has been created — update requests attempting to change it will be rejected.

", "example": "AUTO", "enum": [ "AUTO", "ZONE_1", "ZONE_2" ] }, { "name": "vmState", "kind": "optional", "type": "string", "readOnly": true, "description": "Status of the virtual machine.", "example": "RUNNING", "enum": [ "NOSTATE", "RUNNING", "BLOCKED", "PAUSED", "SHUTDOWN", "SHUTOFF", "CRASHED", "SUSPENDED" ] }, { "name": "bootCdrom", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ResourceReference", "description": "", "modelRef": "#/components/schemas/ResourceReference", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "The resource's unique identifier." }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" } ] } ], "schema": [] }, { "name": "bootVolume", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ResourceReference", "description": "", "modelRef": "#/components/schemas/ResourceReference", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "The resource's unique identifier." }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" } ] } ], "schema": [] }, { "name": "cpuFamily", "kind": "optional", "type": "string", "description": "

CPU architecture on which server gets provisioned; not all CPU architectures are available in all datacenter regions; available CPU architectures can be retrieved from the datacenter resource; must not be provided for CUBE and VCPU servers. If the field is omitted from the request or the value is empty or null, an available CPU architecture will be automatically selected. This field must not be supplied when creating a server with Confidential Computing enabled (i.e. when one of the attached volumes uses a confidential computing image); in that case the CPU family is determined by the image and is selected automatically. On servers with Confidential Computing enabled this field is also immutable — update requests attempting to change it will be rejected.

", "example": "INTEL_ICELAKE" }, { "name": "type", "kind": "optional", "type": "string", "description": "

Server type: CUBE, ENTERPRISE, VCPU or GPU. Confidential Computing can be enabled only on a server of type ENTERPRISE by creating it with a volume with a Confidential Computing image.

", "example": "CUBE" }, { "name": "enabledFeatures", "kind": "optional", "type": "array", "readOnly": true, "description": "

The list of features enabled on this server. An ENTERPRISE server with Confidential Computing enabled will have SEV-SNP as part of this list.

", "example": "[\"SEV-SNP\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "placementGroupId", "kind": "optional", "type": "string", "description": "

The placement group ID that belongs to this server; Requires system privileges, for internal usage only

", "example": "" }, { "name": "nicMultiQueue", "kind": "optional", "type": "boolean", "description": "

Activate or deactivate the Multi Queue feature on all NICs of this server. This feature is beneficial to enable when the NICs are experiencing performance issues (e.g. low throughput). Toggling this feature will also initiate a restart of the server. If the specified value is true, the feature will be activated; if it is not specified or set to false, the feature will be deactivated. It is not allowed for servers of type Cube.

", "example": true }, { "name": "maxNetworkBandwidth", "kind": "optional", "type": "number", "readOnly": true, "description": "The maximum bandwidth in Gbps as specified by NQoS tiers", "example": 6, "format": "float" } ] }, { "name": "entities", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/ServerEntities", "customType": "ServerEntities", "schema": [ { "name": "cdroms", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Cdroms", "customType": "Cdroms", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "description": "Array of items in the collection.", "modelRef": "#/components/schemas/Image", "customType": "Image[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "offset", "kind": "optional", "type": "number", "description": "

The offset (if specified in the request).

", "modelRef": "#/components/schemas/PaginationOffsetOptional", "customType": "PaginationOffsetOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "volumes", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/AttachedVolumes", "customType": "AttachedVolumes", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

The URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "description": "Array of items in the collection.", "modelRef": "#/components/schemas/Volume", "customType": "Volume[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "offset", "kind": "optional", "type": "number", "description": "

The offset (if specified in the request).

", "modelRef": "#/components/schemas/PaginationOffsetOptional", "customType": "PaginationOffsetOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "nics", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Nics", "customType": "Nics", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "description": "Array of items in the collection.", "modelRef": "#/components/schemas/Nic", "customType": "Nic[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "offset", "kind": "optional", "type": "number", "description": "

The offset (if specified in the request).

", "modelRef": "#/components/schemas/PaginationOffsetOptional", "customType": "PaginationOffsetOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "securitygroups", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/SecurityGroups", "customType": "SecurityGroups", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

The URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "readOnly": true, "description": "Array of items in the collection.", "modelRef": "#/components/schemas/SecurityGroup", "customType": "SecurityGroup[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "offset", "kind": "optional", "type": "number", "description": "

The offset (if specified in the request).

", "modelRef": "#/components/schemas/PaginationOffsetOptional", "customType": "PaginationOffsetOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "gpus", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/GPUs", "customType": "GPUs", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "25f67991-0f51-4efc-a8ad-ef1fb31a400c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

The URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "description": "Array of items in the collection.", "modelRef": "#/components/schemas/GPU", "customType": "GPU[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "offset", "kind": "optional", "type": "number", "description": "

The offset (if specified in the request).

", "modelRef": "#/components/schemas/PaginationOffsetOptional", "customType": "PaginationOffsetOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] } ] }, { "name": "offset", "kind": "optional", "type": "number", "description": "

The offset (if specified in the request).

", "modelRef": "#/components/schemas/PaginationOffsetOptional", "customType": "PaginationOffsetOptional", "schema": [] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "schema": [ { "name": "prev", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the previous page; only present if offset is greater than 0.

", "example": "", "format": "uri" }, { "name": "self", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the current page.

", "example": "", "format": "uri" }, { "name": "next", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the next page; only present if offset + limit is less than the total number of elements.

", "example": "", "format": "uri" } ] } ] }, { "name": "volumes", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Volumes", "customType": "Volumes", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "readOnly": true, "description": "Array of items in the collection.", "modelRef": "#/components/schemas/Volume", "customType": "Volume[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

The URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "metadata", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/DatacenterElementMetadata", "customType": "DatacenterElementMetadata", "schema": [ { "name": "etag", "kind": "optional", "type": "string", "readOnly": true, "description": "

Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter.

", "example": "45480eb3fbfc31f1d916c1eaa4abdcc3" }, { "name": "createdDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was created.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "createdBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who created the resource.", "example": "user@example.com" }, { "name": "createdByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who created the resource.", "example": "user@example.com" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was modified.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "lastModifiedBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who last modified the resource.", "example": "user@example.com" }, { "name": "lastModifiedByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who last modified the resource.", "example": "63cef532-26fe-4a64-a4e0-de7c8a506c90" }, { "name": "state", "kind": "optional", "type": "string", "readOnly": true, "description": "

State of the resource. AVAILABLE There are no pending modification requests for this item; BUSY There is at least one modification request pending and all following requests will be queued; INACTIVE Resource has been de-provisioned; DEPLOYING Resource state DEPLOYING - relevant for Kubernetes cluster/nodepool; ACTIVE Resource state ACTIVE - relevant for Kubernetes cluster/nodepool; FAILED Resource state FAILED - relevant for Kubernetes cluster/nodepool; SUSPENDED Resource state SUSPENDED - relevant for Kubernetes cluster/nodepool; FAILED_SUSPENDED Resource state FAILED_SUSPENDED - relevant for Kubernetes cluster; UPDATING Resource state UPDATING - relevant for Kubernetes cluster/nodepool; FAILED_UPDATING Resource state FAILED_UPDATING - relevant for Kubernetes cluster/nodepool; DESTROYING Resource state DESTROYING - relevant for Kubernetes cluster; FAILED_DESTROYING Resource state FAILED_DESTROYING - relevant for Kubernetes cluster/nodepool; TERMINATED Resource state TERMINATED - relevant for Kubernetes cluster/nodepool; HIBERNATING Resource state HIBERNATING - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool; MAINTENANCE Resource state MAINTENANCE - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool.

", "example": "AVAILABLE", "enum": [ "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED", "HIBERNATING", "FAILED_HIBERNATING", "MAINTENANCE", "FAILED_MAINTENANCE", "UNKNOWN" ] } ] }, { "name": "properties", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/VolumeProperties", "customType": "VolumeProperties", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "The name of the resource.", "example": "My resource" }, { "name": "type", "kind": "optional", "type": "string", "description": "

Hardware type of the volume. DAS (Direct Attached Storage) could be used only in a composite call with a Cube server.

", "example": "HDD", "enum": [ "HDD", "SSD", "SSD Standard", "SSD Premium", "DAS", "ISO" ] }, { "name": "size", "kind": "required", "type": "number", "description": "The size of the volume in GB.", "example": 100 }, { "name": "availabilityZone", "kind": "optional", "type": "string", "description": "

The availability zone in which the volume should be provisioned. The storage volume will be provisioned on as few physical storage devices as possible, but this cannot be guaranteed upfront. This is uavailable for DAS (Direct Attached Storage), and subject to availability for SSD.

", "example": "AUTO", "enum": [ "AUTO", "ZONE_1", "ZONE_2", "ZONE_3" ] }, { "name": "image", "kind": "optional", "type": "string", "description": "

Image or snapshot ID to be used as template for this volume. MSSQL Enterprise Images can be used only if the feature toggle for MSSQL Enterprise is enabled on the contract. If the referenced image supports Confidential Computing, additional rules apply: the volume can only be created inline as part of a server creation request (not via standalone volume creation, nor by attaching to an existing server), and exactly one volume on that server may use such an image. The resulting volume is permanently bound to the server as its boot device and cannot be detached or moved to another server.

", "example": "d6ad1576-fde9-4696-aa41-1ebd75bdaf49" }, { "name": "imagePassword", "kind": "optional", "type": "string", "description": "

Initial password to be set for installed OS. Works with public images only. Not modifiable, forbidden in update requests. Password rules allows all characters from a-z, A-Z, 0-9.

", "example": "mypass123" }, { "name": "sshKeys", "kind": "optional", "type": "array", "description": "

Public SSH keys are set on the image as authorized keys for appropriate SSH login to the instance using the corresponding private key. This field may only be set in creation requests. When reading, it always returns null. SSH keys are only supported if a public Linux image is used for the volume creation.

", "example": "[\"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCyWh6LZ7f2wxnupVgtK2096bc69Vv9uT2A58lwN3ol0A6mxqlT0f4M1NbarVUxa+MVdxBLud5PvlkbYc9mY91OyzLGZMfVWvhAYz/tJSsDtsgRUl0GFVv332zDWk0i+mAVy0N408OORm5XqV6zvIDaiB/jopyjemUp2rnP7pXU4+98ilZw6ef9DF9y4YZ64mchL5//rcrGm1Lff3pC75X/polGONHeG6m4Vs8eIu+0epJ4PJBxO+rwRYp1zMnn90UCk21KvTcYops2cte7ouXQwkGUq3vmXxnSdvuivK/4JNoFQBsaGV974hDmloS5LOvSJjKpXs8Ed437ln712345\",\"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCyWh6LZ7f2wxnupVgtK2096bc69Vv9uT2A58lwN3ol0A6mxqlT0f4M1NbarVUxa+MVdxBLud5PvlkbYc9mY91OyzLGZMfVWvhAYz/tJSsDtsgRUl0GFVv332zDWk0i+mAVy0N408OORm5XqV6zvIDaiB/jopyjemUp2rnP7pXU4+98ilZw6ef9DF9y4YZ64mchL5//rcrGm1Lff3pC75X/polGONHeG6m4Vs8eIu+0epJ4PJBxO+rwRYp1zMnn90UCk21KvTcYops2cte7ouXQwkGUq3vmXxnSdvuivK/asdfghjkjhyutry545tgvbn76e4rf43\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "bus", "kind": "optional", "type": "string", "description": "

The bus type for this volume; default is VIRTIO.

", "example": "VIRTIO", "enum": [ "VIRTIO", "IDE", "UNKNOWN" ] }, { "name": "licenceType", "kind": "optional", "type": "string", "description": "OS type for this volume.", "example": "LINUX" }, { "name": "applicationType", "kind": "optional", "type": "string", "description": "The type of application that is hosted on this resource. Only public images can have an Application type different than UNKNOWN.", "example": "MSSQL-2019-Standard", "modelRef": "#/components/schemas/ApplicationType", "customType": "ApplicationType", "schema": [] }, { "name": "cpuHotPlug", "kind": "optional", "type": "boolean", "description": "

Hot-plug capable CPU (no reboot required).

", "example": true }, { "name": "ramHotPlug", "kind": "optional", "type": "boolean", "description": "

Hot-plug capable RAM (no reboot required).

", "example": true }, { "name": "nicHotPlug", "kind": "optional", "type": "boolean", "description": "

Hot-plug capable NIC (no reboot required).

", "example": true }, { "name": "nicHotUnplug", "kind": "optional", "type": "boolean", "description": "

Hot-unplug capable NIC (no reboot required).

", "example": true }, { "name": "discVirtioHotPlug", "kind": "optional", "type": "boolean", "description": "

Hot-plug capable Virt-IO drive (no reboot required).

", "example": true }, { "name": "discVirtioHotUnplug", "kind": "optional", "type": "boolean", "description": "

Hot-unplug capable Virt-IO drive (no reboot required). Not supported with Windows VMs.

", "example": true }, { "name": "exposeSerial", "kind": "optional", "type": "boolean", "description": "

If set to true will expose the serial id of the disk attached to the server. If set to false will not expose the serial id. Some operating systems or software solutions require the serial id to be exposed to work properly. Exposing the serial can influence licensed software (e.g. Windows) behavior

", "example": true, "modelRef": "#/components/schemas/ExposeSerial", "customType": "ExposeSerial", "schema": [] }, { "name": "requireLegacyBios", "kind": "optional", "type": "boolean", "description": "Indicates if the image requires the legacy BIOS for compatibility or specific needs.", "example": true, "default": true, "modelRef": "#/components/schemas/RequireLegacyBios", "customType": "RequireLegacyBios", "schema": [] }, { "name": "deviceNumber", "kind": "optional", "type": "integer", "readOnly": true, "description": "

The Logical Unit Number of the storage volume. Null for volumes, not mounted to a VM.

", "example": 3, "format": "int64" }, { "name": "pciSlot", "kind": "optional", "type": "integer", "readOnly": true, "description": "

The PCI slot number of the storage volume. Null for volumes, not mounted to a VM.

", "example": 7, "format": "int32" }, { "name": "backupunitId", "kind": "optional", "type": "string", "description": "The ID of the backup unit that the user has access to. The property is immutable and is only allowed to be set on creation of a new a volume. It is mandatory to provide either 'public image' or 'imageAlias' in conjunction with this property.", "example": "25f67991-0f51-4efc-a8ad-ef1fb31a481c", "format": "uuid" }, { "name": "userData", "kind": "optional", "type": "string", "description": "

The cloud-init configuration for the volume as base64 encoded string. The property is immutable and is only allowed to be set on creation of a new a volume. It is mandatory to provide either 'public image' or 'imageAlias' that has cloud-init compatibility in conjunction with this property. This field is blocked for Confidential Computing VM storage.

" }, { "name": "bootServer", "kind": "optional", "type": "string", "readOnly": true, "description": "The UUID of the attached server.", "example": "25f67991-0f51-4efc-a8ad-ef1fb31a481c" }, { "name": "bootOrder", "kind": "optional", "type": "string", "nullable": true, "description": "

Determines whether the volume will be used as a boot volume. Set to NONE, the volume will not be used as boot volume. Set to PRIMARY, the volume will be used as boot volume and all other volumes must be set to NONE. Set to AUTO or null requires all volumes to be set to AUTO or null; this will use the legacy behavior, which is to use the volume as a boot volume only if there are no other volumes or cdrom devices.\nA volume with a Confidential Computing image may be created with bootOrder set to PRIMARY (or left unset / AUTO, in which case it is automatically treated as the boot device), but it must not be created with bootOrder set to NONE. Conversely, no other volume attached to the same server is allowed to be set to PRIMARY — only the confidential computing volume can be the boot device.

", "example": "AUTO", "default": "AUTO", "enum": [ "AUTO", "NONE", "PRIMARY" ] } ] } ] }, { "name": "offset", "kind": "optional", "type": "number", "description": "

The offset (if specified in the request).

", "modelRef": "#/components/schemas/PaginationOffsetOptional", "customType": "PaginationOffsetOptional", "schema": [] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "schema": [ { "name": "prev", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the previous page; only present if offset is greater than 0.

", "example": "", "format": "uri" }, { "name": "self", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the current page.

", "example": "", "format": "uri" }, { "name": "next", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the next page; only present if offset + limit is less than the total number of elements.

", "example": "", "format": "uri" } ] } ] }, { "name": "loadbalancers", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Loadbalancers", "customType": "Loadbalancers", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "readOnly": true, "description": "Array of items in the collection.", "modelRef": "#/components/schemas/Loadbalancer", "customType": "Loadbalancer[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "metadata", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/DatacenterElementMetadata", "customType": "DatacenterElementMetadata", "schema": [ { "name": "etag", "kind": "optional", "type": "string", "readOnly": true, "description": "

Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter.

", "example": "45480eb3fbfc31f1d916c1eaa4abdcc3" }, { "name": "createdDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was created.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "createdBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who created the resource.", "example": "user@example.com" }, { "name": "createdByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who created the resource.", "example": "user@example.com" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was modified.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "lastModifiedBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who last modified the resource.", "example": "user@example.com" }, { "name": "lastModifiedByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who last modified the resource.", "example": "63cef532-26fe-4a64-a4e0-de7c8a506c90" }, { "name": "state", "kind": "optional", "type": "string", "readOnly": true, "description": "

State of the resource. AVAILABLE There are no pending modification requests for this item; BUSY There is at least one modification request pending and all following requests will be queued; INACTIVE Resource has been de-provisioned; DEPLOYING Resource state DEPLOYING - relevant for Kubernetes cluster/nodepool; ACTIVE Resource state ACTIVE - relevant for Kubernetes cluster/nodepool; FAILED Resource state FAILED - relevant for Kubernetes cluster/nodepool; SUSPENDED Resource state SUSPENDED - relevant for Kubernetes cluster/nodepool; FAILED_SUSPENDED Resource state FAILED_SUSPENDED - relevant for Kubernetes cluster; UPDATING Resource state UPDATING - relevant for Kubernetes cluster/nodepool; FAILED_UPDATING Resource state FAILED_UPDATING - relevant for Kubernetes cluster/nodepool; DESTROYING Resource state DESTROYING - relevant for Kubernetes cluster; FAILED_DESTROYING Resource state FAILED_DESTROYING - relevant for Kubernetes cluster/nodepool; TERMINATED Resource state TERMINATED - relevant for Kubernetes cluster/nodepool; HIBERNATING Resource state HIBERNATING - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool; MAINTENANCE Resource state MAINTENANCE - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool.

", "example": "AVAILABLE", "enum": [ "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED", "HIBERNATING", "FAILED_HIBERNATING", "MAINTENANCE", "FAILED_MAINTENANCE", "UNKNOWN" ] } ] }, { "name": "properties", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/LoadbalancerProperties", "customType": "LoadbalancerProperties", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "The name of the resource.", "example": "My resource" }, { "name": "ip", "kind": "optional", "type": "string", "nullable": true, "description": "IPv4 address of the loadbalancer. All attached NICs will inherit this IP. Leaving value null will assign IP automatically.", "example": "22.231.113.64" }, { "name": "dhcp", "kind": "optional", "type": "boolean", "description": "Indicates if the loadbalancer will reserve an IP using DHCP.", "example": true } ] }, { "name": "entities", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/LoadbalancerEntities", "customType": "LoadbalancerEntities", "schema": [ { "name": "balancednics", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/BalancedNics", "customType": "BalancedNics", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "readOnly": true, "description": "Array of items in the collection.", "modelRef": "#/components/schemas/Nic", "customType": "Nic[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "offset", "kind": "optional", "type": "number", "description": "

The offset (if specified in the request).

", "modelRef": "#/components/schemas/PaginationOffsetOptional", "customType": "PaginationOffsetOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] } ] }, { "name": "offset", "kind": "optional", "type": "number", "description": "

The offset (if specified in the request).

", "modelRef": "#/components/schemas/PaginationOffsetOptional", "customType": "PaginationOffsetOptional", "schema": [] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "schema": [ { "name": "prev", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the previous page; only present if offset is greater than 0.

", "example": "", "format": "uri" }, { "name": "self", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the current page.

", "example": "", "format": "uri" }, { "name": "next", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the next page; only present if offset + limit is less than the total number of elements.

", "example": "", "format": "uri" } ] } ] }, { "name": "lans", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Lans", "customType": "Lans", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "readOnly": true, "description": "Array of items in the collection.", "modelRef": "#/components/schemas/Lan", "customType": "Lan[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "5" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "metadata", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/DatacenterElementMetadata", "customType": "DatacenterElementMetadata", "schema": [ { "name": "etag", "kind": "optional", "type": "string", "readOnly": true, "description": "

Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter.

", "example": "45480eb3fbfc31f1d916c1eaa4abdcc3" }, { "name": "createdDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was created.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "createdBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who created the resource.", "example": "user@example.com" }, { "name": "createdByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who created the resource.", "example": "user@example.com" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was modified.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "lastModifiedBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who last modified the resource.", "example": "user@example.com" }, { "name": "lastModifiedByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who last modified the resource.", "example": "63cef532-26fe-4a64-a4e0-de7c8a506c90" }, { "name": "state", "kind": "optional", "type": "string", "readOnly": true, "description": "

State of the resource. AVAILABLE There are no pending modification requests for this item; BUSY There is at least one modification request pending and all following requests will be queued; INACTIVE Resource has been de-provisioned; DEPLOYING Resource state DEPLOYING - relevant for Kubernetes cluster/nodepool; ACTIVE Resource state ACTIVE - relevant for Kubernetes cluster/nodepool; FAILED Resource state FAILED - relevant for Kubernetes cluster/nodepool; SUSPENDED Resource state SUSPENDED - relevant for Kubernetes cluster/nodepool; FAILED_SUSPENDED Resource state FAILED_SUSPENDED - relevant for Kubernetes cluster; UPDATING Resource state UPDATING - relevant for Kubernetes cluster/nodepool; FAILED_UPDATING Resource state FAILED_UPDATING - relevant for Kubernetes cluster/nodepool; DESTROYING Resource state DESTROYING - relevant for Kubernetes cluster; FAILED_DESTROYING Resource state FAILED_DESTROYING - relevant for Kubernetes cluster/nodepool; TERMINATED Resource state TERMINATED - relevant for Kubernetes cluster/nodepool; HIBERNATING Resource state HIBERNATING - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool; MAINTENANCE Resource state MAINTENANCE - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool.

", "example": "AVAILABLE", "enum": [ "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED", "HIBERNATING", "FAILED_HIBERNATING", "MAINTENANCE", "FAILED_MAINTENANCE", "UNKNOWN" ] } ] }, { "name": "properties", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/LanProperties", "customType": "LanProperties", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "The name of the resource.", "example": "My resource" }, { "name": "ipFailover", "kind": "optional", "type": "array", "description": "IP failover configurations for lan", "modelRef": "#/components/schemas/IPFailover", "customType": "IPFailover[]", "schema": [ { "name": "ip", "kind": "optional", "type": "string", "description": "", "example": "192.18.2.231" }, { "name": "nicUuid", "kind": "optional", "type": "string", "description": "", "example": "3c11273c-b3e1-4ca3-8134-84fd2dd4ebec" } ] }, { "name": "ipv4CidrBlock", "kind": "optional", "type": "string", "readOnly": true, "nullable": true, "description": "

For public LANs this property is null, for private LANs it contains the private IPv4 CIDR range. This property is a read only property.

", "example": "10.8.130.0/23" }, { "name": "ipv6CidrBlock", "kind": "optional", "type": "string", "nullable": true, "description": "

For a GET request, this value is either 'null' or contains the LAN's /64 IPv6 CIDR block if this LAN is IPv6 enabled. For POST/PUT/PATCH requests, 'AUTO' will result in enabling this LAN for IPv6 and automatically assign a /64 IPv6 CIDR block to this LAN and /80 IPv6 CIDR blocks to the NICs and one /128 IPv6 address to each connected NIC. If you choose the IPv6 CIDR block for the LAN on your own, then you must provide a /64 block, which is inside the IPv6 CIDR block of the virtual datacenter and unique inside all LANs from this virtual datacenter. If you enable IPv6 on a LAN with NICs, those NICs will get a /80 IPv6 CIDR block and one IPv6 address assigned to each automatically, unless you specify them explicitly on the LAN and on the NICs. A virtual data center is limited to a maximum of 256 IPv6-enabled LANs.

", "example": "2001:db8:b06d:8f5a::/64" }, { "name": "pcc", "kind": "optional", "type": "string", "description": "

The unique identifier of the Cross Connect the LAN is connected to, if any. It needs to be ensured that IP addresses of the NICs of all LANs connected to a given Cross Connect is not duplicated and belongs to the same subnet range.

", "example": "3c11273c-b3e1-4ca3-8134-84fd2dd4ebec" }, { "name": "public", "kind": "optional", "type": "boolean", "description": "Indicates if the LAN is connected to the internet or not.", "example": true }, { "name": "vni", "kind": "optional", "type": "integer", "readOnly": true, "description": "The VNI value that is assigned to the LAN.", "example": 123, "format": "int32" } ] }, { "name": "entities", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/LanEntities", "customType": "LanEntities", "schema": [ { "name": "nics", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/LanNics", "customType": "LanNics", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "readOnly": true, "description": "Array of items in the collection.", "modelRef": "#/components/schemas/Nic", "customType": "Nic[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "offset", "kind": "optional", "type": "number", "description": "

The offset (if specified in the request).

", "modelRef": "#/components/schemas/PaginationOffsetOptional", "customType": "PaginationOffsetOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] } ] }, { "name": "offset", "kind": "optional", "type": "number", "description": "

The offset (if specified in the request).

", "modelRef": "#/components/schemas/PaginationOffsetOptional", "customType": "PaginationOffsetOptional", "schema": [] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "schema": [ { "name": "prev", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the previous page; only present if offset is greater than 0.

", "example": "", "format": "uri" }, { "name": "self", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the current page.

", "example": "", "format": "uri" }, { "name": "next", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the next page; only present if offset + limit is less than the total number of elements.

", "example": "", "format": "uri" } ] } ] }, { "name": "networkloadbalancers", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/NetworkLoadBalancers", "customType": "NetworkLoadBalancers", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "readOnly": true, "description": "Array of items in the collection.", "modelRef": "#/components/schemas/NetworkLoadBalancer", "customType": "NetworkLoadBalancer[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "metadata", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/DatacenterElementMetadata", "customType": "DatacenterElementMetadata", "schema": [ { "name": "etag", "kind": "optional", "type": "string", "readOnly": true, "description": "

Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter.

", "example": "45480eb3fbfc31f1d916c1eaa4abdcc3" }, { "name": "createdDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was created.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "createdBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who created the resource.", "example": "user@example.com" }, { "name": "createdByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who created the resource.", "example": "user@example.com" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was modified.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "lastModifiedBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who last modified the resource.", "example": "user@example.com" }, { "name": "lastModifiedByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who last modified the resource.", "example": "63cef532-26fe-4a64-a4e0-de7c8a506c90" }, { "name": "state", "kind": "optional", "type": "string", "readOnly": true, "description": "

State of the resource. AVAILABLE There are no pending modification requests for this item; BUSY There is at least one modification request pending and all following requests will be queued; INACTIVE Resource has been de-provisioned; DEPLOYING Resource state DEPLOYING - relevant for Kubernetes cluster/nodepool; ACTIVE Resource state ACTIVE - relevant for Kubernetes cluster/nodepool; FAILED Resource state FAILED - relevant for Kubernetes cluster/nodepool; SUSPENDED Resource state SUSPENDED - relevant for Kubernetes cluster/nodepool; FAILED_SUSPENDED Resource state FAILED_SUSPENDED - relevant for Kubernetes cluster; UPDATING Resource state UPDATING - relevant for Kubernetes cluster/nodepool; FAILED_UPDATING Resource state FAILED_UPDATING - relevant for Kubernetes cluster/nodepool; DESTROYING Resource state DESTROYING - relevant for Kubernetes cluster; FAILED_DESTROYING Resource state FAILED_DESTROYING - relevant for Kubernetes cluster/nodepool; TERMINATED Resource state TERMINATED - relevant for Kubernetes cluster/nodepool; HIBERNATING Resource state HIBERNATING - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool; MAINTENANCE Resource state MAINTENANCE - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool.

", "example": "AVAILABLE", "enum": [ "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED", "HIBERNATING", "FAILED_HIBERNATING", "MAINTENANCE", "FAILED_MAINTENANCE", "UNKNOWN" ] } ] }, { "name": "properties", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/NetworkLoadBalancerProperties", "customType": "NetworkLoadBalancerProperties", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "The name of the Network Load Balancer.", "example": "My Network Load Balancer" }, { "name": "listenerLan", "kind": "required", "type": "integer", "description": "

ID of the listening LAN (inbound).

", "example": 1 }, { "name": "ips", "kind": "optional", "type": "array", "description": "

Collection of the Network Load Balancer IP addresses. (Inbound and outbound) IPs of the listenerLan must be customer-reserved IPs for public Load Balancers, and private IPs for private Load Balancers.

", "example": "[\"81.173.1.2\",\"22.231.2.2\",\"22.231.2.3\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "targetLan", "kind": "required", "type": "integer", "description": "

ID of the balanced private target LAN (outbound).

", "example": 2 }, { "name": "lbPrivateIps", "kind": "optional", "type": "array", "description": "

Collection of private IP addresses with subnet mask of the Network Load Balancer. IPs must contain a valid subnet mask. If no IP is provided, the system will generate an IP with /24 subnet.

", "example": "[\"81.173.1.5/24\",\"22.231.2.5/24\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "centralLogging", "kind": "optional", "type": "boolean", "description": "Turn logging on and off for this product. Default value is 'false'.", "example": true }, { "name": "loggingFormat", "kind": "optional", "type": "string", "description": "Specifies the format of the logs.", "example": "%{+Q}o %{-Q}ci - - [%trg] %r %ST %B \"\" \"\" %cp %ms %ft %b %s %TR %Tw %Tc %Tr %Ta %tsc %ac %fc %bc %sc %rc %sq %bq %CC %CS %hrl %hsl" } ] }, { "name": "entities", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/NetworkLoadBalancerEntities", "customType": "NetworkLoadBalancerEntities", "schema": [ { "name": "flowlogs", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/FlowLogs", "customType": "FlowLogs", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

The URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "readOnly": true, "description": "Array of items in the collection.", "modelRef": "#/components/schemas/FlowLog", "customType": "FlowLog[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "offset", "kind": "optional", "type": "number", "description": "

The offset (if specified in the request).

", "modelRef": "#/components/schemas/PaginationOffsetOptional", "customType": "PaginationOffsetOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "forwardingrules", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/NetworkLoadBalancerForwardingRules", "customType": "NetworkLoadBalancerForwardingRules", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "readOnly": true, "description": "Array of items in the collection.", "modelRef": "#/components/schemas/NetworkLoadBalancerForwardingRule", "customType": "NetworkLoadBalancerForwardingRule[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "offset", "kind": "optional", "type": "number", "description": "

The offset (if specified in the request).

", "modelRef": "#/components/schemas/PaginationOffsetOptional", "customType": "PaginationOffsetOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] } ] }, { "name": "offset", "kind": "optional", "type": "number", "description": "

The offset (if specified in the request).

", "modelRef": "#/components/schemas/PaginationOffsetOptional", "customType": "PaginationOffsetOptional", "schema": [] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "schema": [ { "name": "prev", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the previous page; only present if offset is greater than 0.

", "example": "", "format": "uri" }, { "name": "self", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the current page.

", "example": "", "format": "uri" }, { "name": "next", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the next page; only present if offset + limit is less than the total number of elements.

", "example": "", "format": "uri" } ] } ] }, { "name": "natgateways", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/NatGateways", "customType": "NatGateways", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "readOnly": true, "description": "Array of items in the collection.", "modelRef": "#/components/schemas/NatGateway", "customType": "NatGateway[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "metadata", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/DatacenterElementMetadata", "customType": "DatacenterElementMetadata", "schema": [ { "name": "etag", "kind": "optional", "type": "string", "readOnly": true, "description": "

Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter.

", "example": "45480eb3fbfc31f1d916c1eaa4abdcc3" }, { "name": "createdDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was created.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "createdBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who created the resource.", "example": "user@example.com" }, { "name": "createdByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who created the resource.", "example": "user@example.com" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was modified.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "lastModifiedBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who last modified the resource.", "example": "user@example.com" }, { "name": "lastModifiedByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who last modified the resource.", "example": "63cef532-26fe-4a64-a4e0-de7c8a506c90" }, { "name": "state", "kind": "optional", "type": "string", "readOnly": true, "description": "

State of the resource. AVAILABLE There are no pending modification requests for this item; BUSY There is at least one modification request pending and all following requests will be queued; INACTIVE Resource has been de-provisioned; DEPLOYING Resource state DEPLOYING - relevant for Kubernetes cluster/nodepool; ACTIVE Resource state ACTIVE - relevant for Kubernetes cluster/nodepool; FAILED Resource state FAILED - relevant for Kubernetes cluster/nodepool; SUSPENDED Resource state SUSPENDED - relevant for Kubernetes cluster/nodepool; FAILED_SUSPENDED Resource state FAILED_SUSPENDED - relevant for Kubernetes cluster; UPDATING Resource state UPDATING - relevant for Kubernetes cluster/nodepool; FAILED_UPDATING Resource state FAILED_UPDATING - relevant for Kubernetes cluster/nodepool; DESTROYING Resource state DESTROYING - relevant for Kubernetes cluster; FAILED_DESTROYING Resource state FAILED_DESTROYING - relevant for Kubernetes cluster/nodepool; TERMINATED Resource state TERMINATED - relevant for Kubernetes cluster/nodepool; HIBERNATING Resource state HIBERNATING - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool; MAINTENANCE Resource state MAINTENANCE - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool.

", "example": "AVAILABLE", "enum": [ "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED", "HIBERNATING", "FAILED_HIBERNATING", "MAINTENANCE", "FAILED_MAINTENANCE", "UNKNOWN" ] } ] }, { "name": "properties", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/NatGatewayProperties", "customType": "NatGatewayProperties", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "Name of the NAT Gateway.", "example": "My NAT Gateway" }, { "name": "publicIps", "kind": "required", "type": "array", "description": "Collection of public IP addresses of the NAT Gateway. Should be customer reserved IP addresses in that location.", "example": "[\"81.173.1.2\",\"82.231.2.5\",\"92.221.2.4\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "lans", "kind": "optional", "type": "array", "description": "

Collection of LANs connected to the NAT Gateway. IPs must contain a valid subnet mask. If no IP is provided, the system will generate an IP with /24 subnet.

", "modelRef": "#/components/schemas/NatGatewayLanProperties", "customType": "NatGatewayLanProperties[]", "schema": [ { "name": "id", "kind": "required", "type": "integer", "description": "Id for the LAN connected to the NAT Gateway", "example": 3, "format": "int32" }, { "name": "gatewayIps", "kind": "optional", "type": "array", "description": "

Collection of gateway IP addresses of the NAT Gateway. Will be auto-generated if not provided. Should ideally be an IP belonging to the same subnet as the LAN

", "example": "[\"10.12.1.2/24\",\"10.11.2.5/24\",\"10.11.2.4\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] } ] }, { "name": "entities", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/NatGatewayEntities", "customType": "NatGatewayEntities", "schema": [ { "name": "rules", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/NatGatewayRules", "customType": "NatGatewayRules", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "readOnly": true, "description": "Array of items in the collection.", "modelRef": "#/components/schemas/NatGatewayRule", "customType": "NatGatewayRule[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "flowlogs", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/FlowLogs", "customType": "FlowLogs", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

The URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "readOnly": true, "description": "Array of items in the collection.", "modelRef": "#/components/schemas/FlowLog", "customType": "FlowLog[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "offset", "kind": "optional", "type": "number", "description": "

The offset (if specified in the request).

", "modelRef": "#/components/schemas/PaginationOffsetOptional", "customType": "PaginationOffsetOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] } ] }, { "name": "offset", "kind": "optional", "type": "number", "description": "

The offset (if specified in the request).

", "modelRef": "#/components/schemas/PaginationOffsetOptional", "customType": "PaginationOffsetOptional", "schema": [] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "schema": [ { "name": "prev", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the previous page; only present if offset is greater than 0.

", "example": "", "format": "uri" }, { "name": "self", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the current page.

", "example": "", "format": "uri" }, { "name": "next", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the next page; only present if offset + limit is less than the total number of elements.

", "example": "", "format": "uri" } ] } ] }, { "name": "securitygroups", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/SecurityGroups", "customType": "SecurityGroups", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

The URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "readOnly": true, "description": "Array of items in the collection.", "modelRef": "#/components/schemas/SecurityGroup", "customType": "SecurityGroup[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

The URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "metadata", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/DatacenterElementMetadata", "customType": "DatacenterElementMetadata", "schema": [ { "name": "etag", "kind": "optional", "type": "string", "readOnly": true, "description": "

Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter.

", "example": "45480eb3fbfc31f1d916c1eaa4abdcc3" }, { "name": "createdDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was created.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "createdBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who created the resource.", "example": "user@example.com" }, { "name": "createdByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who created the resource.", "example": "user@example.com" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was modified.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "lastModifiedBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who last modified the resource.", "example": "user@example.com" }, { "name": "lastModifiedByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who last modified the resource.", "example": "63cef532-26fe-4a64-a4e0-de7c8a506c90" }, { "name": "state", "kind": "optional", "type": "string", "readOnly": true, "description": "

State of the resource. AVAILABLE There are no pending modification requests for this item; BUSY There is at least one modification request pending and all following requests will be queued; INACTIVE Resource has been de-provisioned; DEPLOYING Resource state DEPLOYING - relevant for Kubernetes cluster/nodepool; ACTIVE Resource state ACTIVE - relevant for Kubernetes cluster/nodepool; FAILED Resource state FAILED - relevant for Kubernetes cluster/nodepool; SUSPENDED Resource state SUSPENDED - relevant for Kubernetes cluster/nodepool; FAILED_SUSPENDED Resource state FAILED_SUSPENDED - relevant for Kubernetes cluster; UPDATING Resource state UPDATING - relevant for Kubernetes cluster/nodepool; FAILED_UPDATING Resource state FAILED_UPDATING - relevant for Kubernetes cluster/nodepool; DESTROYING Resource state DESTROYING - relevant for Kubernetes cluster; FAILED_DESTROYING Resource state FAILED_DESTROYING - relevant for Kubernetes cluster/nodepool; TERMINATED Resource state TERMINATED - relevant for Kubernetes cluster/nodepool; HIBERNATING Resource state HIBERNATING - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool; MAINTENANCE Resource state MAINTENANCE - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool.

", "example": "AVAILABLE", "enum": [ "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED", "HIBERNATING", "FAILED_HIBERNATING", "MAINTENANCE", "FAILED_MAINTENANCE", "UNKNOWN" ] } ] }, { "name": "properties", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/SecurityGroupProperties", "customType": "SecurityGroupProperties", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "The name of the security group.", "example": "My security group", "maxLength": 60 }, { "name": "description", "kind": "optional", "type": "string", "description": "The description of the security group.", "example": "My security group description", "maxLength": 300 } ] }, { "name": "entities", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/SecurityGroupEntities", "customType": "SecurityGroupEntities", "schema": [ { "name": "rules", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/FirewallRules", "customType": "FirewallRules", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "readOnly": true, "description": "Array of items in the collection.", "modelRef": "#/components/schemas/FirewallRule", "customType": "FirewallRule[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "offset", "kind": "optional", "type": "number", "description": "

The offset (if specified in the request).

", "modelRef": "#/components/schemas/PaginationOffsetOptional", "customType": "PaginationOffsetOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "nics", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Nics", "customType": "Nics", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "description": "Array of items in the collection.", "modelRef": "#/components/schemas/Nic", "customType": "Nic[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "offset", "kind": "optional", "type": "number", "description": "

The offset (if specified in the request).

", "modelRef": "#/components/schemas/PaginationOffsetOptional", "customType": "PaginationOffsetOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "servers", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Servers", "customType": "Servers", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "readOnly": true, "description": "Array of items in the collection.", "modelRef": "#/components/schemas/Server", "customType": "Server[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "offset", "kind": "optional", "type": "number", "description": "

The offset (if specified in the request).

", "modelRef": "#/components/schemas/PaginationOffsetOptional", "customType": "PaginationOffsetOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] } ] }, { "name": "offset", "kind": "optional", "type": "number", "description": "

The offset (if specified in the request).

", "modelRef": "#/components/schemas/PaginationOffsetOptional", "customType": "PaginationOffsetOptional", "schema": [] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "schema": [ { "name": "prev", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the previous page; only present if offset is greater than 0.

", "example": "", "format": "uri" }, { "name": "self", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the current page.

", "example": "", "format": "uri" }, { "name": "next", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the next page; only present if offset + limit is less than the total number of elements.

", "example": "", "format": "uri" } ] } ] } ] } ], "modelRef": "#/components/schemas/Datacenter", "isExpanded": true } ] }, { "statusCode": "default", "description": "

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Error", "schema": [ { "name": "httpStatus", "kind": "optional", "type": "integer", "readOnly": true, "description": "HTTP status code of the operation.", "example": 400, "format": "int32" }, { "name": "messages", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/ErrorMessage", "customType": "ErrorMessage[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "readOnly": true, "description": "Application internal error code.", "example": "123" }, { "name": "message", "kind": "optional", "type": "string", "readOnly": true, "description": "

A human-readable message.

", "example": "Error message example." } ] } ], "modelRef": "#/components/schemas/Error", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "vxOCiVZUerYBUyKT2Iota", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}?pretty=true&depth=integer%3Cint32%3E' \\\n --header 'accept: application/json'" }, { "id": "Yyu4BXVCbdk4Gsd_X1DTK", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}?pretty=true&depth=integer\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "b5DPxWl4RfmWTWLi5bnFG", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}?pretty=true&depth=integer\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "HGIPwVqWrlPKFqUvQunw0", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}?pretty=true&depth=integer\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "vxOCiVZUerYBUyKT2Iota" }, "results": { "languages": [ { "id": "sc3QJHanBd3dIuowzosdt", "language": "200", "code": "// Successful operation\n{\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"metadata\": {\n \"etag\": \"45480eb3fbfc31f1d916c1eaa4abdcc3\",\n \"createdDate\": \"2015-12-04T14:34:09.809Z\",\n \"createdBy\": \"user@example.com\",\n \"createdByUserId\": \"user@example.com\",\n \"lastModifiedDate\": \"2015-12-04T14:34:09.809Z\",\n \"lastModifiedBy\": \"user@example.com\",\n \"lastModifiedByUserId\": \"63cef532-26fe-4a64-a4e0-de7c8a506c90\",\n \"state\": \"AVAILABLE\"\n },\n \"properties\": {\n \"name\": \"Production datacenter\",\n \"description\": \"My Production Datacenter\",\n \"location\": \"us/las\",\n \"version\": 8,\n \"features\": [\n \"\"\n ],\n \"secAuthProtection\": true,\n \"cpuArchitecture\": [\n {\n \"cpuFamily\": \"INTEL_ICELAKE\",\n \"maxCores\": 62,\n \"maxRam\": 245760,\n \"vendor\": \"AuthenticAMD\",\n \"enabledFeatures\": [\n \"\"\n ]\n }\n ],\n \"gpuArchitecture\": [\n {\n \"vendor\": \"NVIDIA\",\n \"model\": \"A100\"\n }\n ],\n \"ipv6CidrBlock\": \"2001:db8:b06d:8f00::/56\",\n \"defaultSecurityGroupId\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\"\n },\n \"entities\": {\n \"servers\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"items\": [\n {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"metadata\": {\n \"etag\": \"45480eb3fbfc31f1d916c1eaa4abdcc3\",\n \"createdDate\": \"2015-12-04T14:34:09.809Z\",\n \"createdBy\": \"user@example.com\",\n \"createdByUserId\": \"user@example.com\",\n \"lastModifiedDate\": \"2015-12-04T14:34:09.809Z\",\n \"lastModifiedBy\": \"user@example.com\",\n \"lastModifiedByUserId\": \"63cef532-26fe-4a64-a4e0-de7c8a506c90\",\n \"state\": \"AVAILABLE\"\n },\n \"properties\": {\n \"templateUuid\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"name\": \"My resource\",\n \"hostname\": \"myHostname\",\n \"cores\": 4,\n \"ram\": 4096,\n \"availabilityZone\": \"AUTO\",\n \"vmState\": \"RUNNING\",\n \"bootCdrom\": {},\n \"bootVolume\": {},\n \"cpuFamily\": \"INTEL_ICELAKE\",\n \"type\": \"CUBE\",\n \"enabledFeatures\": [\n \"\"\n ],\n \"placementGroupId\": \"\",\n \"nicMultiQueue\": true,\n \"maxNetworkBandwidth\": 6\n },\n \"entities\": {\n \"cdroms\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"items\": [\n {\n \"\": \"\"\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"\": \"\"\n }\n },\n \"volumes\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"items\": [\n {\n \"\": \"\"\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"\": \"\"\n }\n },\n \"nics\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"items\": [\n {\n \"\": \"\"\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"\": \"\"\n }\n },\n \"securitygroups\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"items\": [\n {\n \"\": \"\"\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"\": \"\"\n }\n },\n \"gpus\": {\n \"id\": \"25f67991-0f51-4efc-a8ad-ef1fb31a400c\",\n \"type\": {},\n \"href\": \"\",\n \"items\": [\n {\n \"\": \"\"\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"\": \"\"\n }\n }\n }\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"prev\": \"\",\n \"self\": \"\",\n \"next\": \"\"\n }\n },\n \"volumes\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"items\": [\n {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"metadata\": {\n \"etag\": \"45480eb3fbfc31f1d916c1eaa4abdcc3\",\n \"createdDate\": \"2015-12-04T14:34:09.809Z\",\n \"createdBy\": \"user@example.com\",\n \"createdByUserId\": \"user@example.com\",\n \"lastModifiedDate\": \"2015-12-04T14:34:09.809Z\",\n \"lastModifiedBy\": \"user@example.com\",\n \"lastModifiedByUserId\": \"63cef532-26fe-4a64-a4e0-de7c8a506c90\",\n \"state\": \"AVAILABLE\"\n },\n \"properties\": {\n \"name\": \"My resource\",\n \"type\": \"HDD\",\n \"size\": 100,\n \"availabilityZone\": \"AUTO\",\n \"image\": \"d6ad1576-fde9-4696-aa41-1ebd75bdaf49\",\n \"imagePassword\": \"mypass123\",\n \"sshKeys\": [\n \"\"\n ],\n \"bus\": \"VIRTIO\",\n \"licenceType\": \"LINUX\",\n \"applicationType\": \"MSSQL-2019-Standard\",\n \"cpuHotPlug\": true,\n \"ramHotPlug\": true,\n \"nicHotPlug\": true,\n \"nicHotUnplug\": true,\n \"discVirtioHotPlug\": true,\n \"discVirtioHotUnplug\": true,\n \"exposeSerial\": true,\n \"requireLegacyBios\": true,\n \"deviceNumber\": 3,\n \"pciSlot\": 7,\n \"backupunitId\": \"25f67991-0f51-4efc-a8ad-ef1fb31a481c\",\n \"userData\": \"\",\n \"bootServer\": \"25f67991-0f51-4efc-a8ad-ef1fb31a481c\",\n \"bootOrder\": \"AUTO\"\n }\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"prev\": \"\",\n \"self\": \"\",\n \"next\": \"\"\n }\n },\n \"loadbalancers\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"items\": [\n {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"metadata\": {\n \"etag\": \"45480eb3fbfc31f1d916c1eaa4abdcc3\",\n \"createdDate\": \"2015-12-04T14:34:09.809Z\",\n \"createdBy\": \"user@example.com\",\n \"createdByUserId\": \"user@example.com\",\n \"lastModifiedDate\": \"2015-12-04T14:34:09.809Z\",\n \"lastModifiedBy\": \"user@example.com\",\n \"lastModifiedByUserId\": \"63cef532-26fe-4a64-a4e0-de7c8a506c90\",\n \"state\": \"AVAILABLE\"\n },\n \"properties\": {\n \"name\": \"My resource\",\n \"ip\": \"22.231.113.64\",\n \"dhcp\": true\n },\n \"entities\": {\n \"balancednics\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"items\": [\n {\n \"\": \"\"\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"\": \"\"\n }\n }\n }\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"prev\": \"\",\n \"self\": \"\",\n \"next\": \"\"\n }\n },\n \"lans\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"items\": [\n {\n \"id\": \"5\",\n \"type\": {},\n \"href\": \"\",\n \"metadata\": {\n \"etag\": \"45480eb3fbfc31f1d916c1eaa4abdcc3\",\n \"createdDate\": \"2015-12-04T14:34:09.809Z\",\n \"createdBy\": \"user@example.com\",\n \"createdByUserId\": \"user@example.com\",\n \"lastModifiedDate\": \"2015-12-04T14:34:09.809Z\",\n \"lastModifiedBy\": \"user@example.com\",\n \"lastModifiedByUserId\": \"63cef532-26fe-4a64-a4e0-de7c8a506c90\",\n \"state\": \"AVAILABLE\"\n },\n \"properties\": {\n \"name\": \"My resource\",\n \"ipFailover\": [\n {\n \"ip\": \"192.18.2.231\",\n \"nicUuid\": \"3c11273c-b3e1-4ca3-8134-84fd2dd4ebec\"\n }\n ],\n \"ipv4CidrBlock\": \"10.8.130.0/23\",\n \"ipv6CidrBlock\": \"2001:db8:b06d:8f5a::/64\",\n \"pcc\": \"3c11273c-b3e1-4ca3-8134-84fd2dd4ebec\",\n \"public\": true,\n \"vni\": 123\n },\n \"entities\": {\n \"nics\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"items\": [\n {\n \"\": \"\"\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"\": \"\"\n }\n }\n }\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"prev\": \"\",\n \"self\": \"\",\n \"next\": \"\"\n }\n },\n \"networkloadbalancers\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"items\": [\n {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"metadata\": {\n \"etag\": \"45480eb3fbfc31f1d916c1eaa4abdcc3\",\n \"createdDate\": \"2015-12-04T14:34:09.809Z\",\n \"createdBy\": \"user@example.com\",\n \"createdByUserId\": \"user@example.com\",\n \"lastModifiedDate\": \"2015-12-04T14:34:09.809Z\",\n \"lastModifiedBy\": \"user@example.com\",\n \"lastModifiedByUserId\": \"63cef532-26fe-4a64-a4e0-de7c8a506c90\",\n \"state\": \"AVAILABLE\"\n },\n \"properties\": {\n \"name\": \"My Network Load Balancer\",\n \"listenerLan\": 1,\n \"ips\": [\n \"\"\n ],\n \"targetLan\": 2,\n \"lbPrivateIps\": [\n \"\"\n ],\n \"centralLogging\": true,\n \"loggingFormat\": \"%{+Q}o %{-Q}ci - - [%trg] %r %ST %B \\\"\\\" \\\"\\\" %cp %ms %ft %b %s %TR %Tw %Tc %Tr %Ta %tsc %ac %fc %bc %sc %rc %sq %bq %CC %CS %hrl %hsl\"\n },\n \"entities\": {\n \"flowlogs\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"items\": [\n {\n \"\": \"\"\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"\": \"\"\n }\n },\n \"forwardingrules\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"items\": [\n {\n \"\": \"\"\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"\": \"\"\n }\n }\n }\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"prev\": \"\",\n \"self\": \"\",\n \"next\": \"\"\n }\n },\n \"natgateways\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"items\": [\n {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"metadata\": {\n \"etag\": \"45480eb3fbfc31f1d916c1eaa4abdcc3\",\n \"createdDate\": \"2015-12-04T14:34:09.809Z\",\n \"createdBy\": \"user@example.com\",\n \"createdByUserId\": \"user@example.com\",\n \"lastModifiedDate\": \"2015-12-04T14:34:09.809Z\",\n \"lastModifiedBy\": \"user@example.com\",\n \"lastModifiedByUserId\": \"63cef532-26fe-4a64-a4e0-de7c8a506c90\",\n \"state\": \"AVAILABLE\"\n },\n \"properties\": {\n \"name\": \"My NAT Gateway\",\n \"publicIps\": [\n \"\"\n ],\n \"lans\": [\n {\n \"id\": 3,\n \"gatewayIps\": [\n \"\"\n ]\n }\n ]\n },\n \"entities\": {\n \"rules\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"items\": [\n {\n \"\": \"\"\n }\n ]\n },\n \"flowlogs\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"items\": [\n {\n \"\": \"\"\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"\": \"\"\n }\n }\n }\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"prev\": \"\",\n \"self\": \"\",\n \"next\": \"\"\n }\n },\n \"securitygroups\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"items\": [\n {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"metadata\": {\n \"etag\": \"45480eb3fbfc31f1d916c1eaa4abdcc3\",\n \"createdDate\": \"2015-12-04T14:34:09.809Z\",\n \"createdBy\": \"user@example.com\",\n \"createdByUserId\": \"user@example.com\",\n \"lastModifiedDate\": \"2015-12-04T14:34:09.809Z\",\n \"lastModifiedBy\": \"user@example.com\",\n \"lastModifiedByUserId\": \"63cef532-26fe-4a64-a4e0-de7c8a506c90\",\n \"state\": \"AVAILABLE\"\n },\n \"properties\": {\n \"name\": \"My security group\",\n \"description\": \"My security group description\"\n },\n \"entities\": {\n \"rules\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"items\": [\n {\n \"\": \"\"\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"\": \"\"\n }\n },\n \"nics\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"items\": [\n {\n \"\": \"\"\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"\": \"\"\n }\n },\n \"servers\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"items\": [\n {\n \"\": \"\"\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"\": \"\"\n }\n }\n }\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"prev\": \"\",\n \"self\": \"\",\n \"next\": \"\"\n }\n }\n }\n}" }, { "id": "KQ11Ol1J-zEDldHjF17Tk", "language": "default", "code": "// Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).\n{\n \"httpStatus\": 400,\n \"messages\": [\n {\n \"errorCode\": \"123\",\n \"message\": \"Error message example.\"\n }\n ]\n}" } ], "selectedLanguageId": "sc3QJHanBd3dIuowzosdt" } }, "children": [ { "text": "", "id": "W7UCCG8tfpQb7YNK-ARmc" } ] }