User management

List all users

get

List all the users in your account.

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

offsetinteger · int32Optional

The first element (from the complete list of the elements) to include in the response (used together with limit for pagination).

Default: 0

limitinteger · int32 · min: 1 · max: 100Optional

The maximum number of elements to return (use together with offset for pagination).

Default: 100

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/um/users HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "collection",
  "href": "<RESOURCE-URI>",
  "items": [
    {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "user",
      "href": "<RESOURCE-URI>",
      "metadata": {
        "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
        "createdDate": "2015-12-04T14:34:09.809Z",
        "createdBy": "[email protected]",
        "createdByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
        "lastModifiedDate": "2015-12-04T14:34:09.809Z",
        "lastModifiedBy": "[email protected]",
        "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
        "lastLogin": "2015-12-04T14:34:09.809Z"
      },
      "properties": {
        "firstname": "text",
        "lastname": "text",
        "email": "text",
        "administrator": true,
        "forceSecAuth": true,
        "secAuthActive": true,
        "s3CanonicalUserId": "text",
        "active": true
      },
      "entities": {
        "owns": {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "collection",
          "href": "https://<API_HOST>/cloudapi/v6/um/users/9b1b4c62-1466-11e7-87d3-d7bb7dac0087/owns",
          "items": [
            "[Circular Reference]"
          ]
        },
        "groups": {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "group",
          "href": "https://<API_HOST>/cloudapi/v6/um/users/9b1b4c62-1466-11e7-87d3-d7bb7dac0087/groups",
          "items": [
            "[Circular Reference]"
          ]
        }
      }
    }
  ],
  "offset": 0,
  "limit": 1000,
  "_links": {
    "prev": "<PREVIOUS-PAGE-URI>",
    "self": "<THIS-PAGE-URI>",
    "next": "<NEXT-PAGE-URI>"
  }
}

Create users

post

Create a user.

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.

Body

Responses

202

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

post

HTTPcURLJavaScriptPython

POST /cloudapi/v6/um/users HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 162

{
  "properties": {
    "firstname": "text",
    "lastname": "text",
    "email": "text",
    "administrator": true,
    "forceSecAuth": true,
    "secAuthActive": true,
    "password": "text",
    "active": true
  }
}

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "user",
  "href": "<RESOURCE-URI>",
  "metadata": {
    "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
    "createdDate": "2015-12-04T14:34:09.809Z",
    "createdBy": "[email protected]",
    "createdByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "lastModifiedDate": "2015-12-04T14:34:09.809Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "lastLogin": "2015-12-04T14:34:09.809Z"
  },
  "properties": {
    "firstname": "text",
    "lastname": "text",
    "email": "text",
    "administrator": true,
    "forceSecAuth": true,
    "secAuthActive": true,
    "s3CanonicalUserId": "text",
    "active": true
  },
  "entities": {
    "owns": {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "collection",
      "href": "https://<API_HOST>/cloudapi/v6/um/users/9b1b4c62-1466-11e7-87d3-d7bb7dac0087/owns",
      "items": [
        {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "group",
          "href": "https://<API_HOST>/cloudapi/v6/um/resources/datacenter/15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "metadata": {
            "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
            "createdDate": "2015-12-04T14:34:09.809Z",
            "createdBy": "[email protected]",
            "createdByUserId": "[email protected]",
            "lastModifiedDate": "2015-12-04T14:34:09.809Z",
            "lastModifiedBy": "[email protected]",
            "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
            "state": "AVAILABLE"
          },
          "properties": {
            "name": "text",
            "secAuthProtection": true
          },
          "entities": {
            "groups": "[Circular Reference]"
          }
        }
      ]
    },
    "groups": {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "group",
      "href": "https://<API_HOST>/cloudapi/v6/um/users/9b1b4c62-1466-11e7-87d3-d7bb7dac0087/groups",
      "items": [
        {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "group",
          "href": "https://<API_HOST>/cloudapi/v6/um/groups/15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "properties": {
            "name": "My resource",
            "createDatacenter": true,
            "createSnapshot": true,
            "reserveIp": true,
            "accessActivityLog": true,
            "createPcc": true,
            "s3Privilege": true,
            "createBackupUnit": true,
            "createInternetAccess": true,
            "createK8sCluster": true,
            "createFlowLog": true,
            "accessAndManageMonitoring": true,
            "accessAndManageCertificates": true,
            "manageDBaaS": true,
            "accessAndManageDns": true,
            "manageRegistry": true,
            "manageDataplatform": true,
            "accessAndManageLogging": true,
            "accessAndManageCdn": true,
            "accessAndManageVpn": true,
            "accessAndManageApiGateway": true,
            "accessAndManageKaas": true,
            "accessAndManageNetworkFileStorage": true,
            "accessAndManageAiModelHub": true,
            "accessAndManageIamResources": true,
            "createNetworkSecurityGroups": true
          },
          "entities": {
            "users": "[Circular Reference]",
            "resources": "[Circular Reference]"
          }
        }
      ]
    }
  }
}

Retrieve users

get

Retrieve user properties by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.

Authorizations

BasicAuthenticationTokenAuthentication

Path parameters

userIdstringRequired

