--- title: Récupérer le statut de la demande slug: recuperer-le-statut-de-la-demande docTags: createdAt: 2026-06-04T15:50:56.155Z --- { "id": "P4qPmGABtvvoJHuB2OQKE", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.ionos.com/cloudapi/v6/requests/{requestId}/status", "servers": [ { "url": "https://api.ionos.com/cloudapi/v6/requests/{requestId}/status" } ], "name": "Retrieve request status", "description": "Retrieve the status of the specified request.", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "requestId", "type": "string", "description": "The unique ID of the request." } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "optional", "name": "X-Contract-Number", "type": "integer", "description": "

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

", "format": "int32" } ], "queryParameters": [ { "kind": "optional", "name": "pretty", "type": "boolean", "description": "

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

", "default": true }, { "kind": "optional", "name": "depth", "type": "integer", "description": "

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

", "default": 0, "format": "int32", "minimum": 0, "maximum": 10 } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "BasicAuthentication", "name": "BasicAuthentication", "kind": "optional", "type": "http", "description": "

You will need to base64 encode the string containing your credentials. \nNote:\n\n

", "scheme": "basic" }, { "id": "TokenAuthentication", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successful operation", "jsonExample": "", "isExpanded": true, "headers": [ { "kind": "optional", "name": "X-RateLimit-Remaining", "type": "integer", "description": "The number of requests that can still be made without triggering a failure response.", "format": "int32" }, { "kind": "optional", "name": "X-RateLimit-Limit", "type": "integer", "description": "The average number of requests per minute allowed.", "format": "int32" }, { "kind": "optional", "name": "X-RateLimit-Burst", "type": "integer", "description": "The maximum number of concurrent API requests allowed.", "format": "int32" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "RequestStatus", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "metadata", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/RequestStatusMetadata", "customType": "RequestStatusMetadata", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "", "enum": [ "QUEUED", "RUNNING", "DONE", "FAILED" ] }, { "name": "message", "kind": "optional", "type": "string", "description": "" }, { "name": "etag", "kind": "optional", "type": "string", "readOnly": true, "description": "

Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter.

", "example": "45480eb3fbfc31f1d916c1eaa4abdcc3" }, { "name": "targets", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/RequestTarget", "customType": "RequestTarget[]", "schema": [ { "name": "target", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/ResourceReference", "customType": "ResourceReference", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "The resource's unique identifier." }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" } ] }, { "name": "status", "kind": "optional", "type": "string", "description": "", "enum": [ "QUEUED", "RUNNING", "DONE", "FAILED" ] } ] } ] } ], "modelRef": "#/components/schemas/RequestStatus", "isExpanded": true } ] }, { "statusCode": "default", "description": "

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

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Error", "schema": [ { "name": "httpStatus", "kind": "optional", "type": "integer", "readOnly": true, "description": "HTTP status code of the operation.", "example": 400, "format": "int32" }, { "name": "messages", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/ErrorMessage", "customType": "ErrorMessage[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "readOnly": true, "description": "Application internal error code.", "example": "123" }, { "name": "message", "kind": "optional", "type": "string", "readOnly": true, "description": "

A human-readable message.

", "example": "Error message example." } ] } ], "modelRef": "#/components/schemas/Error", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "yHpINmOmjsevXR-ofYYWa", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://api.ionos.com/cloudapi/v6/requests/{requestId}/status?pretty=true&depth=integer%3Cint32%3E' \\\n --header 'accept: application/json'" }, { "id": "h218n2mxWLVQvdzIhiPpv", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.ionos.com/cloudapi/v6/requests/{requestId}/status?pretty=true&depth=integer\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "Sml3mFAYkKbDCTUMPw2Tb", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.ionos.com/cloudapi/v6/requests/{requestId}/status?pretty=true&depth=integer\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "wFZpWyn9_Y66CsSs-BRSk", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.ionos.com/cloudapi/v6/requests/{requestId}/status?pretty=true&depth=integer\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "yHpINmOmjsevXR-ofYYWa" }, "results": { "languages": [ { "id": "ITaiCNIBoVj8liH0LIbmo", "language": "200", "code": "// Successful operation\n{\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"metadata\": {\n \"status\": \"\",\n \"message\": \"\",\n \"etag\": \"45480eb3fbfc31f1d916c1eaa4abdcc3\",\n \"targets\": [\n {\n \"target\": {\n \"id\": \"\",\n \"type\": {},\n \"href\": \"\"\n },\n \"status\": \"\"\n }\n ]\n }\n}" }, { "id": "1v4PJ6EVBsgdpyCc34Ysy", "language": "default", "code": "// 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).\n{\n \"httpStatus\": 400,\n \"messages\": [\n {\n \"errorCode\": \"123\",\n \"message\": \"Error message example.\"\n }\n ]\n}" } ], "selectedLanguageId": "ITaiCNIBoVj8liH0LIbmo" } }, "children": [ { "text": "", "id": "xtNLuYtcLxDCt1UFK280S" } ] }