Requests

Retrieve requests

get

Retrieve the properties of the specified request.

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

Path parameters

requestIdstringRequired

The unique ID of the request.

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

default

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).

application/json

get

/requests/{requestId}

HTTPcURLJavaScriptPython

GET /cloudapi/v6/requests/{requestId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "request",
  "href": "<RESOURCE-URI>",
  "metadata": {
    "createdDate": "2015-12-04T14:34:09.809Z",
    "createdBy": "[email protected]",
    "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
    "requestStatus": {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "request-status",
      "href": "<RESOURCE-URI>",
      "metadata": {
        "status": "QUEUED",
        "message": "text",
        "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
        "targets": [
          {
            "target": {
              "id": "text",
              "type": "resource",
              "href": "<RESOURCE-URI>"
            },
            "status": "QUEUED"
          }
        ]
      }
    }
  },
  "properties": {
    "method": "text",
    "headers": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "body": "text",
    "url": "text"
  }
}

List requests

get

List all API requests made by the current user.

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

Query parameters

prettybooleanOptional

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

Default: true

depthinteger · int32 · max: 10Optional

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

Default: 0

filter.statusstringOptional

Filter the list by request status [QUEUED, RUNNING, DONE, FAILED]. Filter is not affected by the depth query parameter.

filter.createdAfterstringOptional

Filter the list to only include the requests created after the date, specified in the yyyy-MM-dd HH:mm:ss format. Filter is not affected by the depth query parameter.

filter.createdBeforestringOptional

Filter the list to only include the requests created before the date, specified in the yyyy-MM-dd HH:mm:ss format. Filter is not affected by the depth query parameter.

filter.createdDatestringOptional

Filter the list to only include the requests that contain the createdDate, specified in the yyyy-MM-dd HH:mm:ss format. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero.

filter.etagstringOptional

Filter the list to only include the requests that contain the specified etag. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero.

filter.requestStatusstringOptional

Filter the list to only include the requests that contain the specified requestStatus. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero.

filter.methodstringOptional

Filter the list to only include the requests that contain the specified method. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero.

filter.headersstringOptional

Filter the list to only include the requests that contain the specified headers. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero.

filter.bodystringOptional

Filter the list to only include the requests that contain the specified body. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero.

filter.urlstringOptional

Filter the list to only include the requests that contain the specified URL. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero.

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: 10000Optional

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

Default: 1000

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

default

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).

application/json

get

/requests

HTTPcURLJavaScriptPython

GET /cloudapi/v6/requests HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "requests",
  "type": "collection",
  "href": "<RESOURCE-URI>",
  "items": [
    {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "request",
      "href": "<RESOURCE-URI>",
      "metadata": {
        "createdDate": "2015-12-04T14:34:09.809Z",
        "createdBy": "[email protected]",
        "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
        "requestStatus": {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "request-status",
          "href": "<RESOURCE-URI>",
          "metadata": {
            "status": "QUEUED",
            "message": "text",
            "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
            "targets": [
              {
                "target": {
                  "id": "text",
                  "type": "resource",
                  "href": "<RESOURCE-URI>"
                },
                "status": "QUEUED"
              }
            ]
          }
        }
      },
      "properties": {
        "method": "text",
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "body": "text",
        "url": "text"
      }
    }
  ],
  "offset": 0,
  "limit": 1000,
  "_links": {
    "prev": "<PREVIOUS-PAGE-URI>",
    "self": "<THIS-PAGE-URI>",
    "next": "<NEXT-PAGE-URI>"
  }
}

Retrieve request status

get

Retrieve the status of the specified request.

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

Path parameters

requestIdstringRequired

The unique ID of the request.

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

default

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).

application/json

get

/requests/{requestId}/status

HTTPcURLJavaScriptPython

GET /cloudapi/v6/requests/{requestId}/status HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "request-status",
  "href": "<RESOURCE-URI>",
  "metadata": {
    "status": "QUEUED",
    "message": "text",
    "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
    "targets": [
      {
        "target": {
          "id": "text",
          "type": "resource",
          "href": "<RESOURCE-URI>"
        },
        "status": "QUEUED"
      }
    ]
  }
}