The unique ID of the user.

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/um/users/{userId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "user",
  "href": "<RESOURCE-URI>",
  "metadata": {
    "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
    "createdDate": "2015-12-04T14:34:09.809Z",
    "createdBy": "[email protected]",
    "createdByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "lastModifiedDate": "2015-12-04T14:34:09.809Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "lastLogin": "2015-12-04T14:34:09.809Z"
  },
  "properties": {
    "firstname": "text",
    "lastname": "text",
    "email": "text",
    "administrator": true,
    "forceSecAuth": true,
    "secAuthActive": true,
    "s3CanonicalUserId": "text",
    "active": true
  },
  "entities": {
    "owns": {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "collection",
      "href": "https://<API_HOST>/cloudapi/v6/um/users/9b1b4c62-1466-11e7-87d3-d7bb7dac0087/owns",
      "items": [
        {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "group",
          "href": "https://<API_HOST>/cloudapi/v6/um/resources/datacenter/15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "metadata": {
            "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
            "createdDate": "2015-12-04T14:34:09.809Z",
            "createdBy": "[email protected]",
            "createdByUserId": "[email protected]",
            "lastModifiedDate": "2015-12-04T14:34:09.809Z",
            "lastModifiedBy": "[email protected]",
            "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
            "state": "AVAILABLE"
          },
          "properties": {
            "name": "text",
            "secAuthProtection": true
          },
          "entities": {
            "groups": "[Circular Reference]"
          }
        }
      ]
    },
    "groups": {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "group",
      "href": "https://<API_HOST>/cloudapi/v6/um/users/9b1b4c62-1466-11e7-87d3-d7bb7dac0087/groups",
      "items": [
        {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "group",
          "href": "https://<API_HOST>/cloudapi/v6/um/groups/15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "properties": {
            "name": "My resource",
            "createDatacenter": true,
            "createSnapshot": true,
            "reserveIp": true,
            "accessActivityLog": true,
            "createPcc": true,
            "s3Privilege": true,
            "createBackupUnit": true,
            "createInternetAccess": true,
            "createK8sCluster": true,
            "createFlowLog": true,
            "accessAndManageMonitoring": true,
            "accessAndManageCertificates": true,
            "manageDBaaS": true,
            "accessAndManageDns": true,
            "manageRegistry": true,
            "manageDataplatform": true,
            "accessAndManageLogging": true,
            "accessAndManageCdn": true,
            "accessAndManageVpn": true,
            "accessAndManageApiGateway": true,
            "accessAndManageKaas": true,
            "accessAndManageNetworkFileStorage": true,
            "accessAndManageAiModelHub": true,
            "accessAndManageIamResources": true,
            "createNetworkSecurityGroups": true
          },
          "entities": {
            "users": "[Circular Reference]",
            "resources": "[Circular Reference]"
          }
        }
      ]
    }
  }
}

Modify users

put

Modify the properties of the specified user.

Authorizations

BasicAuthenticationTokenAuthentication

Path parameters

userIdstringRequired

The unique ID of the user.

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.

Body

idstringOptional

The resource's unique identifier.

Example: 15f67991-0f51-4efc-a8ad-ef1fb31a480c

Responses

202

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

put

HTTPcURLJavaScriptPython

PUT /cloudapi/v6/um/users/{userId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 206

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "properties": {
    "firstname": "text",
    "lastname": "text",
    "email": "text",
    "password": "text",
    "administrator": true,
    "forceSecAuth": true,
    "secAuthActive": true,
    "active": true
  }
}

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "user",
  "href": "<RESOURCE-URI>",
  "metadata": {
    "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
    "createdDate": "2015-12-04T14:34:09.809Z",
    "createdBy": "[email protected]",
    "createdByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "lastModifiedDate": "2015-12-04T14:34:09.809Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "lastLogin": "2015-12-04T14:34:09.809Z"
  },
  "properties": {
    "firstname": "text",
    "lastname": "text",
    "email": "text",
    "administrator": true,
    "forceSecAuth": true,
    "secAuthActive": true,
    "s3CanonicalUserId": "text",
    "active": true
  },
  "entities": {
    "owns": {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "collection",
      "href": "https://<API_HOST>/cloudapi/v6/um/users/9b1b4c62-1466-11e7-87d3-d7bb7dac0087/owns",
      "items": [
        {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "group",
          "href": "https://<API_HOST>/cloudapi/v6/um/resources/datacenter/15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "metadata": {
            "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
            "createdDate": "2015-12-04T14:34:09.809Z",
            "createdBy": "[email protected]",
            "createdByUserId": "[email protected]",
            "lastModifiedDate": "2015-12-04T14:34:09.809Z",
            "lastModifiedBy": "[email protected]",
            "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
            "state": "AVAILABLE"
          },
          "properties": {
            "name": "text",
            "secAuthProtection": true
          },
          "entities": {
            "groups": "[Circular Reference]"
          }
        }
      ]
    },
    "groups": {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "group",
      "href": "https://<API_HOST>/cloudapi/v6/um/users/9b1b4c62-1466-11e7-87d3-d7bb7dac0087/groups",
      "items": [
        {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "group",
          "href": "https://<API_HOST>/cloudapi/v6/um/groups/15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "properties": {
            "name": "My resource",
            "createDatacenter": true,
            "createSnapshot": true,
            "reserveIp": true,
            "accessActivityLog": true,
            "createPcc": true,
            "s3Privilege": true,
            "createBackupUnit": true,
            "createInternetAccess": true,
            "createK8sCluster": true,
            "createFlowLog": true,
            "accessAndManageMonitoring": true,
            "accessAndManageCertificates": true,
            "manageDBaaS": true,
            "accessAndManageDns": true,
            "manageRegistry": true,
            "manageDataplatform": true,
            "accessAndManageLogging": true,
            "accessAndManageCdn": true,
            "accessAndManageVpn": true,
            "accessAndManageApiGateway": true,
            "accessAndManageKaas": true,
            "accessAndManageNetworkFileStorage": true,
            "accessAndManageAiModelHub": true,
            "accessAndManageIamResources": true,
            "createNetworkSecurityGroups": true
          },
          "entities": {
            "users": "[Circular Reference]",
            "resources": "[Circular Reference]"
          }
        }
      ]
    }
  }
}

