Contract resources

Get Contract Information

get

Retrieves the properties of the user's contract. This operation allows you to obtain the resource limits and the general contract information.

Authorizations

BasicAuthenticationTokenAuthentication

Query parameters

prettybooleanOptional

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

Default: true

depthinteger · int32 · max: 10Optional

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

Default: 0

Header parameters

X-Contract-Numberinteger · int32Optional

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

Responses

200

Successful operation

application/json

default

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

application/json

get

HTTPcURLJavaScriptPython

GET /cloudapi/v6/contracts HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "contracts",
  "type": "collection",
  "href": "https://api.ionos.com/cloudapi/v6/contracts",
  "items": [
    {
      "type": "resource",
      "properties": {
        "contractNumber": 12345,
        "owner": "[email protected]",
        "status": "BILLABLE",
        "regDomain": "ionos.de",
        "resourceLimits": {
          "coresPerServer": 4,
          "coresPerContract": 8,
          "coresProvisioned": 7,
          "ramPerServer": 20480,
          "ramPerContract": 20480,
          "ramProvisioned": 14336,
          "hddLimitPerVolume": 614400,
          "hddLimitPerContract": 61440,
          "hddVolumeProvisioned": 10240,
          "ssdLimitPerVolume": 614400,
          "ssdLimitPerContract": 614400,
          "ssdVolumeProvisioned": 204800,
          "dasVolumeProvisioned": 51200,
          "reservableIps": 1,
          "reservedIpsOnContract": 1,
          "reservedIpsInUse": 0,
          "k8sClusterLimitTotal": 5,
          "k8sClustersProvisioned": 0,
          "nlbLimitTotal": 5,
          "nlbProvisioned": 0,
          "natGatewayLimitTotal": 5,
          "natGatewayProvisioned": 0,
          "securityGroupsPerVdc": 200,
          "securityGroupsPerResource": 10,
          "rulesPerSecurityGroup": 100
        }
      }
    }
  ]
}