List requests

1 min

GET

https://api.ionos.com/cloudapi/v6/requests

List all API requests made by the current user.

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

depthinteger<int32>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

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

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

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

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

filter.etagstringFilter 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.requestStatusstringFilter 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.methodstringFilter 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.headersstringFilter 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.bodystringFilter 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.urlstringFilter 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<int32>The first element (from the complete list of the elements) to include in the response (used together with limit for pagination).

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

acceptstringGenerated from available response content types

X-Contract-Numberinteger<int32>Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

200Successful operation

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

curl --request GET \
     --url 'https://api.ionos.com/cloudapi/v6/requests?pretty=true&depth=integer%3Cint32%3E&offset=integer%3Cint32%3E&limit=1000' \
     --header 'accept: application/json'

Have a question?

Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.

To ask a question or participate in discussions, you'll need to authenticate first.