Delete users

delete

Delete the specified user.

Authorizations

BasicAuthenticationTokenAuthentication

Path parameters

userIdstringRequired

The unique ID of the user.

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

202

Successful operation

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

delete

HTTPcURLJavaScriptPython

DELETE /cloudapi/v6/um/users/{userId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

No content

Retrieve group resources by user ID

get

Retrieve group resources of the user by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.

Authorizations

BasicAuthenticationTokenAuthentication

Path parameters

userIdstringRequired

The unique ID of the user.

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/um/users/{userId}/groups HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "collection",
  "href": "https://<API_HOST>/cloudapi/v6/um/groups/30740c22-1def-11e7-aac9-d7a3646ca7fd/resources",
  "items": [
    {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "group",
      "href": "https://<API_HOST>/cloudapi/v6/um/resources/datacenter/15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "metadata": {
        "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
        "createdDate": "2015-12-04T14:34:09.809Z",
        "createdBy": "[email protected]",
        "createdByUserId": "[email protected]",
        "lastModifiedDate": "2015-12-04T14:34:09.809Z",
        "lastModifiedBy": "[email protected]",
        "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
        "state": "AVAILABLE"
      },
      "properties": {
        "name": "text",
        "secAuthProtection": true
      },
      "entities": {
        "groups": {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "collection",
          "href": "https://<API_HOST>/cloudapi/v6/um/groups/30740c22-1def-11e7-aac9-d7a3646ca7fd/resources",
          "items": [
            "[Circular Reference]"
          ]
        }
      }
    }
  ]
}

Retrieve user resources by user ID

get

Retrieve own resources of the user by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.

Authorizations

BasicAuthenticationTokenAuthentication

Path parameters

userIdstringRequired

The unique ID of the user.

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/um/users/{userId}/owns HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "collection",
  "href": "https://<API_HOST>/cloudapi/v6/um/users/9b1b4c62-1466-11e7-87d3-d7bb7dac0087/owns",
  "items": [
    {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "group",
      "href": "https://<API_HOST>/cloudapi/v6/um/resources/datacenter/15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "metadata": {
        "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
        "createdDate": "2015-12-04T14:34:09.809Z",
        "createdBy": "[email protected]",
        "createdByUserId": "[email protected]",
        "lastModifiedDate": "2015-12-04T14:34:09.809Z",
        "lastModifiedBy": "[email protected]",
        "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
        "state": "AVAILABLE"
      },
      "properties": {
        "name": "text",
        "secAuthProtection": true
      },
      "entities": {
        "groups": {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "collection",
          "href": "https://<API_HOST>/cloudapi/v6/um/groups/30740c22-1def-11e7-aac9-d7a3646ca7fd/resources",
          "items": [
            "[Circular Reference]"
          ]
        }
      }
    }
  ]
}

List all groups

get

List all the available user groups.

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/um/groups HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "group",
  "href": "https://<API_HOST>/cloudapi/v6/um/groups",
  "items": [
    {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "group",
      "href": "https://<API_HOST>/cloudapi/v6/um/groups/15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "properties": {
        "name": "My resource",
        "createDatacenter": true,
        "createSnapshot": true,
        "reserveIp": true,
        "accessActivityLog": true,
        "createPcc": true,
        "s3Privilege": true,
        "createBackupUnit": true,
        "createInternetAccess": true,
        "createK8sCluster": true,
        "createFlowLog": true,
        "accessAndManageMonitoring": true,
        "accessAndManageCertificates": true,
        "manageDBaaS": true,
        "accessAndManageDns": true,
        "manageRegistry": true,
        "manageDataplatform": true,
        "accessAndManageLogging": true,
        "accessAndManageCdn": true,
        "accessAndManageVpn": true,
        "accessAndManageApiGateway": true,
        "accessAndManageKaas": true,
        "accessAndManageNetworkFileStorage": true,
        "accessAndManageAiModelHub": true,
        "accessAndManageIamResources": true,
        "createNetworkSecurityGroups": true
      },
      "entities": {
        "users": {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "collection",
          "href": "https://<API_HOST>/cloudapi/v6/um/groups/30740c22-1def-11e7-aac9-d7a3646ca7fd/users",
          "items": [
            "[Circular Reference]"
          ]
        },
        "resources": {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "collection",
          "href": "https://<API_HOST>/cloudapi/v6/um/groups/30740c22-1def-11e7-aac9-d7a3646ca7fd/resources",
          "items": [
            "[Circular Reference]"
          ]
        }
      }
    }
  ]
}

Create groups

post

Create a group.

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.

Body

idstringRead-onlyOptional

The resource's unique identifier.

Example: 15f67991-0f51-4efc-a8ad-ef1fb31a480c

typeall ofOptional

The type of the resource.

Example: group

string · enumOptionalPossible values:

hrefstring · uriRead-onlyOptional

URL to the object representation (absolute path).

