AI Model Hub for free till June 30, 2025.
Try now
Test nowLog inShare Feedback

IP blocks

List IP blocks

get

List all reserved IP blocks.

Authorizations
Query parameters
prettybooleanOptional

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

Default: true
depthinteger · int32 · max: 10Optional

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

Default: 0
offsetinteger · int32Optional

The first element (from the complete list of the elements) to include in the response (used together with limit for pagination).

Default: 0
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of elements to return (use together with offset for pagination).

Default: 100
Header parameters
X-Contract-Numberinteger · int32Optional

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

Responses
200
Successful operation
application/json
get
GET /cloudapi/v6/ipblocks HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "collection",
  "href": "<RESOURCE-URI>",
  "items": [
    {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "ipblock",
      "href": "<RESOURCE-URI>",
      "metadata": {
        "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
        "createdDate": "2015-12-04T14:34:09.809Z",
        "createdBy": "[email protected]",
        "createdByUserId": "[email protected]",
        "lastModifiedDate": "2015-12-04T14:34:09.809Z",
        "lastModifiedBy": "[email protected]",
        "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
        "state": "AVAILABLE"
      },
      "properties": {
        "ips": [
          "22.231.113.64",
          "22.231.113.65",
          "22.231.113.66"
        ],
        "location": "us/las",
        "size": 5,
        "name": "My resource",
        "ipConsumers": [
          {
            "ip": "192.18.2.11",
            "mac": "02:01:3f:52:6e:57",
            "nicId": "0e8ee463-1174-46f2-87ba-a5c79c14d8e5",
            "serverId": "e6a3466f-8d6e-4cb6-8001-f4e245f222b7",
            "serverName": "Unnamed Server",
            "datacenterId": "6e54a9ec-aace-4176-8ee4-1c3a704fccfc",
            "datacenterName": "IpConsumerDC",
            "k8sNodePoolUuid": "6e54a9ec-aace-4176-8ee4-1c3a704fcc12",
            "k8sClusterUuid": "6e54a9ec-aace-4176-8ee4-1c3a704fcc23"
          }
        ]
      }
    }
  ],
  "offset": 0,
  "limit": 1000,
  "_links": {
    "prev": "<PREVIOUS-PAGE-URI>",
    "self": "<THIS-PAGE-URI>",
    "next": "<NEXT-PAGE-URI>"
  }
}

Reserve a IP Block

post

Reserves a new IP block.

Authorizations
Query parameters
prettybooleanOptional

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

Default: true
depthinteger · int32 · max: 10Optional

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

Default: 0
Header parameters
X-Contract-Numberinteger · int32Optional

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

Body
idstringRead-onlyOptional

The resource's unique identifier.

Example: 15f67991-0f51-4efc-a8ad-ef1fb31a480c
typeall ofOptional

The type of object that has been created.

Example: ipblock
string · enumOptionalPossible values:
hrefstring · uriRead-onlyOptional

URL to the object representation (absolute path).

Example: <RESOURCE-URI>
Responses
202
Successful operation
application/json
post
POST /cloudapi/v6/ipblocks HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "type": "ipblock",
  "metadata": {},
  "properties": {
    "location": "us/las",
    "size": 5,
    "name": "My resource"
  }
}
{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "ipblock",
  "href": "<RESOURCE-URI>",
  "metadata": {
    "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
    "createdDate": "2015-12-04T14:34:09.809Z",
    "createdBy": "[email protected]",
    "createdByUserId": "[email protected]",
    "lastModifiedDate": "2015-12-04T14:34:09.809Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "state": "AVAILABLE"
  },
  "properties": {
    "ips": [
      "22.231.113.64",
      "22.231.113.65",
      "22.231.113.66"
    ],
    "location": "us/las",
    "size": 5,
    "name": "My resource",
    "ipConsumers": [
      {
        "ip": "192.18.2.11",
        "mac": "02:01:3f:52:6e:57",
        "nicId": "0e8ee463-1174-46f2-87ba-a5c79c14d8e5",
        "serverId": "e6a3466f-8d6e-4cb6-8001-f4e245f222b7",
        "serverName": "Unnamed Server",
        "datacenterId": "6e54a9ec-aace-4176-8ee4-1c3a704fccfc",
        "datacenterName": "IpConsumerDC",
        "k8sNodePoolUuid": "6e54a9ec-aace-4176-8ee4-1c3a704fcc12",
        "k8sClusterUuid": "6e54a9ec-aace-4176-8ee4-1c3a704fcc23"
      }
    ]
  }
}

Retrieve IP blocks

get

Retrieve the properties of the specified IP block.

Authorizations
Path parameters
ipblockIdstringRequired

The unique ID of the IP block.

Query parameters
prettybooleanOptional

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

Default: true
depthinteger · int32 · max: 10Optional

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

Default: 0
Header parameters
X-Contract-Numberinteger · int32Optional

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

Responses
200
Successful operation
application/json
get
GET /cloudapi/v6/ipblocks/{ipblockId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "ipblock",
  "href": "<RESOURCE-URI>",
  "metadata": {
    "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
    "createdDate": "2015-12-04T14:34:09.809Z",
    "createdBy": "[email protected]",
    "createdByUserId": "[email protected]",
    "lastModifiedDate": "2015-12-04T14:34:09.809Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "state": "AVAILABLE"
  },
  "properties": {
    "ips": [
      "22.231.113.64",
      "22.231.113.65",
      "22.231.113.66"
    ],
    "location": "us/las",
    "size": 5,
    "name": "My resource",
    "ipConsumers": [
      {
        "ip": "192.18.2.11",
        "mac": "02:01:3f:52:6e:57",
        "nicId": "0e8ee463-1174-46f2-87ba-a5c79c14d8e5",
        "serverId": "e6a3466f-8d6e-4cb6-8001-f4e245f222b7",
        "serverName": "Unnamed Server",
        "datacenterId": "6e54a9ec-aace-4176-8ee4-1c3a704fccfc",
        "datacenterName": "IpConsumerDC",
        "k8sNodePoolUuid": "6e54a9ec-aace-4176-8ee4-1c3a704fcc12",
        "k8sClusterUuid": "6e54a9ec-aace-4176-8ee4-1c3a704fcc23"
      }
    ]
  }
}

