Backup Service

List backup units

get

List all available backup units.

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

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

/backupunits

HTTPcURLJavaScriptPython

GET /cloudapi/v6/backupunits 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": "backupunit",
      "href": "<RESOURCE-URI>",
      "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": "BackupUnitName",
        "password": "mypass123",
        "email": "[email protected]"
      }
    }
  ]
}

Create backup units

post

Create a backup unit. Backup units are resources, same as storage volumes or snapshots; they can be shared through groups in User management.

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

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

application/json

idstringRead-onlyOptional

The resource's unique identifier.

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

typestring · enumRead-onlyOptional

The type of object that has been created.

Possible values:

hrefstring · uriRead-onlyOptional

URL to the object representation (absolute path).

Example: <RESOURCE-URI>

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

/backupunits

HTTPcURLJavaScriptPython

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

{
  "metadata": {},
  "properties": {
    "name": "BackupUnitName",
    "password": "mypass123",
    "email": "[email protected]"
  }
}

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "backupunit",
  "href": "<RESOURCE-URI>",
  "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": "BackupUnitName",
    "password": "mypass123",
    "email": "[email protected]"
  }
}

Retrieve backup units

get

Retrieve the properties of the specified backup unit.

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

Path parameters

backupunitIdstringRequired

The unique ID of the backup unit.

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

/backupunits/{backupunitId}

HTTPcURLJavaScriptPython

GET /cloudapi/v6/backupunits/{backupunitId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "backupunit",
  "href": "<RESOURCE-URI>",
  "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": "BackupUnitName",
    "password": "mypass123",
    "email": "[email protected]"
  }
}

Modify backup units

put

Modify the properties of the specified backup unit.

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

Path parameters

backupunitIdstringRequired

The unique ID of the backup unit.

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

application/json

idstringRead-onlyOptional

The resource's unique identifier.

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

typestring · enumRead-onlyOptional

The type of object that has been created.

Possible values:

hrefstring · uriRead-onlyOptional

URL to the object representation (absolute path).

Example: <RESOURCE-URI>

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

/backupunits/{backupunitId}

HTTPcURLJavaScriptPython

PUT /cloudapi/v6/backupunits/{backupunitId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "metadata": {},
  "properties": {
    "password": "mypass123",
    "email": "[email protected]"
  }
}

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "backupunit",
  "href": "<RESOURCE-URI>",
  "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": "BackupUnitName",
    "password": "mypass123",
    "email": "[email protected]"
  }
}

Delete backup units

delete

Remove the specified backup unit.

This process will delete:

1. The backup plans inside the backup unit

2. All backups, associated with this backup unit

3. The backup user

4. The backup unit itself

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

Path parameters

backupunitIdstringRequired

The unique ID of the backup unit.

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

/backupunits/{backupunitId}

HTTPcURLJavaScriptPython

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

No content

Partially modify backup units

patch

Update the properties of the specified backup unit.

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

Path parameters

backupunitIdstringRequired

The unique ID of the backup unit.

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

application/json

namestringRead-onlyOptional

The name of the resource (alphanumeric characters only).

Example: BackupUnitName

passwordstringOptional

The password associated with that resource.

Example: mypass123

emailstringOptional

The email associated with the backup unit. Bear in mind that this email does not be the same email as of the user.

Example: [email protected]

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

patch

/backupunits/{backupunitId}

HTTPcURLJavaScriptPython

PATCH /cloudapi/v6/backupunits/{backupunitId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "password": "mypass123",
  "email": "[email protected]"
}

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "backupunit",
  "href": "<RESOURCE-URI>",
  "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": "BackupUnitName",
    "password": "mypass123",
    "email": "[email protected]"
  }
}

Retrieve BU single sign-on URLs

get

Retrieve a single sign-on URL for the specified backup unit.

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

Path parameters

backupunitIdstringRequired

The unique ID of the backup unit.

Query parameters

prettybooleanOptional

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

Default: true

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

/backupunits/{backupunitId}/ssourl

HTTPcURLJavaScriptPython

GET /cloudapi/v6/backupunits/{backupunitId}/ssourl HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "ssoUrl": "https://<hostname>/?jwt=eyJ0eXAiO...W47AN5-_x7E"
}