Example: https://<API_HOST>/cloudapi/v6/um/groups/15f67991-0f51-4efc-a8ad-ef1fb31a480c

Responses

202

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

post

HTTPcURLJavaScriptPython

POST /cloudapi/v6/um/groups HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 797

{
  "type": "group",
  "properties": {
    "name": "My resource",
    "createDatacenter": true,
    "createSnapshot": true,
    "reserveIp": true,
    "accessActivityLog": true,
    "createPcc": true,
    "s3Privilege": true,
    "createBackupUnit": true,
    "createInternetAccess": true,
    "createK8sCluster": true,
    "createFlowLog": true,
    "accessAndManageMonitoring": true,
    "accessAndManageCertificates": true,
    "manageDBaaS": true,
    "accessAndManageDns": true,
    "manageRegistry": true,
    "manageDataplatform": true,
    "accessAndManageLogging": true,
    "accessAndManageCdn": true,
    "accessAndManageVpn": true,
    "accessAndManageApiGateway": true,
    "accessAndManageKaas": true,
    "accessAndManageNetworkFileStorage": true,
    "accessAndManageAiModelHub": true,
    "accessAndManageIamResources": true,
    "createNetworkSecurityGroups": true
  },
  "entities": {
    "users": {
      "type": "collection"
    },
    "resources": {
      "type": "collection"
    }
  }
}

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "group",
  "href": "https://<API_HOST>/cloudapi/v6/um/groups/15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "properties": {
    "name": "My resource",
    "createDatacenter": true,
    "createSnapshot": true,
    "reserveIp": true,
    "accessActivityLog": true,
    "createPcc": true,
    "s3Privilege": true,
    "createBackupUnit": true,
    "createInternetAccess": true,
    "createK8sCluster": true,
    "createFlowLog": true,
    "accessAndManageMonitoring": true,
    "accessAndManageCertificates": true,
    "manageDBaaS": true,
    "accessAndManageDns": true,
    "manageRegistry": true,
    "manageDataplatform": true,
    "accessAndManageLogging": true,
    "accessAndManageCdn": true,
    "accessAndManageVpn": true,
    "accessAndManageApiGateway": true,
    "accessAndManageKaas": true,
    "accessAndManageNetworkFileStorage": true,
    "accessAndManageAiModelHub": true,
    "accessAndManageIamResources": true,
    "createNetworkSecurityGroups": true
  },
  "entities": {
    "users": {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "collection",
      "href": "https://<API_HOST>/cloudapi/v6/um/groups/30740c22-1def-11e7-aac9-d7a3646ca7fd/users",
      "items": [
        {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "user",
          "href": "<RESOURCE-URI>",
          "metadata": {
            "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
            "createdDate": "2015-12-04T14:34:09.809Z",
            "createdBy": "[email protected]",
            "createdByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
            "lastModifiedDate": "2015-12-04T14:34:09.809Z",
            "lastModifiedBy": "[email protected]",
            "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
            "lastLogin": "2015-12-04T14:34:09.809Z"
          },
          "properties": {
            "firstname": "text",
            "lastname": "text",
            "email": "text",
            "administrator": true,
            "forceSecAuth": true,
            "secAuthActive": true,
            "s3CanonicalUserId": "text",
            "active": true
          },
          "entities": {
            "owns": "[Circular Reference]",
            "groups": "[Circular Reference]"
          }
        }
      ]
    },
    "resources": {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "collection",
      "href": "https://<API_HOST>/cloudapi/v6/um/groups/30740c22-1def-11e7-aac9-d7a3646ca7fd/resources",
      "items": [
        {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "group",
          "href": "https://<API_HOST>/cloudapi/v6/um/resources/datacenter/15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "metadata": {
            "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
            "createdDate": "2015-12-04T14:34:09.809Z",
            "createdBy": "[email protected]",
            "createdByUserId": "[email protected]",
            "lastModifiedDate": "2015-12-04T14:34:09.809Z",
            "lastModifiedBy": "[email protected]",
            "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
            "state": "AVAILABLE"
          },
          "properties": {
            "name": "text",
            "secAuthProtection": true
          },
          "entities": {
            "groups": "[Circular Reference]"
          }
        }
      ]
    }
  }
}

Retrieve groups

get

Retrieve a group by the group ID. This value is in the response body when the group is created, and in the list of the groups, returned by GET.

Authorizations

BasicAuthenticationTokenAuthentication

Path parameters

groupIdstringRequired

