--- title: Joindre une liste de groupes de sécurité à un serveur slug: joindre-une-liste-de-groupes-de-securite-a-un-serveur docTags: createdAt: 2026-06-04T15:50:56.155Z --- { "id": "yeUvGtOlvgmNxiE6LC9PK", "type": "api-oas-v2", "data": { "method": "PUT", "url": "https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/servers/{serverId}/securitygroups", "servers": [ { "url": "https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/servers/{serverId}/securitygroups" } ], "name": "Attach a list of Security Groups to a Server", "description": "Updating the list of Security Groups attached to an existing server specified by its ID. Security Groups should already exist as part of the datacenter.", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "datacenterId", "type": "string", "description": "The unique ID of the data center." }, { "kind": "required", "name": "serverId", "type": "string", "description": "The unique ID of the server." } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "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. GET /datacenters/[ID]

\n", "default": 0, "format": "int32", "minimum": 0, "maximum": 10 } ], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "The list of server attached Security Groups IDs.", "customType": "ListOfIds", "schema": [ { "name": "ids", "kind": "required", "type": "array", "description": "The list of IDs", "example": "[\"ac51b8e4-050c-4941-b7cd-43923422fe6e\",\"ea737d87-8754-4a42-b97c-0b1a8f619de5\"]", "itemType": "string", "customType": "string[]", "itemExample": "15f67991-0f51-4efc-a8ad-ef1fb31a480c", "itemDefault": "" } ], "modelRef": "#/components/schemas/ListOfIds", "isExpanded": true } ], "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" }, { "kind": "optional", "name": "Location", "type": "string", "description": "Callback URL to poll async operation status.", "pattern": "https://[apiBaseUri]/requests/[requestId]/status" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "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": [] } ], "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": "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/FirewallruleProperties", "customType": "FirewallruleProperties", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "The name of the resource.", "example": "My resource" }, { "name": "protocol", "kind": "required", "type": "string", "description": "

The protocol for the rule. Property cannot be modified after it is created (disallowed in update requests).

", "example": "TCP", "enum": [ "TCP", "UDP", "ICMP", "ICMPv6", "GRE", "VRRP", "ESP", "AH", "ANY" ] }, { "name": "sourceMac", "kind": "optional", "type": "string", "nullable": true, "description": "

Only traffic originating from the respective MAC address is allowed. Valid format: aa:bb:cc:dd:ee

. Value null allows traffic from any MAC address.

", "example": "00:0a:95:9d:68:16" }, { "name": "ipVersion", "kind": "optional", "type": "string", "nullable": true, "description": "

The IP version for this rule. If sourceIp or targetIp are specified, you can omit this value - the IP version will then be deduced from the IP address(es) used; if you specify it anyway, it must match the specified IP address(es). If neither sourceIp nor targetIp are specified, this rule allows traffic only for the specified IP version. If neither sourceIp, targetIp nor ipVersion are specified, this rule will only allow IPv4 traffic.

", "example": "IPv4", "enum": [ "IPv4", "IPv6" ] }, { "name": "sourceIp", "kind": "optional", "type": "string", "nullable": true, "description": "

Only traffic originating from the respective IP address (or CIDR block) is allowed. Value null allows traffic from any IP address (according to the selected ipVersion).

", "example": "22.231.113.64" }, { "name": "targetIp", "kind": "optional", "type": "string", "nullable": true, "description": "

If the target NIC has multiple IP addresses, only the traffic directed to the respective IP address (or CIDR block) of the NIC is allowed. Value null allows traffic to any target IP address (according to the selected ipVersion).

", "example": "22.231.113.64" }, { "name": "icmpCode", "kind": "optional", "type": "integer", "nullable": true, "description": "

Defines the allowed code (from 0 to 254) if protocol ICMP or ICMPv6 is chosen. Value null allows all codes.

", "example": 0, "format": "int32", "minimum": 0, "maximum": 254 }, { "name": "icmpType", "kind": "optional", "type": "integer", "nullable": true, "description": "

Defines the allowed type (from 0 to 254) if the protocol ICMP or ICMPv6 is chosen. Value null allows all types.

", "example": 8, "format": "int32", "minimum": 0, "maximum": 254 }, { "name": "portRangeStart", "kind": "optional", "type": "integer", "description": "

Defines the start range of the allowed port (from 1 to 65535) if protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports.

", "example": 8, "format": "int32", "minimum": 1, "maximum": 65535 }, { "name": "portRangeEnd", "kind": "optional", "type": "integer", "description": "

Defines the end range of the allowed port (from 1 to 65535) if the protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd null to allow all ports.

", "example": 8, "format": "int32", "minimum": 1, "maximum": 65535 }, { "name": "type", "kind": "optional", "type": "string", "description": "

The type of the firewall rule. If not specified, the default INGRESS value is used.

", "example": "INGRESS", "enum": [ "INGRESS", "EGRESS" ] } ] } ] }, { "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": "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": [] } ], "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": "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/NicProperties", "customType": "NicProperties", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "The name of the resource.", "example": "My resource" }, { "name": "mac", "kind": "optional", "type": "string", "description": "The MAC address of the NIC.", "example": "00:0a:95:9d:68:16" }, { "name": "ips", "kind": "optional", "type": "array", "nullable": true, "description": "

Collection of IP addresses, assigned to the NIC. Explicitly assigned public IPs need to come from reserved IP blocks. Passing value null or empty array will assign an IP address automatically.

", "example": "[\"10.160.12.12\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "dhcp", "kind": "optional", "type": "boolean", "description": "Indicates if the NIC will reserve an IP using DHCP.", "example": true, "default": true }, { "name": "ipv6Ips", "kind": "optional", "type": "array", "nullable": true, "description": "

If this NIC is connected to an IPv6 enabled LAN then this property contains the IPv6 IP addresses of the NIC. The maximum number of IPv6 IP addresses per NIC is 50, if you need more, contact support. If you leave this property 'null' when adding a NIC, when changing the NIC's IPv6 CIDR block, when changing the LAN's IPv6 CIDR block or when moving the NIC to a different IPv6 enabled LAN, then we will automatically assign the same number of IPv6 addresses which you had before from the NICs new CIDR block. If you leave this property 'null' while not changing the CIDR block, the IPv6 IP addresses won't be changed either. You can also provide your own self choosen IPv6 addresses, which then must be inside the IPv6 CIDR block of this NIC.

", "example": "[\"2001:db8:b06d:8f5a:0609::1\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "ipv6CidrBlock", "kind": "optional", "type": "string", "nullable": true, "description": "

If this NIC is connected to an IPv6 enabled LAN then this property contains the /80 IPv6 CIDR block of the NIC. If you leave this property 'null' when adding a NIC to an IPv6-enabled LAN, then an IPv6 CIDR block will automatically be assigned to the NIC, but you can also specify an /80 IPv6 CIDR block for the NIC on your own, which must be inside the /64 IPv6 CIDR block of the LAN and unique. This value can only be set, if the LAN already has an IPv6 CIDR block assigned. An IPv6-enabled LAN is limited to a maximum of 65,536 NICs.

", "example": "2001:db8:b06d:8f5a:0609::/80" }, { "name": "dhcpv6", "kind": "optional", "type": "boolean", "nullable": true, "description": "Indicates if the NIC will receive an IPv6 using DHCP. It can be set to 'true' or 'false' only if this NIC is connected to an IPv6 enabled LAN.", "example": true, "default": true }, { "name": "lan", "kind": "required", "type": "integer", "description": "

The LAN ID the NIC will be on. If the LAN ID does not exist, it will be implicitly created.

", "example": 2, "format": "int32" }, { "name": "firewallActive", "kind": "optional", "type": "boolean", "description": "

Activate or deactivate the firewall. By default, an active firewall without any defined rules will block all incoming network traffic except for the firewall rules that explicitly allows certain protocols, IP addresses and ports.

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

The type of firewall rules that will be allowed on the NIC. If not specified, the default INGRESS value is used.

", "example": "INGRESS", "enum": [ "INGRESS", "EGRESS", "BIDIRECTIONAL" ] }, { "name": "deviceNumber", "kind": "optional", "type": "integer", "readOnly": true, "description": "

The Logical Unit Number (LUN) of the storage volume. Null if this NIC was created using Cloud API and no DCD changes were performed on the Datacenter.

", "example": 3, "format": "int32" }, { "name": "pciSlot", "kind": "optional", "type": "integer", "readOnly": true, "description": "The PCI slot number for the NIC.", "example": 7, "format": "int32" }, { "name": "vnet", "kind": "optional", "type": "string", "description": "

The vnet ID that belongs to this NIC; Requires system privileges, for internal usage only

", "example": "" } ] }, { "name": "entities", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/NicEntities", "customType": "NicEntities", "schema": [ { "name": "flowlogs", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/FlowLogs", "customType": "FlowLogs", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "firewallrules", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/FirewallRules", "customType": "FirewallRules", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "securitygroups", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/SecurityGroups", "customType": "SecurityGroups", "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": "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": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "bootVolume", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ResourceReference", "description": "", "modelRef": "#/components/schemas/ResourceReference", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "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": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "volumes", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/AttachedVolumes", "customType": "AttachedVolumes", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "nics", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Nics", "customType": "Nics", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "securitygroups", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/SecurityGroups", "customType": "SecurityGroups", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "gpus", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/GPUs", "customType": "GPUs", "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": "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/SecurityGroups", "isExpanded": true } ] }, { "statusCode": "default", "description": "

Any erroneous status code:\n400 (parse error),\n401 (auth error),\n402 (trial access),\n403 (insufficient privileges),\n404 (not found),\n405 (unsupported HTTP method),\n415 (unsupported content type),\n422 (validation error),\n429 (request rate limit exceeded),\n500 (server error),\nor 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": "nK2y4vV4eRSsqPTxL1GyY", "language": "curl", "label": "cURL", "code": "curl --request PUT \\\n --url 'https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/servers/{serverId}/securitygroups?pretty=true&depth=integer%3Cint32%3E' \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"ids\": []\n }'" }, { "id": "niza8V45m2bRVcwbBf3RV", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"ids\": []\n});\n\nvar requestOptions = {\n method: 'PUT',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/servers/{serverId}/securitygroups?pretty=true&depth=integer\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "LEjaeRxMdcRxFg396IwOr", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/servers/{serverId}/securitygroups?pretty=true&depth=integer\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Put.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"ids\": []\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "Og3YiSy3o7ZzwYPRItihj", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/servers/{serverId}/securitygroups?pretty=true&depth=integer\"\n\npayload = json.dumps({\n \"ids\": []\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PUT\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "nK2y4vV4eRSsqPTxL1GyY" }, "results": { "languages": [ { "id": "HX8bRrztOvhKOLZuKNsv2", "language": "200", "code": "// Successful operation\n{\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 \"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 \"protocol\": \"TCP\",\n \"sourceMac\": \"00:0a:95:9d:68:16\",\n \"ipVersion\": \"IPv4\",\n \"sourceIp\": \"22.231.113.64\",\n \"targetIp\": \"22.231.113.64\",\n \"icmpCode\": \"\",\n \"icmpType\": 8,\n \"portRangeStart\": 8,\n \"portRangeEnd\": 8,\n \"type\": \"INGRESS\"\n }\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"prev\": \"\",\n \"self\": \"\",\n \"next\": \"\"\n }\n },\n \"nics\": {\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 \"mac\": \"00:0a:95:9d:68:16\",\n \"ips\": [\n \"\"\n ],\n \"dhcp\": true,\n \"ipv6Ips\": [\n \"\"\n ],\n \"ipv6CidrBlock\": \"2001:db8:b06d:8f5a:0609::/80\",\n \"dhcpv6\": true,\n \"lan\": 2,\n \"firewallActive\": false,\n \"firewallType\": \"INGRESS\",\n \"deviceNumber\": 3,\n \"pciSlot\": 7,\n \"vnet\": \"\"\n },\n \"entities\": {\n \"flowlogs\": {\n \"\": \"\"\n },\n \"firewallrules\": {\n \"\": \"\"\n },\n \"securitygroups\": {\n \"\": \"\"\n }\n }\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"prev\": \"\",\n \"self\": \"\",\n \"next\": \"\"\n }\n },\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 \"\": \"\"\n },\n \"volumes\": {\n \"\": \"\"\n },\n \"nics\": {\n \"\": \"\"\n },\n \"securitygroups\": {\n \"\": \"\"\n },\n \"gpus\": {\n \"\": \"\"\n }\n }\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"prev\": \"\",\n \"self\": \"\",\n \"next\": \"\"\n }\n }\n }\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"prev\": \"\",\n \"self\": \"\",\n \"next\": \"\"\n }\n}" }, { "id": "NX9D0A8lDw6i-uPLUzcqe", "language": "default", "code": "// Any erroneous status code:\n400 (parse error),\n401 (auth error),\n402 (trial access),\n403 (insufficient privileges),\n404 (not found),\n405 (unsupported HTTP method),\n415 (unsupported content type),\n422 (validation error),\n429 (request rate limit exceeded),\n500 (server error),\nor 503 (maintenance).\n{\n \"httpStatus\": 400,\n \"messages\": [\n {\n \"errorCode\": \"123\",\n \"message\": \"Error message example.\"\n }\n ]\n}" } ], "selectedLanguageId": "HX8bRrztOvhKOLZuKNsv2" } }, "children": [ { "text": "", "id": "xg-RaDcEE2SRj4n8tJpWs" } ] }