--- title: Répertorier les ressources par type slug: repertorier-les-ressources-par-type docTags: createdAt: 2026-06-04T15:50:56.155Z --- { "id": "nkKfkdzGjb6n3uuHoS2-b", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.ionos.com/cloudapi/v6/um/resources/{resourceType}", "servers": [ { "url": "https://api.ionos.com/cloudapi/v6/um/resources/{resourceType}" } ], "name": "List resources by type", "description": "

List all resources of the specified type.

\n

Resource types are: {datacenter, snapshot, image, ipblock, pcc, backupunit, k8s}

\n

Resource types are in the list of resources, returned by GET.

", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "resourceType", "type": "string", "description": "The resource type" } ], "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. NOTE: The resource /um and its children support a maximum depth level of 1. It will provide you the entry points to specific user related resources. As these resources are partially servered by other service components, they must be retrieved explicitly. Any depth parameter beyond '?depth=1' will be deprecated by April 30, 2026.

", "default": 0, "format": "int32", "minimum": 0, "maximum": 1 } ], "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": "Collection to represent the resource.", "customType": "Resources", "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": "https:///cloudapi/v6/um/resources", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "readOnly": true, "description": "Array of items in the collection.", "modelRef": "#/components/schemas/Resource", "customType": "Resource[]", "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": "https:///cloudapi/v6/um/resources/datacenter/15f67991-0f51-4efc-a8ad-ef1fb31a480c", "format": "uri" }, { "name": "metadata", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/DatacenterElementMetadata", "customType": "DatacenterElementMetadata", "schema": [ { "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": "createdDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was created.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "createdBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who created the resource.", "example": "user@example.com" }, { "name": "createdByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who created the resource.", "example": "user@example.com" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was modified.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "lastModifiedBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who last modified the resource.", "example": "user@example.com" }, { "name": "lastModifiedByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who last modified the resource.", "example": "63cef532-26fe-4a64-a4e0-de7c8a506c90" }, { "name": "state", "kind": "optional", "type": "string", "readOnly": true, "description": "

State of the resource. AVAILABLE There are no pending modification requests for this item; BUSY There is at least one modification request pending and all following requests will be queued; INACTIVE Resource has been de-provisioned; DEPLOYING Resource state DEPLOYING - relevant for Kubernetes cluster/nodepool; ACTIVE Resource state ACTIVE - relevant for Kubernetes cluster/nodepool; FAILED Resource state FAILED - relevant for Kubernetes cluster/nodepool; SUSPENDED Resource state SUSPENDED - relevant for Kubernetes cluster/nodepool; FAILED_SUSPENDED Resource state FAILED_SUSPENDED - relevant for Kubernetes cluster; UPDATING Resource state UPDATING - relevant for Kubernetes cluster/nodepool; FAILED_UPDATING Resource state FAILED_UPDATING - relevant for Kubernetes cluster/nodepool; DESTROYING Resource state DESTROYING - relevant for Kubernetes cluster; FAILED_DESTROYING Resource state FAILED_DESTROYING - relevant for Kubernetes cluster/nodepool; TERMINATED Resource state TERMINATED - relevant for Kubernetes cluster/nodepool; HIBERNATING Resource state HIBERNATING - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool; MAINTENANCE Resource state MAINTENANCE - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool.

", "example": "AVAILABLE", "enum": [ "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED", "HIBERNATING", "FAILED_HIBERNATING", "MAINTENANCE", "FAILED_MAINTENANCE", "UNKNOWN" ] } ] }, { "name": "properties", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/ResourceProperties", "customType": "ResourceProperties", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "The name of the resource." }, { "name": "secAuthProtection", "kind": "optional", "type": "boolean", "description": "

Boolean value representing if the resource is multi factor protected or not e.g. using two factor protection. Currently only data centers and snapshots are allowed to be multi factor protected, The value of attribute if null is intentional and it means that the resource doesn't support multi factor protection at all.

", "example": true } ] }, { "name": "entities", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/ResourceEntities", "customType": "ResourceEntities", "schema": [ { "name": "groups", "kind": "optional", "type": "object", "description": "Resources assigned to this group.", "modelRef": "#/components/schemas/ResourceGroups", "customType": "ResourceGroups", "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": "https:///cloudapi/v6/um/groups/30740c22-1def-11e7-aac9-d7a3646ca7fd/resources", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "readOnly": true, "description": "Array of items in the collection.", "modelRef": "#/components/schemas/Resource", "customType": "Resource[]", "schema": [ { "name": "", "description": "", "customType": "Circular-Reference" } ] } ] } ] } ] } ], "modelRef": "#/components/schemas/Resources", "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": "RFvAvaA-5Ay0lrrLOMTfx", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://api.ionos.com/cloudapi/v6/um/resources/{resourceType}?pretty=true&depth=integer%3Cint32%3E' \\\n --header 'accept: application/json'" }, { "id": "gZHdlGzthCQehvYEsT2qW", "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/um/resources/{resourceType}?pretty=true&depth=integer\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "eptxo_IS4eQTvMPLSn5OW", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.ionos.com/cloudapi/v6/um/resources/{resourceType}?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": "qbn06mCwH3SeKNOwLSw8q", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.ionos.com/cloudapi/v6/um/resources/{resourceType}?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": "RFvAvaA-5Ay0lrrLOMTfx" }, "results": { "languages": [ { "id": "4K4WUGAPgNh5s_SKOy7SB", "language": "200", "code": "// Successful operation\n{\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"https:///cloudapi/v6/um/resources\",\n \"items\": [\n {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"https:///cloudapi/v6/um/resources/datacenter/15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"metadata\": {\n \"etag\": \"45480eb3fbfc31f1d916c1eaa4abdcc3\",\n \"createdDate\": \"2015-12-04T14:34:09.809Z\",\n \"createdBy\": \"user@example.com\",\n \"createdByUserId\": \"user@example.com\",\n \"lastModifiedDate\": \"2015-12-04T14:34:09.809Z\",\n \"lastModifiedBy\": \"user@example.com\",\n \"lastModifiedByUserId\": \"63cef532-26fe-4a64-a4e0-de7c8a506c90\",\n \"state\": \"AVAILABLE\"\n },\n \"properties\": {\n \"name\": \"\",\n \"secAuthProtection\": true\n },\n \"entities\": {\n \"groups\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"https:///cloudapi/v6/um/groups/30740c22-1def-11e7-aac9-d7a3646ca7fd/resources\",\n \"items\": [\n {\n \"\": \"\"\n }\n ]\n }\n }\n }\n ]\n}" }, { "id": "eZIXvXxTRRFd6vzd3eVOx", "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": "4K4WUGAPgNh5s_SKOy7SB" } }, "children": [ { "text": "", "id": "ylmIkYZxyOGjoSPqQpbtv" } ] }