The unique ID of the group.

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/um/groups/{groupId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "group",
  "href": "https://<API_HOST>/cloudapi/v6/um/groups/15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "properties": {
    "name": "My resource",
    "createDatacenter": true,
    "createSnapshot": true,
    "reserveIp": true,
    "accessActivityLog": true,
    "createPcc": true,
    "s3Privilege": true,
    "createBackupUnit": true,
    "createInternetAccess": true,
    "createK8sCluster": true,
    "createFlowLog": true,
    "accessAndManageMonitoring": true,
    "accessAndManageCertificates": true,
    "manageDBaaS": true,
    "accessAndManageDns": true,
    "manageRegistry": true,
    "manageDataplatform": true,
    "accessAndManageLogging": true,
    "accessAndManageCdn": true,
    "accessAndManageVpn": true,
    "accessAndManageApiGateway": true,
    "accessAndManageKaas": true,
    "accessAndManageNetworkFileStorage": true,
    "accessAndManageAiModelHub": true,
    "accessAndManageIamResources": true,
    "createNetworkSecurityGroups": true
  },
  "entities": {
    "users": {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "collection",
      "href": "https://<API_HOST>/cloudapi/v6/um/groups/30740c22-1def-11e7-aac9-d7a3646ca7fd/users",
      "items": [
        {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "user",
          "href": "<RESOURCE-URI>",
          "metadata": {
            "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
            "createdDate": "2015-12-04T14:34:09.809Z",
            "createdBy": "[email protected]",
            "createdByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
            "lastModifiedDate": "2015-12-04T14:34:09.809Z",
            "lastModifiedBy": "[email protected]",
            "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
            "lastLogin": "2015-12-04T14:34:09.809Z"
          },
          "properties": {
            "firstname": "text",
            "lastname": "text",
            "email": "text",
            "administrator": true,
            "forceSecAuth": true,
            "secAuthActive": true,
            "s3CanonicalUserId": "text",
            "active": true
          },
          "entities": {
            "owns": "[Circular Reference]",
            "groups": "[Circular Reference]"
          }
        }
      ]
    },
    "resources": {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "collection",
      "href": "https://<API_HOST>/cloudapi/v6/um/groups/30740c22-1def-11e7-aac9-d7a3646ca7fd/resources",
      "items": [
        {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "group",
          "href": "https://<API_HOST>/cloudapi/v6/um/resources/datacenter/15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "metadata": {
            "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
            "createdDate": "2015-12-04T14:34:09.809Z",
            "createdBy": "[email protected]",
            "createdByUserId": "[email protected]",
            "lastModifiedDate": "2015-12-04T14:34:09.809Z",
            "lastModifiedBy": "[email protected]",
            "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
            "state": "AVAILABLE"
          },
          "properties": {
            "name": "text",
            "secAuthProtection": true
          },
          "entities": {
            "groups": "[Circular Reference]"
          }
        }
      ]
    }
  }
}

Modify groups

put

Modify the properties of the specified group.

Authorizations

BasicAuthenticationTokenAuthentication

Path parameters

groupIdstringRequired

The unique ID of the group.

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.

Body

idstringRead-onlyOptional

The resource's unique identifier.

Example: 15f67991-0f51-4efc-a8ad-ef1fb31a480c

typeall ofOptional

The type of the resource.

Example: group

string · enumOptionalPossible values:

hrefstring · uriRead-onlyOptional

URL to the object representation (absolute path).

Example: https://<API_HOST>/cloudapi/v6/um/groups/15f67991-0f51-4efc-a8ad-ef1fb31a480c

Responses

202

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

put

HTTPcURLJavaScriptPython

PUT /cloudapi/v6/um/groups/{groupId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 797

{
  "type": "group",
  "properties": {
    "name": "My resource",
    "createDatacenter": true,
    "createSnapshot": true,
    "reserveIp": true,
    "accessActivityLog": true,
    "createPcc": true,
    "s3Privilege": true,
    "createBackupUnit": true,
    "createInternetAccess": true,
    "createK8sCluster": true,
    "createFlowLog": true,
    "accessAndManageMonitoring": true,
    "accessAndManageCertificates": true,
    "manageDBaaS": true,
    "accessAndManageDns": true,
    "manageRegistry": true,
    "manageDataplatform": true,
    "accessAndManageLogging": true,
    "accessAndManageCdn": true,
    "accessAndManageVpn": true,
    "accessAndManageApiGateway": true,
    "accessAndManageKaas": true,
    "accessAndManageNetworkFileStorage": true,
    "accessAndManageAiModelHub": true,
    "accessAndManageIamResources": true,
    "createNetworkSecurityGroups": true
  },
  "entities": {
    "users": {
      "type": "collection"
    },
    "resources": {
      "type": "collection"
    }
  }
}

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "group",
  "href": "https://<API_HOST>/cloudapi/v6/um/groups/15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "properties": {
    "name": "My resource",
    "createDatacenter": true,
    "createSnapshot": true,
    "reserveIp": true,
    "accessActivityLog": true,
    "createPcc": true,
    "s3Privilege": true,
    "createBackupUnit": true,
    "createInternetAccess": true,
    "createK8sCluster": true,
    "createFlowLog": true,
    "accessAndManageMonitoring": true,
    "accessAndManageCertificates": true,
    "manageDBaaS": true,
    "accessAndManageDns": true,
    "manageRegistry": true,
    "manageDataplatform": true,
    "accessAndManageLogging": true,
    "accessAndManageCdn": true,
    "accessAndManageVpn": true,
    "accessAndManageApiGateway": true,
    "accessAndManageKaas": true,
    "accessAndManageNetworkFileStorage": true,
    "accessAndManageAiModelHub": true,
    "accessAndManageIamResources": true,
    "createNetworkSecurityGroups": true
  },
  "entities": {
    "users": {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "collection",
      "href": "https://<API_HOST>/cloudapi/v6/um/groups/30740c22-1def-11e7-aac9-d7a3646ca7fd/users",
      "items": [
        {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "user",
          "href": "<RESOURCE-URI>",
          "metadata": {
            "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
            "createdDate": "2015-12-04T14:34:09.809Z",
            "createdBy": "[email protected]",
            "createdByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
            "lastModifiedDate": "2015-12-04T14:34:09.809Z",
            "lastModifiedBy": "[email protected]",
            "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
            "lastLogin": "2015-12-04T14:34:09.809Z"
          },
          "properties": {
            "firstname": "text",
            "lastname": "text",
            "email": "text",
            "administrator": true,
            "forceSecAuth": true,
            "secAuthActive": true,
            "s3CanonicalUserId": "text",
            "active": true
          },
          "entities": {
            "owns": "[Circular Reference]",
            "groups": "[Circular Reference]"
          }
        }
      ]
    },
    "resources": {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "collection",
      "href": "https://<API_HOST>/cloudapi/v6/um/groups/30740c22-1def-11e7-aac9-d7a3646ca7fd/resources",
      "items": [
        {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "group",
          "href": "https://<API_HOST>/cloudapi/v6/um/resources/datacenter/15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "metadata": {
            "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
            "createdDate": "2015-12-04T14:34:09.809Z",
            "createdBy": "[email protected]",
            "createdByUserId": "[email protected]",
            "lastModifiedDate": "2015-12-04T14:34:09.809Z",
            "lastModifiedBy": "[email protected]",
            "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
            "state": "AVAILABLE"
          },
          "properties": {
            "name": "text",
            "secAuthProtection": true
          },
          "entities": {
            "groups": "[Circular Reference]"
          }
        }
      ]
    }
  }
}

