Ips

A CDN edge IP information resource.

This tag groups all operations for ips.

Retrieve all Ips

get

This endpoint enables retrieving all Ips using pagination and optional filters.

Authorizations

Query parameters

offsetinteger · int32Optional

The first element (of the total list of elements) to include in the response. Use together with limit for pagination.

Default: 0Example: 0

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

The maximum number of elements to return. Use together with offset for pagination.

Default: 100Example: 100

Responses

200

Returned all requested Ips successfully.

application/json

Responseall of

and

400

### Bad Request The request send to the API was malformed.

application/json

401

### Unauthorized The request is missing authorization information or the authorization information provided are expired.

application/json

403

### Not Allowed The user issuing the request does not have the needed permissions.

application/json

429

### Too Many Requests The user has sent too many requests in a given amount of time.

application/json

500

### Internal Server Error An internal error occurred. We apologize for the inconvenience!

application/json

503

### Service Unavailable The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

### Unexpected Internal Server Error An unexpected internal error occurred. We apologize for the inconvenience!

application/json

get

GET /ips HTTP/1.1
Host: cdn.de-fra.ionos.com
Authorization: Bearer JWT
Accept: */*

{
  "id": "ad9aca4e-2ccd-508b-8c8f-c47e5104375e",
  "type": "collection",
  "href": "/ips",
  "items": [
    {
      "id": "96b6bdc3-57d6-5433-bde8-15929e828ea6",
      "type": "edgeserveripinfo",
      "href": "/ips/96b6bdc3-57d6-5433-bde8-15929e828ea6",
      "metadata": {},
      "properties": {
        "type": "ipv4",
        "cidr": "1.2.3.4",
        "description": "Content Distribution."
      }
    }
  ],
  "offset": 0,
  "limit": 42,
  "_links": {
    "prev": "http://PREVIOUS-PAGE-URI",
    "self": "http://THIS-PAGE-URI",
    "next": "http://NEXT-PAGE-URI"
  }
}

Retrieve EdgeServerIpInfo

get

Returns the EdgeServerIpInfo by ID.

Authorizations

Path parameters

idstring · uuidRequired

The ID (UUID) of the EdgeServerIpInfo.

Example: 96b6bdc3-57d6-5433-bde8-15929e828ea6

Responses

200

Getting EdgeServerIpInfo was successful.

application/json

400

### Bad Request The request send to the API was malformed.

application/json

401

### Unauthorized The request is missing authorization information or the authorization information provided are expired.

application/json

403

### Not Allowed The user issuing the request does not have the needed permissions.

application/json

404

### Not Found The resource that was requested could not be found.

application/json

429

### Too Many Requests The user has sent too many requests in a given amount of time.

application/json

500

### Internal Server Error An internal error occurred. We apologize for the inconvenience!

application/json

503

### Service Unavailable The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

### Unexpected Internal Server Error An unexpected internal error occurred. We apologize for the inconvenience!

application/json

get

GET /ips/{id} HTTP/1.1
Host: cdn.de-fra.ionos.com
Authorization: Bearer JWT
Accept: */*

{
  "id": "96b6bdc3-57d6-5433-bde8-15929e828ea6",
  "type": "edgeserveripinfo",
  "href": "/ips/96b6bdc3-57d6-5433-bde8-15929e828ea6",
  "metadata": {},
  "properties": {
    "type": "ipv4",
    "cidr": "1.2.3.4",
    "description": "Content Distribution."
  }
}

PreviousDistributions NextModels

Was this helpful?