--- title: Obtenir les renseignements sur le contrat slug: obtenir-les-renseignements-sur-le-contrat docTags: createdAt: 2026-06-04T15:50:56.155Z --- { "id": "tTvg3AkGEXmj4p2b2tfQS", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.ionos.com/cloudapi/v6/contracts", "servers": [ { "url": "https://api.ionos.com/cloudapi/v6/contracts" } ], "name": "Get Contract Information", "description": "Retrieves the properties of the user's contract. This operation allows you to obtain the resource limits and the general contract information.", "contentType": "application/json", "request": { "pathParameters": [], "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": "Contracts", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "contracts" }, { "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": "

The URL to the object representation (absolute path).

", "example": "https://api.ionos.com/cloudapi/v6/contracts", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "readOnly": true, "description": "Array of items in the collection.", "modelRef": "#/components/schemas/Contract", "customType": "Contract[]", "schema": [ { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "properties", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/ContractProperties", "customType": "ContractProperties", "schema": [ { "name": "contractNumber", "kind": "optional", "type": "integer", "readOnly": true, "description": "The contract number.", "example": 12345, "format": "int64" }, { "name": "owner", "kind": "optional", "type": "string", "readOnly": true, "description": "The contract owner's user name.", "example": "user@example.com" }, { "name": "status", "kind": "optional", "type": "string", "readOnly": true, "description": "The contract status.", "example": "BILLABLE" }, { "name": "regDomain", "kind": "optional", "type": "string", "readOnly": true, "description": "The registration domain of the contract.", "example": "ionos.de" }, { "name": "resourceLimits", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/ResourceLimits", "customType": "ResourceLimits", "schema": [ { "name": "coresPerServer", "kind": "required", "type": "integer", "description": "The maximum number of CPU cores per server.", "example": 4, "format": "int32" }, { "name": "coresPerContract", "kind": "required", "type": "integer", "description": "The maximum number of CPU cores per contract.", "example": 8, "format": "int32" }, { "name": "coresProvisioned", "kind": "required", "type": "integer", "description": "The number of CPU cores provisioned.", "example": 7, "format": "int32" }, { "name": "ramPerServer", "kind": "required", "type": "integer", "description": "

The maximum amount of RAM (in MB) that can be provisioned for a particular server under this contract.

", "example": 20480, "format": "int32" }, { "name": "ramPerContract", "kind": "required", "type": "integer", "description": "

The maximum amount of RAM (in MB) that can be provisioned under this contract.

", "example": 20480, "format": "int32" }, { "name": "ramProvisioned", "kind": "required", "type": "integer", "description": "

The amount of RAM (in MB) provisioned under this contract.

", "example": 14336, "format": "int32" }, { "name": "hddLimitPerVolume", "kind": "required", "type": "integer", "description": "

The maximum size (in MB) of an idividual hard disk volume.

", "example": 614400, "format": "int64" }, { "name": "hddLimitPerContract", "kind": "required", "type": "integer", "description": "

The maximum amount of disk space (in MB) that can be provided under this contract.

", "example": 61440, "format": "int64" }, { "name": "hddVolumeProvisioned", "kind": "required", "type": "integer", "description": "

The amount of hard disk space (in MB) that is currently provisioned.

", "example": 10240, "format": "int64" }, { "name": "ssdLimitPerVolume", "kind": "required", "type": "integer", "description": "

The maximum size (in MB) of an individual solid state disk volume.

", "example": 614400, "format": "int64" }, { "name": "ssdLimitPerContract", "kind": "required", "type": "integer", "description": "

The maximum amount of solid state disk space (in MB) that can be provisioned under this contract.

", "example": 614400, "format": "int64" }, { "name": "ssdVolumeProvisioned", "kind": "required", "type": "integer", "description": "

The amount of solid state disk space (in MB) that is currently provisioned.

", "example": 204800, "format": "int64" }, { "name": "dasVolumeProvisioned", "kind": "required", "type": "integer", "description": "

The amount of DAS disk space (in MB) in a Cube server that is currently provisioned.

", "example": 51200, "format": "int64" }, { "name": "reservableIps", "kind": "required", "type": "integer", "description": "The maximum number of static public IP addresses that can be reserved by this customer across contracts.", "example": 1, "format": "int32" }, { "name": "reservedIpsOnContract", "kind": "required", "type": "integer", "description": "The maximum number of static public IP addresses that can be reserved for this contract.", "example": 1, "format": "int32" }, { "name": "reservedIpsInUse", "kind": "required", "type": "integer", "description": "The number of static public IP addresses in use.", "example": 0, "format": "int32" }, { "name": "k8sClusterLimitTotal", "kind": "required", "type": "integer", "description": "The maximum number of Kubernetes clusters that can be created under this contract.", "example": 5, "format": "int32" }, { "name": "k8sClustersProvisioned", "kind": "required", "type": "integer", "description": "The amount of Kubernetes clusters that is currently provisioned.", "example": 0, "format": "int32" }, { "name": "nlbLimitTotal", "kind": "required", "type": "integer", "description": "The NLB total limit.", "example": 5, "format": "int32" }, { "name": "nlbProvisioned", "kind": "required", "type": "integer", "description": "The NLBs provisioned.", "example": 0, "format": "int32" }, { "name": "natGatewayLimitTotal", "kind": "required", "type": "integer", "description": "The NAT Gateway total limit.", "example": 5, "format": "int32" }, { "name": "natGatewayProvisioned", "kind": "required", "type": "integer", "description": "The NAT Gateways provisioned.", "example": 0, "format": "int32" }, { "name": "securityGroupsPerVdc", "kind": "required", "type": "integer", "description": "The maximum number of security groups per VDC.", "example": 200, "format": "int32" }, { "name": "securityGroupsPerResource", "kind": "required", "type": "integer", "description": "

The maximum number of security groups that can be attached to a NIC or a VM individually. For example, a user can have maximum 10 security groups per NIC and 10 per VM.

", "example": 10, "format": "int32" }, { "name": "rulesPerSecurityGroup", "kind": "required", "type": "integer", "description": "The maximum number of rules per security group.", "example": 100, "format": "int32" } ] } ] } ] } ], "modelRef": "#/components/schemas/Contracts", "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": "Pmy1U10Kwz6pCsPYTF7Kk", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://api.ionos.com/cloudapi/v6/contracts?pretty=true&depth=integer%3Cint32%3E' \\\n --header 'accept: application/json'" }, { "id": "2PbgBwvsih7lp9F0xpZCQ", "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/contracts?pretty=true&depth=integer\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "fjE7gVaHifj10JGA-C67P", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.ionos.com/cloudapi/v6/contracts?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": "E9IhT1eaIfiLLzXWUtvSE", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.ionos.com/cloudapi/v6/contracts?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": "Pmy1U10Kwz6pCsPYTF7Kk" }, "results": { "languages": [ { "id": "W0dQc4za-BUG7feYn2wBA", "language": "200", "code": "// Successful operation\n{\n \"id\": \"contracts\",\n \"type\": {},\n \"href\": \"https://api.ionos.com/cloudapi/v6/contracts\",\n \"items\": [\n {\n \"type\": {},\n \"properties\": {\n \"contractNumber\": 12345,\n \"owner\": \"user@example.com\",\n \"status\": \"BILLABLE\",\n \"regDomain\": \"ionos.de\",\n \"resourceLimits\": {\n \"coresPerServer\": 4,\n \"coresPerContract\": 8,\n \"coresProvisioned\": 7,\n \"ramPerServer\": 20480,\n \"ramPerContract\": 20480,\n \"ramProvisioned\": 14336,\n \"hddLimitPerVolume\": 614400,\n \"hddLimitPerContract\": 61440,\n \"hddVolumeProvisioned\": 10240,\n \"ssdLimitPerVolume\": 614400,\n \"ssdLimitPerContract\": 614400,\n \"ssdVolumeProvisioned\": 204800,\n \"dasVolumeProvisioned\": 51200,\n \"reservableIps\": 1,\n \"reservedIpsOnContract\": 1,\n \"reservedIpsInUse\": \"\",\n \"k8sClusterLimitTotal\": 5,\n \"k8sClustersProvisioned\": \"\",\n \"nlbLimitTotal\": 5,\n \"nlbProvisioned\": \"\",\n \"natGatewayLimitTotal\": 5,\n \"natGatewayProvisioned\": \"\",\n \"securityGroupsPerVdc\": 200,\n \"securityGroupsPerResource\": 10,\n \"rulesPerSecurityGroup\": 100\n }\n }\n }\n ]\n}" }, { "id": "w_lqz74DbJ1NtKxBXwG6A", "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": "W0dQc4za-BUG7feYn2wBA" } }, "children": [ { "text": "", "id": "zgNqjx84GAjCxPJ9naJ6E" } ] }