Delete groups

delete

Remove the specified group.

Authorizations

BasicAuthenticationTokenAuthentication

Path parameters

groupIdstringRequired

The unique ID of the group.

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

202

Successful operation

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

delete

HTTPcURLJavaScriptPython

DELETE /cloudapi/v6/um/groups/{groupId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

No content

Retrieve group resources

get

List the resources assigned to the group, by group ID.

Authorizations

BasicAuthenticationTokenAuthentication

Path parameters

groupIdstringRequired

The unique ID of the group.

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/um/groups/{groupId}/resources HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "collection",
  "href": "https://<API_HOST>/cloudapi/v6/um/groups/30740c22-1def-11e7-aac9-d7a3646ca7fd/resources",
  "items": [
    {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "group",
      "href": "https://<API_HOST>/cloudapi/v6/um/resources/datacenter/15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "metadata": {
        "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
        "createdDate": "2015-12-04T14:34:09.809Z",
        "createdBy": "[email protected]",
        "createdByUserId": "[email protected]",
        "lastModifiedDate": "2015-12-04T14:34:09.809Z",
        "lastModifiedBy": "[email protected]",
        "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
        "state": "AVAILABLE"
      },
      "properties": {
        "name": "text",
        "secAuthProtection": true
      },
      "entities": {
        "groups": {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "collection",
          "href": "https://<API_HOST>/cloudapi/v6/um/groups/30740c22-1def-11e7-aac9-d7a3646ca7fd/resources",
          "items": [
            "[Circular Reference]"
          ]
        }
      }
    }
  ]
}

List group members

get

List all members of the specified user group.

Authorizations

BasicAuthenticationTokenAuthentication

Path parameters

groupIdstringRequired

The unique ID of the group.

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/um/groups/{groupId}/users HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "collection",
  "href": "https://<API_HOST>/cloudapi/v6/um/groups/30740c22-1def-11e7-aac9-d7a3646ca7fd/users",
  "items": [
    {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "user",
      "href": "<RESOURCE-URI>",
      "metadata": {
        "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
        "createdDate": "2015-12-04T14:34:09.809Z",
        "createdBy": "[email protected]",
        "createdByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
        "lastModifiedDate": "2015-12-04T14:34:09.809Z",
        "lastModifiedBy": "[email protected]",
        "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
        "lastLogin": "2015-12-04T14:34:09.809Z"
      },
      "properties": {
        "firstname": "text",
        "lastname": "text",
        "email": "text",
        "administrator": true,
        "forceSecAuth": true,
        "secAuthActive": true,
        "s3CanonicalUserId": "text",
        "active": true
      },
      "entities": {
        "owns": {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "collection",
          "href": "https://<API_HOST>/cloudapi/v6/um/users/9b1b4c62-1466-11e7-87d3-d7bb7dac0087/owns",
          "items": [
            "[Circular Reference]"
          ]
        },
        "groups": {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "group",
          "href": "https://<API_HOST>/cloudapi/v6/um/users/9b1b4c62-1466-11e7-87d3-d7bb7dac0087/groups",
          "items": [
            "[Circular Reference]"
          ]
        }
      }
    }
  ]
}

Add a Group Member

post

Adds an existing user to the specified group.

Authorizations

BasicAuthenticationTokenAuthentication

Path parameters

groupIdstringRequired

The unique ID of the group.

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.

Body

idstringRequired

The resource's unique identifier.

Example: 15f67991-0f51-4efc-a8ad-ef1fb31a480c

Responses

202

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

post

HTTPcURLJavaScriptPython