Modify a IP Block by ID

put

Modifies the properties of the specified IP block.

Authorizations
Path parameters
ipblockIdstringRequired

The unique ID of the IP block.

Query parameters
prettybooleanOptional

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

Default: true
depthinteger · int32 · max: 10Optional

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

Default: 0
Header parameters
X-Contract-Numberinteger · int32Optional

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

Body
idstringRead-onlyOptional

The resource's unique identifier.

Example: 15f67991-0f51-4efc-a8ad-ef1fb31a480c
typeall ofOptional

The type of object that has been created.

Example: ipblock
string · enumOptionalPossible values:
hrefstring · uriRead-onlyOptional

URL to the object representation (absolute path).

Example: <RESOURCE-URI>
Responses
202
Successful operation
application/json
put
PUT /cloudapi/v6/ipblocks/{ipblockId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "type": "ipblock",
  "metadata": {},
  "properties": {
    "location": "us/las",
    "size": 5,
    "name": "My resource"
  }
}
{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "ipblock",
  "href": "<RESOURCE-URI>",
  "metadata": {
    "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
    "createdDate": "2015-12-04T14:34:09.809Z",
    "createdBy": "[email protected]",
    "createdByUserId": "[email protected]",
    "lastModifiedDate": "2015-12-04T14:34:09.809Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "state": "AVAILABLE"
  },
  "properties": {
    "ips": [
      "22.231.113.64",
      "22.231.113.65",
      "22.231.113.66"
    ],
    "location": "us/las",
    "size": 5,
    "name": "My resource",
    "ipConsumers": [
      {
        "ip": "192.18.2.11",
        "mac": "02:01:3f:52:6e:57",
        "nicId": "0e8ee463-1174-46f2-87ba-a5c79c14d8e5",
        "serverId": "e6a3466f-8d6e-4cb6-8001-f4e245f222b7",
        "serverName": "Unnamed Server",
        "datacenterId": "6e54a9ec-aace-4176-8ee4-1c3a704fccfc",
        "datacenterName": "IpConsumerDC",
        "k8sNodePoolUuid": "6e54a9ec-aace-4176-8ee4-1c3a704fcc12",
        "k8sClusterUuid": "6e54a9ec-aace-4176-8ee4-1c3a704fcc23"
      }
    ]
  }
}

Delete IP blocks

delete

Remove the specified IP block.

Authorizations
Path parameters
ipblockIdstringRequired

The unique ID of the IP block.

Query parameters
prettybooleanOptional

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

Default: true
depthinteger · int32 · max: 10Optional

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

Default: 0
Header parameters
X-Contract-Numberinteger · int32Optional

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

Responses
202
Successful operation
delete
DELETE /cloudapi/v6/ipblocks/{ipblockId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

No content

Partially modify IP blocks

patch

Update the properties of the specified IP block.

Authorizations
Path parameters
ipblockIdstringRequired

The unique ID of the IP block.

Query parameters
prettybooleanOptional

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

Default: true
depthinteger · int32 · max: 10Optional

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

Default: 0
Header parameters
X-Contract-Numberinteger · int32Optional

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

Body
ipsstring[]Read-onlyOptional

Collection of IPs, associated with the IP Block.

Example: ["22.231.113.64","22.231.113.65","22.231.113.66"]
locationstringRequired

Location of that IP block. Property cannot be modified after it is created (disallowed in update requests).

Example: us/las
sizeinteger · int32Required

The size of the IP block.

Example: 5
namestringOptional

The name of the resource.

Example: My resource
Responses
202
Successful operation
application/json
patch
PATCH /cloudapi/v6/ipblocks/{ipblockId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "location": "us/las",
  "size": 5,
  "name": "My resource"
}
{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "ipblock",
  "href": "<RESOURCE-URI>",
  "metadata": {
    "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
    "createdDate": "2015-12-04T14:34:09.809Z",
    "createdBy": "[email protected]",
    "createdByUserId": "[email protected]",
    "lastModifiedDate": "2015-12-04T14:34:09.809Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "state": "AVAILABLE"
  },
  "properties": {
    "ips": [
      "22.231.113.64",
      "22.231.113.65",
      "22.231.113.66"
    ],
    "location": "us/las",
    "size": 5,
    "name": "My resource",
    "ipConsumers": [
      {
        "ip": "192.18.2.11",
        "mac": "02:01:3f:52:6e:57",
        "nicId": "0e8ee463-1174-46f2-87ba-a5c79c14d8e5",
        "serverId": "e6a3466f-8d6e-4cb6-8001-f4e245f222b7",
        "serverName": "Unnamed Server",
        "datacenterId": "6e54a9ec-aace-4176-8ee4-1c3a704fccfc",
        "datacenterName": "IpConsumerDC",
        "k8sNodePoolUuid": "6e54a9ec-aace-4176-8ee4-1c3a704fcc12",
        "k8sClusterUuid": "6e54a9ec-aace-4176-8ee4-1c3a704fcc23"
      }
    ]
  }
}
PreviousSnapshotsNextLANs

Was this helpful?