RequestsApi
All URIs are relative to https://api.ionos.com/cloudapi/v6
requestsFindById
requestsFindById(requestId, opts)
Retrieve requests
Retrieve the properties of the specified request.
Examples
Parameters
requestId
string
The unique ID of the request.
[default to undefined]
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
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
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
requestsGet
requestsGet(opts)
List requests
List all API requests.
Examples
Parameters
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
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
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]
filterStatus
string
Filter the list by request status [QUEUED, RUNNING, DONE, FAILED]. Filter is not affected by the depth query parameter.
[optional][default to undefined]
filterCreatedAfter
string
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.
[optional][default to undefined]
filterCreatedBefore
string
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.
[optional][default to undefined]
filterCreatedDate
string
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.
[optional][default to undefined]
filterCreatedBy
string
Filter the list to only include the requests that contain the createdBy, 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.
[optional][default to undefined]
filterEtag
string
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.
[optional][default to undefined]
filterRequestStatus
string
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.
[optional][default to undefined]
filterMethod
string
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.
[optional][default to undefined]
filterHeaders
string
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.
[optional][default to undefined]
filterBody
string
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.
[optional][default to undefined]
filterUrl
string
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.
[optional][default to undefined]
offset
number
The first element (from the complete list of the elements) to include in the response (used together with <b><i>limit</i></b> for pagination).
[optional][default to 0]
limit
number
The maximum number of elements to return (use together with offset for pagination).
[optional][default to 1000]
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
requestsStatusGet
requestsStatusGet(requestId, opts)
Retrieve request status
Retrieve the status of the specified request.
Examples
Parameters
requestId
string
The unique ID of the request.
[default to undefined]
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
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
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
Last updated