POST /cloudapi/v6/um/groups/{groupId}/users HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c"
}

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "user",
  "href": "<RESOURCE-URI>",
  "metadata": {
    "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
    "createdDate": "2015-12-04T14:34:09.809Z",
    "createdBy": "[email protected]",
    "createdByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "lastModifiedDate": "2015-12-04T14:34:09.809Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "lastLogin": "2015-12-04T14:34:09.809Z"
  },
  "properties": {
    "firstname": "text",
    "lastname": "text",
    "email": "text",
    "administrator": true,
    "forceSecAuth": true,
    "secAuthActive": true,
    "s3CanonicalUserId": "text",
    "active": true
  },
  "entities": {
    "owns": {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "collection",
      "href": "https://<API_HOST>/cloudapi/v6/um/users/9b1b4c62-1466-11e7-87d3-d7bb7dac0087/owns",
      "items": [
        {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "group",
          "href": "https://<API_HOST>/cloudapi/v6/um/resources/datacenter/15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "metadata": {
            "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
            "createdDate": "2015-12-04T14:34:09.809Z",
            "createdBy": "[email protected]",
            "createdByUserId": "[email protected]",
            "lastModifiedDate": "2015-12-04T14:34:09.809Z",
            "lastModifiedBy": "[email protected]",
            "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
            "state": "AVAILABLE"
          },
          "properties": {
            "name": "text",
            "secAuthProtection": true
          },
          "entities": {
            "groups": "[Circular Reference]"
          }
        }
      ]
    },
    "groups": {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "group",
      "href": "https://<API_HOST>/cloudapi/v6/um/users/9b1b4c62-1466-11e7-87d3-d7bb7dac0087/groups",
      "items": [
        {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "group",
          "href": "https://<API_HOST>/cloudapi/v6/um/groups/15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "properties": {
            "name": "My resource",
            "createDatacenter": true,
            "createSnapshot": true,
            "reserveIp": true,
            "accessActivityLog": true,
            "createPcc": true,
            "s3Privilege": true,
            "createBackupUnit": true,
            "createInternetAccess": true,
            "createK8sCluster": true,
            "createFlowLog": true,
            "accessAndManageMonitoring": true,
            "accessAndManageCertificates": true,
            "manageDBaaS": true,
            "accessAndManageDns": true,
            "manageRegistry": true,
            "manageDataplatform": true,
            "accessAndManageLogging": true,
            "accessAndManageCdn": true,
            "accessAndManageVpn": true,
            "accessAndManageApiGateway": true,
            "accessAndManageKaas": true,
            "accessAndManageNetworkFileStorage": true,
            "accessAndManageAiModelHub": true,
            "accessAndManageIamResources": true,
            "createNetworkSecurityGroups": true
          },
          "entities": {
            "users": "[Circular Reference]",
            "resources": "[Circular Reference]"
          }
        }
      ]
    }
  }
}

Remove users from groups

delete

Remove the specified user from the group.

Authorizations

BasicAuthenticationTokenAuthentication

Path parameters

groupIdstringRequired

The unique ID of the group.

userIdstringRequired

The unique ID of the user.

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

202

Successful operation

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

delete

HTTPcURLJavaScriptPython

DELETE /cloudapi/v6/um/groups/{groupId}/users/{userId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

No content

Retrieve group shares

get

Retrieve the properties of the specified group share.

Authorizations

BasicAuthenticationTokenAuthentication

Path parameters

groupIdstringRequired

The unique ID of the group.

resourceIdstringRequired

The unique ID of the resource.

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/um/groups/{groupId}/shares/{resourceId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "resource",
  "href": "https://<API_HOST>/cloudapi/v6/um/groups/15f67991-0f51-4efc-a8ad-ef1fb31a480c/shares/17faab13-13abc-4efc-a8ad-ef1fb31a481b",
  "properties": {
    "editPrivilege": true,
    "sharePrivilege": true
  }
}

Add group shares

post

Add the specified share to the group.

Authorizations

BasicAuthenticationTokenAuthentication

Path parameters

groupIdstringRequired

The unique ID of the group.

resourceIdstringRequired

The unique ID of the resource.

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.

Body

idstringRead-onlyOptional

The resource's unique identifier.

Example: 15f67991-0f51-4efc-a8ad-ef1fb31a480c

typeall ofOptional

resource as generic type

Example: resource

string · enumOptionalPossible values:

hrefstring · uriRead-onlyOptional

URL to the object representation (absolute path).

Example: https://<API_HOST>/cloudapi/v6/um/groups/15f67991-0f51-4efc-a8ad-ef1fb31a480c/shares/17faab13-13abc-4efc-a8ad-ef1fb31a481b

Responses

202

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

post

HTTPcURLJavaScriptPython

POST /cloudapi/v6/um/groups/{groupId}/shares/{resourceId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: */*
Accept: */*
Content-Length: 77

{
  "type": "resource",
  "properties": {
    "editPrivilege": true,
    "sharePrivilege": true
  }
}

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "resource",
  "href": "https://<API_HOST>/cloudapi/v6/um/groups/15f67991-0f51-4efc-a8ad-ef1fb31a480c/shares/17faab13-13abc-4efc-a8ad-ef1fb31a481b",
  "properties": {
    "editPrivilege": true,
    "sharePrivilege": true
  }
}

Modify group share privileges

put

Modify share permissions for the specified group. With an empty body, no updates are performed, and the current share permissions for the group are returned with response code 200.

Authorizations

BasicAuthenticationTokenAuthentication

Path parameters

groupIdstringRequired

The unique ID of the group.

resourceIdstringRequired

The unique ID of the resource.

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.

Body

idstringRead-onlyOptional

The resource's unique identifier.

Example: 15f67991-0f51-4efc-a8ad-ef1fb31a480c

typeall ofOptional

resource as generic type

Example: resource

string · enumOptionalPossible values:

hrefstring · uriRead-onlyOptional

URL to the object representation (absolute path).

Example: https://<API_HOST>/cloudapi/v6/um/groups/15f67991-0f51-4efc-a8ad-ef1fb31a480c/shares/17faab13-13abc-4efc-a8ad-ef1fb31a481b

Responses

202

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

put

HTTPcURLJavaScriptPython

PUT /cloudapi/v6/um/groups/{groupId}/shares/{resourceId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "type": "resource",
  "properties": {
    "editPrivilege": true,
    "sharePrivilege": true
  }
}

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "resource",
  "href": "https://<API_HOST>/cloudapi/v6/um/groups/15f67991-0f51-4efc-a8ad-ef1fb31a480c/shares/17faab13-13abc-4efc-a8ad-ef1fb31a481b",
  "properties": {
    "editPrivilege": true,
    "sharePrivilege": true
  }
}

Remove group shares

delete

Remove the specified share from the group.

Authorizations

BasicAuthenticationTokenAuthentication

Path parameters

groupIdstringRequired

The unique ID of the group.

resourceIdstringRequired

The unique ID of the resource.

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

202

Successful operation

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

delete

HTTPcURLJavaScriptPython

DELETE /cloudapi/v6/um/groups/{groupId}/shares/{resourceId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

No content

List group shares

get

List all shares and share privileges for the specified group.

Authorizations

BasicAuthenticationTokenAuthentication

Path parameters

groupIdstringRequired

The unique ID of the group.

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/um/groups/{groupId}/shares HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "resource",
  "href": "https://<API_HOST>/cloudapi/v6/um/groups/15f67991-0f51-4efc-a8ad-ef1fb31a480c/shares",
  "items": [
    {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "resource",
      "href": "https://<API_HOST>/cloudapi/v6/um/groups/15f67991-0f51-4efc-a8ad-ef1fb31a480c/shares/17faab13-13abc-4efc-a8ad-ef1fb31a481b",
      "properties": {
        "editPrivilege": true,
        "sharePrivilege": true
      }
    }
  ]
}

List all resources

get

List all the available resources.

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/um/resources HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "collection",
  "href": "https://<API_HOST>/cloudapi/v6/um/resources",
  "items": [
    {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "group",
      "href": "https://<API_HOST>/cloudapi/v6/um/resources/datacenter/15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "metadata": {
        "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
        "createdDate": "2015-12-04T14:34:09.809Z",
        "createdBy": "[email protected]",
        "createdByUserId": "[email protected]",
        "lastModifiedDate": "2015-12-04T14:34:09.809Z",
        "lastModifiedBy": "[email protected]",
        "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
        "state": "AVAILABLE"
      },
      "properties": {
        "name": "text",
        "secAuthProtection": true
      },
      "entities": {
        "groups": {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "collection",
          "href": "https://<API_HOST>/cloudapi/v6/um/groups/30740c22-1def-11e7-aac9-d7a3646ca7fd/resources",
          "items": [
            "[Circular Reference]"
          ]
        }
      }
    }
  ]
}

List resources by type

get

List all resources of the specified type.

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

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

Authorizations

BasicAuthenticationTokenAuthentication

Path parameters

resourceTypestringRequired

The resource type

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/um/resources/{resourceType} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "collection",
  "href": "https://<API_HOST>/cloudapi/v6/um/resources",
  "items": [
    {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "group",
      "href": "https://<API_HOST>/cloudapi/v6/um/resources/datacenter/15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "metadata": {
        "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
        "createdDate": "2015-12-04T14:34:09.809Z",
        "createdBy": "[email protected]",
        "createdByUserId": "[email protected]",
        "lastModifiedDate": "2015-12-04T14:34:09.809Z",
        "lastModifiedBy": "[email protected]",
        "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
        "state": "AVAILABLE"
      },
      "properties": {
        "name": "text",
        "secAuthProtection": true
      },
      "entities": {
        "groups": {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "collection",
          "href": "https://<API_HOST>/cloudapi/v6/um/groups/30740c22-1def-11e7-aac9-d7a3646ca7fd/resources",
          "items": [
            "[Circular Reference]"
          ]
        }
      }
    }
  ]
}

Retrieve resources by type

get

Retrieve a resource by the resource type and resource ID.

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

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

Authorizations

BasicAuthenticationTokenAuthentication

Path parameters

resourceTypestringRequired

The resource type

resourceIdstringRequired

The resource ID

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/um/resources/{resourceType}/{resourceId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "group",
  "href": "https://<API_HOST>/cloudapi/v6/um/resources/datacenter/15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "metadata": {
    "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
    "createdDate": "2015-12-04T14:34:09.809Z",
    "createdBy": "[email protected]",
    "createdByUserId": "[email protected]",
    "lastModifiedDate": "2015-12-04T14:34:09.809Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "state": "AVAILABLE"
  },
  "properties": {
    "name": "text",
    "secAuthProtection": true
  },
  "entities": {
    "groups": {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "collection",
      "href": "https://<API_HOST>/cloudapi/v6/um/groups/30740c22-1def-11e7-aac9-d7a3646ca7fd/resources",
      "items": [
        {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": "group",
          "href": "https://<API_HOST>/cloudapi/v6/um/resources/datacenter/15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "metadata": {
            "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
            "createdDate": "2015-12-04T14:34:09.809Z",
            "createdBy": "[email protected]",
            "createdByUserId": "[email protected]",
            "lastModifiedDate": "2015-12-04T14:34:09.809Z",
            "lastModifiedBy": "[email protected]",
            "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
            "state": "AVAILABLE"
          },
          "properties": {
            "name": "text",
            "secAuthProtection": true
          },
          "entities": {
            "groups": "[Circular Reference]"
          }
        }
      ]
    }
  }
}