ccloud Customer API v1.81.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

https://ccenter.internet1.de/api/v1

Authentication

oAuth2 authentication.
- Flow: clientCredentials
- Token URL = /oauth/token

Scope	Scope Description

OAuth

Generate a new token for authorization.

Code samples

curl --request POST \
  --url https://ccenter.internet1.de/api/v1/oauth/token \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"grant_type":"client_credentials","client_id":"90f63c80-bd90-89a3-4632-b16c4ab909ae","client_secret":"GsqCDfjYUCceU8dTq1vQWxLnnRaf6UySWP7GAgI","scope":"*"}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

payload = "{\"grant_type\":\"client_credentials\",\"client_id\":\"90f63c80-bd90-89a3-4632-b16c4ab909ae\",\"client_secret\":\"GsqCDfjYUCceU8dTq1vQWxLnnRaf6UySWP7GAgI\",\"scope\":\"*\"}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("POST", "/api/v1/oauth/token", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/oauth/token",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"grant_type\":\"client_credentials\",\"client_id\":\"90f63c80-bd90-89a3-4632-b16c4ab909ae\",\"client_secret\":\"GsqCDfjYUCceU8dTq1vQWxLnnRaf6UySWP7GAgI\",\"scope\":\"*\"}",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/oauth/token' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"grant_type":"client_credentials","client_id":"90f63c80-bd90-89a3-4632-b16c4ab909ae","client_secret":"GsqCDfjYUCceU8dTq1vQWxLnnRaf6UySWP7GAgI","scope":"*"}'

POST /oauth/token

Body parameter

{
  "grant_type": "client_credentials",
  "client_id": "90f63c80-bd90-89a3-4632-b16c4ab909ae",
  "client_secret": "GsqCDfjYUCceU8dTq1vQWxLnnRaf6UySWP7GAgI",
  "scope": "*"
}

grant_type: client_credentials
client_id: 90f63c80-bd90-89a3-4632-b16c4ab909ae
client_secret: GsqCDfjYUCceU8dTq1vQWxLnnRaf6UySWP7GAgI
scope: "*"

Parameters

Name	In	Type	Required	Description
body	body	OAuth	true	none

Example responses

200 Response

{
  "token_type": "Bearer",
  "expires_in": 31536000,
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	OAuthResponse
400	Bad Request	Invalid parameters	OAuthBadRequestResponse
401	Unauthorized	Unauthorized	OAuthUnauthorizedResponse

Servers

Get all Servers for the given customer.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/servers", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers' -Method GET -Headers $headers

GET /ccloud/servers

Parameters

Name	In	Type	Required	Description
tag	query	string	false	Filter the output and include only servers with this tag.
limit	query	integer	false	Limits results to the specified amount
page	query	integer	false	Page Number for Pagination
search	query	string	false	Search for server by hostname, os_name, ip_addresses or tags
build_in_progress	query	boolean	false	Only results with corresponding parameters for build_in_progress
deletion_in_progress	query	boolean	false	Only results with corresponding parameters for deletion_in_progress
sort	query	string	false	Comma-separated list of the columns to sort by.
order	query	string	false	Comma-separated list of order instructions.

Example responses

200 Response

{
  "data": [
    {
      "id": 0,
      "customer_id": "string",
      "hostname": "string",
      "generation": 0,
      "created_at": "2019-08-24",
      "tags": [
        "string"
      ],
      "location": "string",
      "custom_name": "string",
      "credentials_available": true,
      "deletion_in_progress": true,
      "build_in_progress": true,
      "rootaccess": true,
      "network_adapters": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "server_id": 0,
          "vlan_number": 0,
          "bandwidth": 0,
          "switch": "string",
          "mac_address": "string",
          "mac_spoofing": true,
          "perf_counter_instance_name": "string",
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z",
          "ip_addresses": [
            {
              "id": 0,
              "server_id": 0,
              "network_adapter_id": "08e934e8-2799-4546-ac08-238367e755eb",
              "subnet_id": 0,
              "customer_id": "string",
              "ip": "string",
              "created_at": "2019-08-24T14:15:22Z",
              "updated_at": "2019-08-24T14:15:22Z",
              "subnet": {
                "id": 0,
                "customer_id": "string",
                "type": "IPv4",
                "network": "string",
                "gateway": "string",
                "mask_bits": 0,
                "nameservers": [
                  "string"
                ],
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z"
              }
            }
          ]
        }
      ],
      "data": {
        "cores": 0,
        "memory": 0,
        "disk": 0,
        "pool": "string",
        "type": "unmanaged",
        "os_name": "string",
        "ostype": "Windows",
        "hostname": "string",
        "username": "user@example.com",
        "customer_id": "string",
        "description": "string",
        "notes": "string",
        "addons": [
          {
            "name": "string",
            "count": 0
          }
        ]
      }
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» data	[allOf]	false	none	Servers Data

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	Server	false	none	none
»»» id	integer	false	none	ID of the server.
»»» customer_id	string	false	none	Customer number.
»»» hostname	string	false	none	Hostname of the server.
»»» generation	integer	false	none	VM generation of the server.
»»» created_at	string(date)	false	none	Date server entry was created.
»»» tags	[string]	false	none	Array of tags attached to the server.
»»» location	string	false	none	Location string from d42
»»» custom_name	string	false	none	Customer defined Server Name
»»» credentials_available	boolean	false	none	Server credentials available
»»» deletion_in_progress	boolean	false	none	Whether a delete job for the given server is currently planned/running.
»»» build_in_progress	boolean	false	none	Whether a build job for the given server is currently planned/running.
»»» rootaccess	boolean	false	none	See if the customer have permissions for root access.
»»» network_adapters	[allOf]	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» id	string(uuid)	false	none	none
»»»»» server_id	integer	false	none	none
»»»»» vlan_number	integer	false	none	none
»»»»» bandwidth	integer	false	none	Bandwith in MBit/s
»»»»» switch	string	false	none	none
»»»»» mac_address	string	false	none	none
»»»»» mac_spoofing	boolean	false	none	none
»»»»» perf_counter_instance_name	string	false	none	none
»»»»» created_at	string(date-time)	false	none	none
»»»»» updated_at	string(date-time)	false	none	none

and

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» ip_addresses	[allOf]	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» id	integer	false	none	none
»»»»»»» server_id	integer	false	none	none
»»»»»»» network_adapter_id	string(uuid)	false	none	none
»»»»»»» subnet_id	integer	false	none	none
»»»»»»» customer_id	string	false	none	none
»»»»»»» ip	string	false	none	none
»»»»»»» created_at	string(date-time)	false	none	none
»»»»»»» updated_at	string(date-time)	false	none	none

and

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» subnet	Subnet	false	none	none
»»»»»»»» id	integer	false	none	none
»»»»»»»» customer_id	string	false	none	none
»»»»»»»» type	string	false	none	none
»»»»»»»» network	string	false	none	none
»»»»»»»» gateway	string	false	none	none
»»»»»»»» mask_bits	integer	false	none	none
»»»»»»»» nameservers	[string]	false	none	none
»»»»»»»» created_at	string(date-time)	false	none	none
»»»»»»»» updated_at	string(date-time)	false	none	none

and

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» data	ServerData	false	none	none
»»»» cores	integer	false	none	Amount of cores the server has.
»»»» memory	integer	false	none	Amount of RAM the server has.
»»»» disk	integer	false	none	Disk size of server.
»»»» pool	string	false	none	Pool the server belongs to.
»»»» type	string	false	none	Type of the server.
»»»» os_name	string	false	none	Name of the OS.
»»»» ostype	string	false	none	none
»»»» hostname	string	false	none	Hostname of the given server.
»»»» username	string(email)	false	none	Username of person who deployed the server.
»»»» customer_id	string	false	none	Customer number the server belongs to.
»»»» description	string	false	none	Description of the server.
»»»» notes	string	false	none	Notes of the server.
»»»» addons	[Addon]	false	none	Addons assigned to the server.
»»»»» name	string	false	none	none
»»»»» count	integer	false	none	none

Enumerated Values

Property	Value
type	IPv4
type	IPv6
type	unmanaged
type	managed

Create a new server

Code samples

curl --request POST \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"pool":"string","hostname":"string","description":"string","cores":0,"memory":0,"disks":[0],"image":"string","custom_name":"string","password":"string","sshkey":"string","user_data":"#cloud-config\nruncmd:\n- [touch, /root/cloud-init-worked]\n","type":"managed","addons":[{"name":"string","count":0}],"subnets":[0],"subnets_intern":[0],"tags":["string"],"rollouts":["string"]}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

payload = "{\"pool\":\"string\",\"hostname\":\"string\",\"description\":\"string\",\"cores\":0,\"memory\":0,\"disks\":[0],\"image\":\"string\",\"custom_name\":\"string\",\"password\":\"string\",\"sshkey\":\"string\",\"user_data\":\"#cloud-config\\nruncmd:\\n- [touch, /root/cloud-init-worked]\\n\",\"type\":\"managed\",\"addons\":[{\"name\":\"string\",\"count\":0}],\"subnets\":[0],\"subnets_intern\":[0],\"tags\":[\"string\"],\"rollouts\":[\"string\"]}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("POST", "/api/v1/ccloud/servers", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"pool\":\"string\",\"hostname\":\"string\",\"description\":\"string\",\"cores\":0,\"memory\":0,\"disks\":[0],\"image\":\"string\",\"custom_name\":\"string\",\"password\":\"string\",\"sshkey\":\"string\",\"user_data\":\"#cloud-config\\nruncmd:\\n- [touch, /root/cloud-init-worked]\\n\",\"type\":\"managed\",\"addons\":[{\"name\":\"string\",\"count\":0}],\"subnets\":[0],\"subnets_intern\":[0],\"tags\":[\"string\"],\"rollouts\":[\"string\"]}",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"pool":"string","hostname":"string","description":"string","cores":0,"memory":0,"disks":[0],"image":"string","custom_name":"string","password":"string","sshkey":"string","user_data":"#cloud-config\nruncmd:\n- [touch, /root/cloud-init-worked]\n","type":"managed","addons":[{"name":"string","count":0}],"subnets":[0],"subnets_intern":[0],"tags":["string"],"rollouts":["string"]}'

POST /ccloud/servers

Body parameter

{
  "pool": "string",
  "hostname": "string",
  "description": "string",
  "cores": 0,
  "memory": 0,
  "disks": [
    0
  ],
  "image": "string",
  "custom_name": "string",
  "password": "string",
  "sshkey": "string",
  "user_data": "#cloud-config\nruncmd:\n- [touch, /root/cloud-init-worked]\n",
  "type": "managed",
  "addons": [
    {
      "name": "string",
      "count": 0
    }
  ],
  "subnets": [
    0
  ],
  "subnets_intern": [
    0
  ],
  "tags": [
    "string"
  ],
  "rollouts": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	DeploymentCreateRequest	true	none

Example responses

200 Response

{
  "id": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	DeploymentCreateRequestSuccess
422	Unprocessable Entity	none	None

Get details for a server by its hostname.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/servers/vs10000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000' -Method GET -Headers $headers

GET /ccloud/servers/{hostname}

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.

Example responses

200 Response

{
  "id": 0,
  "customer_id": "string",
  "hostname": "string",
  "generation": 0,
  "created_at": "2019-08-24",
  "tags": [
    "string"
  ],
  "location": "string",
  "custom_name": "string",
  "credentials_available": true,
  "deletion_in_progress": true,
  "build_in_progress": true,
  "rootaccess": true,
  "network_adapters": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "server_id": 0,
      "vlan_number": 0,
      "bandwidth": 0,
      "switch": "string",
      "mac_address": "string",
      "mac_spoofing": true,
      "perf_counter_instance_name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "ip_addresses": [
        {
          "id": 0,
          "server_id": 0,
          "network_adapter_id": "08e934e8-2799-4546-ac08-238367e755eb",
          "subnet_id": 0,
          "customer_id": "string",
          "ip": "string",
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z",
          "subnet": {
            "id": 0,
            "customer_id": "string",
            "type": "IPv4",
            "network": "string",
            "gateway": "string",
            "mask_bits": 0,
            "nameservers": [
              "string"
            ],
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z"
          }
        }
      ]
    }
  ],
  "data": {
    "cores": 0,
    "memory": 0,
    "disk": 0,
    "pool": "string",
    "type": "unmanaged",
    "os_name": "string",
    "ostype": "Windows",
    "hostname": "string",
    "username": "user@example.com",
    "customer_id": "string",
    "description": "string",
    "notes": "string",
    "addons": [
      {
        "name": "string",
        "count": 0
      }
    ]
  },
  "custom_price": true
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	ServerDetailInclCustomPriceFlag

Delete a Virtual Machine

Code samples

curl --request DELETE \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"hostname":"string"}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

payload = "{\"hostname\":\"string\"}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("DELETE", "/api/v1/ccloud/servers/vs10000", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => "{\"hostname\":\"string\"}",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000' -Method DELETE -Headers $headers -ContentType 'application/json' -Body '{"hostname":"string"}'

DELETE /ccloud/servers/{hostname}

Body parameter

{
  "hostname": "string"
}

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.
body	body	DeleteRequest	true	none

Example responses

200 Response

{
  "id": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Returns the id of the server delete task.	TaskID
422	Unprocessable Entity	none	None

Get all Tasks for the given Server.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/tasks \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/servers/vs10000/tasks", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/tasks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/tasks' -Method GET -Headers $headers

GET /ccloud/servers/{hostname}/tasks

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.
action	query	string	false	Filter by action
status	query	string	false	Filter by status
search	query	string	false	Wildcard search filter
limit	query	integer	false	Limit results
page	query	integer	false	Page Number for Pagination
sort	query	string	false	Comma-separated list of the columns to sort by.
order	query	string	false	Comma-separated list of order instructions.

Example responses

200 Response

[
  {
    "id": 0,
    "action": "create-server",
    "customer_id": "string",
    "username": "string",
    "hostname": "string",
    "status": "processing",
    "error_message": "string",
    "created_at": "2019-08-24T14:15:22Z"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Array of Tasks belonging to the given Server.	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[TasksGetStatus]	false	none	none
» id	integer	false	none	none
» action	string	false	none	none
» customer_id	string	false	none	none
» username	string	false	none	none
» hostname	string	false	none	none
» status	string	false	none	none
» error_message	string	false	none	none
» created_at	string(date-time)	false	none	none

Enumerated Values

Property	Value
action	create-server
action	resize-server
action	start-server
action	stop-server
action	restart-server
action	delete-server
action	add-networkadpater
action	set-networkadapter
action	delete-networkadapter
action	add-disk-server
action	delete-disk-server
status	processing
status	failed
status	done

Get server password

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/password \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/servers/vs10000/password", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/password",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/password' -Method GET -Headers $headers

GET /ccloud/servers/{hostname}/password

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.

Example responses

200 Response

[
  {
    "username": "string",
    "password": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Returns the password of the server.	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[getPassword]	false	none	none
» username	string	false	none	none
» password	string	false	none	none

Server Actions

reinstall a server

Code samples

curl --request POST \
  --url https://ccenter.internet1.de/api/v1/servers/vs10000/redeploy \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"image":"string","password":"string","sshkey":"string"}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

payload = "{\"image\":\"string\",\"password\":\"string\",\"sshkey\":\"string\"}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("POST", "/api/v1/servers/vs10000/redeploy", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/servers/vs10000/redeploy",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"image\":\"string\",\"password\":\"string\",\"sshkey\":\"string\"}",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/servers/vs10000/redeploy' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"image":"string","password":"string","sshkey":"string"}'

POST /servers/{hostname}/redeploy

Body parameter

{
  "image": "string",
  "password": "string",
  "sshkey": "string"
}

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.
body	body	RedeployRequest	true	none

Example responses

200 Response

{
  "id": 0,
  "job_id": "string",
  "action": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	TaskResponse
422	Unprocessable Entity	Validation-Failure	LaravelValidationFailure

Set a custom name for the given server

Code samples

curl --request PUT \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/customname \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = { 'Authorization': "Bearer {access-token}" }

conn.request("PUT", "/api/v1/ccloud/servers/vs10000/customname", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/customname",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/customname' -Method PUT -Headers $headers

PUT /ccloud/servers/{hostname}/customname

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.
name	body	string	false	Custom name (when not set existing custom name will be deleted)

Responses

Status	Meaning	Description	Schema
204	No Content	The custom name was successfully set.	None

Server Resize

Resize the memory of an existing Server.

Code samples

curl --request PUT \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/memory \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"memory":0}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

payload = "{\"memory\":0}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("PUT", "/api/v1/ccloud/servers/vs10000/memory", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/memory",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "{\"memory\":0}",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/memory' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"memory":0}'

PUT /ccloud/servers/{hostname}/memory

Body parameter

{
  "memory": 0
}

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.
body	body	ServerResizeMemoryRequest	true	none

Example responses

200 Response

{
  "id": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Task ID of resize Task	TaskID

Resize the Cores of an existing Server.

Code samples

curl --request PUT \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/cores \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"cores":0}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

payload = "{\"cores\":0}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("PUT", "/api/v1/ccloud/servers/vs10000/cores", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/cores",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "{\"cores\":0}",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/cores' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"cores":0}'

PUT /ccloud/servers/{hostname}/cores

Body parameter

{
  "cores": 0
}

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.
body	body	ServerResizeCoresRequest	true	none

Example responses

200 Response

{
  "id": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Task ID of resize Task	TasksGetCoresStatus

Server Addons

Setup the given addon for the given hostname.

Code samples

curl --request PUT \
  --url https://ccenter.internet1.de/api/v1/servers/vs10000/addons/monitoring \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"count":0,"description":null}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

payload = "{\"count\":0,\"description\":null}"

headers = {
    'Content-Type': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("PUT", "/api/v1/servers/vs10000/addons/monitoring", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/servers/vs10000/addons/monitoring",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "{\"count\":0,\"description\":null}",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer {access-token}",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/servers/vs10000/addons/monitoring' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"count":0,"description":null}'

PUT /servers/{hostname}/addons/{addon}

Body parameter

{
  "count": 0,
  "description": null
}

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.
addon	path	string	true	Name of the addon to add.
body	body	object	false	none
» count	body	integer	false	none
» description	body	any	false	none

Enumerated Values

Parameter	Value
addon	monitoring

Responses

Status	Meaning	Description	Schema
204	No Content	No-Content	None

Delete the given addon for the given hostname.

Code samples

curl --request DELETE \
  --url https://ccenter.internet1.de/api/v1/servers/vs10000/addons/monitoring \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = { 'Authorization': "Bearer {access-token}" }

conn.request("DELETE", "/api/v1/servers/vs10000/addons/monitoring", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/servers/vs10000/addons/monitoring",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/servers/vs10000/addons/monitoring' -Method DELETE -Headers $headers

DELETE /servers/{hostname}/addons/{addon}

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.
addon	path	string	true	Name of the addon to delete.

Enumerated Values

Parameter	Value
addon	monitoring

Responses

Status	Meaning	Description	Schema
204	No Content	No-Content	None

Server ISO

Get all available ISOs for the server.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/isos \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/servers/vs10000/isos", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/isos",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/isos' -Method GET -Headers $headers

GET /ccloud/servers/{hostname}/isos

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.

Example responses

200 Response

{
  "name": "string",
  "fullName": "string",
  "customer": "string",
  "size": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Get all ISOs.	GetISOs

Server State

Get the state of a server by its hostname.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/state \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/servers/vs10000/state", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/state",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/state' -Method GET -Headers $headers

GET /ccloud/servers/{hostname}/state

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.

Example responses

200 Response

{
  "state": "Running"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» state	string	false	none	none

Enumerated Values

Property	Value
state	Running
state	Paused
state	Reset
state	Saved
state	Off
state	Critical

Execute the action on the server to change its state.

Code samples

curl --request POST \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/state/start \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("POST", "/api/v1/ccloud/servers/vs10000/state/start", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/state/start",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/state/start' -Method POST -Headers $headers

POST /ccloud/servers/{hostname}/state/{action}

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.
action	path	string	true	Action to be performed

Enumerated Values

Parameter	Value
action	start
action	stop
action	shutdown
action	shutdown-force
action	reset

Example responses

200 Response

{
  "id": 32
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	integer	true	none	id of the task

Console

Get the console URL of a Server.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/console \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/servers/vs10000/console", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/console",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/console' -Method GET -Headers $headers

GET /ccloud/servers/{hostname}/console

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.

Example responses

200 Response

{
  "url": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Returns the newly generated console URL.	Console

Server DVD Drives

Get VM DVD Drives

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/dvds \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/servers/vs10000/dvds", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/dvds",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/dvds' -Method GET -Headers $headers

GET /ccloud/servers/{hostname}/dvds

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.

Example responses

200 Response

[
  {
    "id": "string",
    "path": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[VMDVDModel]	false	none	none
» id	string¦null	false	none	none
» path	string¦null	false	none	none

Add a new VM DVD Drive

Code samples

curl --request POST \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/dvds \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("POST", "/api/v1/ccloud/servers/vs10000/dvds", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/dvds",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/dvds' -Method POST -Headers $headers

POST /ccloud/servers/{hostname}/dvds

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.
name	body	string	true	Filename of the ISO Image

Example responses

200 Response

[
  {
    "id": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[AddedDVDTaskResponse]	false	none	none
» id	integer	false	none	Task id

Update VM DVD Drive

Code samples

curl --request PUT \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/dvds/sc0s1 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("PUT", "/api/v1/ccloud/servers/vs10000/dvds/sc0s1", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/dvds/sc0s1",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/dvds/sc0s1' -Method PUT -Headers $headers

PUT /ccloud/servers/{hostname}/dvds/{id}

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.
id	path	string	true	ID of the DVD Drive
name	body	string	true	Filename of the ISO Image

Example responses

200 Response

[
  {
    "id": 0,
    "data": [
      {
        "id": "string",
        "name": "string",
        "path": "string",
        "hostname": "string",
        "customer_id": "string",
        "username": "string"
      }
    ]
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[UpdateDVDTaskResponse]	false	none	none
» id	integer	false	none	none
» data	[object]	false	none	none
»» id	string	false	none	none
»» name	string	false	none	Filename of the ISO Image
»» path	string	false	none	Path of the ISO Image
»» hostname	string	false	none	Hostname of the Server
»» customer_id	string	false	none	Customer ID submitting the request.
»» username	string	false	none	Username submitting the request.

Delete VM DVD Drive

Code samples

curl --request DELETE \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/dvds/sc0s0 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("DELETE", "/api/v1/ccloud/servers/vs10000/dvds/sc0s0", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/dvds/sc0s0",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/dvds/sc0s0' -Method DELETE -Headers $headers

DELETE /ccloud/servers/{hostname}/dvds/{id}

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.
id	path	string	true	ID of the DVD Drive

Example responses

200 Response

{
  "id": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	DeleteDVDTaskResponse

Server Disks

Get VM Disk

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/disks \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/servers/vs10000/disks", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/disks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/disks' -Method GET -Headers $headers

GET /ccloud/servers/{hostname}/disks

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.

Example responses

200 Response

[
  {
    "id": "string",
    "size": 0,
    "perfCounterInstancename": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[VMDiskModel]	false	none	none
» id	string	false	none	none
» size	integer	false	none	none
» perfCounterInstancename	string	false	none	none

Add new VM Disk

Code samples

curl --request POST \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/disks \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"size":0}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

payload = "{\"size\":0}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("POST", "/api/v1/ccloud/servers/vs10000/disks", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/disks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"size\":0}",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/disks' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"size":0}'

POST /ccloud/servers/{hostname}/disks

Body parameter

{
  "size": 0
}

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.
body	body	object	true	none
» size	body	integer	true	Size in bytes

Example responses

200 Response

{
  "id": 0,
  "job_id": "string",
  "action": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	TaskResponse

Update VM Disk

Code samples

curl --request PUT \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/disks/sc0s0 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"size":50}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

payload = "{\"size\":50}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("PUT", "/api/v1/ccloud/servers/vs10000/disks/sc0s0", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/disks/sc0s0",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "{\"size\":50}",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/disks/sc0s0' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"size":50}'

PUT /ccloud/servers/{hostname}/disks/{id}

Body parameter

{
  "size": 50
}

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.
id	path	string	true	ID of the Disk
body	body	VMDiskUpdateModel	true	none

Example responses

200 Response

{
  "id": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	UpdateTaskResponse

Delete a VM disk

Code samples

curl --request DELETE \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/disks/string \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("DELETE", "/api/v1/ccloud/servers/vs10000/disks/string", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/disks/string",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/disks/string' -Method DELETE -Headers $headers

DELETE /ccloud/servers/{hostname}/disks/{id}

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.
id	path	string	true	ID of the VM disk

Example responses

200 Response

{
  "id": 0,
  "job_id": "string",
  "action": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	TaskResponse
422	Unprocessable Entity	Validation-Failure	LaravelValidationFailure

Network

Get customers Subnets

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/network/subnets \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/network/subnets", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/network/subnets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/network/subnets' -Method GET -Headers $headers

GET /ccloud/network/subnets

Example responses

200 Response

[
  {
    "id": 2,
    "type": "IPv4",
    "name": "string",
    "network": "192.168.232.0",
    "gateway": "192.168.232.1",
    "mask_bits": 24,
    "nameservers": [
      [
        "192.168.232.1"
      ]
    ]
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	a List of Subnets	NetworkSubnets

Get the IPs for the given subnet.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/network/subnets/string/ips \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/network/subnets/string/ips", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/network/subnets/string/ips",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/network/subnets/string/ips' -Method GET -Headers $headers

GET /ccloud/network/subnets/{id}/ips

Parameters

Name	In	Type	Required	Description
id	path	string	true	Id of the subnet.

Example responses

200 Response

[
  {
    "id": 0,
    "server_id": 0,
    "network_adapter_id": 0,
    "subnet_id": 0,
    "ip": "255.255.255.0",
    "hostname": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	none	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[NetworkIP]	false	none	none
» id	integer	false	none	none
» server_id	integer	false	none	none
» network_adapter_id	integer	false	none	none
» subnet_id	integer	false	none	none
» ip	string	false	none	none
» hostname	string	false	none	none
» created_at	string(date-time)	false	none	none
» updated_at	string(date-time)	false	none	none

Get all IPs of customer.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/network/ips \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/network/ips", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/network/ips",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/network/ips' -Method GET -Headers $headers

GET /ccloud/network/ips

Example responses

200 Response

[
  {
    "hostname": "ts1000",
    "ip": "1.1.1.1",
    "subnetname": "VLAN_1"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	none	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[NetworkIPs]	false	none	none
» hostname	string	false	none	none
» ip	string	false	none	none
» subnetname	string	false	none	none

Get customers VPCs

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/network/vpcs \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/network/vpcs", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/network/vpcs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/network/vpcs' -Method GET -Headers $headers

GET /ccloud/network/vpcs

Example responses

200 Response

[
  {
    "id": "string",
    "type": "string",
    "name": "string",
    "subnets": [
      [
        {
          "id": 2,
          "type": "IPv4",
          "name": "string",
          "network": "192.168.232.0",
          "gateway": "192.168.232.1",
          "mask_bits": 24,
          "nameservers": [
            [
              "192.168.232.1"
            ]
          ]
        }
      ]
    ]
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	none	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[NetworkVPC]	false	none	none
» id	string	false	none	none
» type	string(public,private)	false	none	none
» name	string	false	none	none
» subnets	[NetworkSubnets]	false	none	none
»» id	integer	false	none	ID of the subnet
»» type	string	false	none	Subnet Type IPv4 or IPv6
»» name	string	false	none	Name of the subnet
»» network	string	false	none	Network of the subnet.
»» gateway	string	false	none	Subnet Gateway IP
»» mask_bits	string	false	none	Mask bits of the subnet
»» nameservers	[string]	false	none	none

Enumerated Values

Property	Value
type	IPv4
type	IPv6

Get VM Network Adapters

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/network \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/servers/vs10000/network", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/network",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/network' -Method GET -Headers $headers

GET /ccloud/servers/{hostname}/network

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.

Example responses

200 Response

[
  {
    "id": "string",
    "switch": "string",
    "vlan": 0,
    "mac_spoofing": true,
    "bandwith": 0,
    "ipAdresse": [
      "string"
    ]
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[VMNetModel]	false	none	none
» id	string¦null	false	none	none
» switch	string¦null	false	none	none
» vlan	integer(int32)	false	none	none
» mac_spoofing	boolean	false	none	none
» bandwith	integer(int64)	false	none	none
» ipAdresse	[string]¦null	false	none	none

Add new IP to Network Adapter

Code samples

curl --request POST \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/network/string/ip \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"protocol":"IPv4"}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

payload = "{\"protocol\":\"IPv4\"}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("POST", "/api/v1/ccloud/servers/vs10000/network/string/ip", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/network/string/ip",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"protocol\":\"IPv4\"}",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/network/string/ip' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"protocol":"IPv4"}'

POST /ccloud/servers/{hostname}/network/{adapter_id}/ip

Body parameter

{
  "protocol": "IPv4"
}

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.
adapter_id	path	string	true	ID of the Network Adapter
body	body	VMNetworkAddIPRequest	true	none

Example responses

200 Response

{
  "type": "IPv6",
  "ip_address": "2a00:6140:a000:72::b",
  "network": "2a00:6140:a000:72::",
  "mask_bits": 64,
  "nameservers": [
    "2a00:6140:a000:72::1"
  ],
  "gateway": "2a00:6140:a000:72::1",
  "vlan": 708
}

Responses

Status	Meaning	Description	Schema
200	OK	Task ID	VMNetworkAddIPResponse

Scheduled Snapshots

Get scheduled Snapshots

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/snapshots/scheduled \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/servers/vs10000/snapshots/scheduled", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/snapshots/scheduled",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/snapshots/scheduled' -Method GET -Headers $headers

GET /ccloud/servers/{hostname}/snapshots/scheduled

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.

Example responses

200 Response

{
  "frequency": 3,
  "next_run": "2023-11-30 15:00"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» frequency	number	true	none	Frequency in hours. Every x hours a snapshot will be created. Allowed frequency is 1,3,6,12,24
» next_run	string(date-time)	true	none	next execution time of Scheduled Snapshot in format YYYY-mm-dd HH:ii

Enumerated Values

Property	Value
frequency	1
frequency	3
frequency	6
frequency	12

Creates a scheduler for automatic snapshots

Code samples

curl --request POST \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/snapshots/scheduled \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"frequency":3,"next_run":"2023-11-30 15:00"}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

payload = "{\"frequency\":3,\"next_run\":\"2023-11-30 15:00\"}"

headers = {
    'Content-Type': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("POST", "/api/v1/ccloud/servers/vs10000/snapshots/scheduled", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/snapshots/scheduled",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"frequency\":3,\"next_run\":\"2023-11-30 15:00\"}",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer {access-token}",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/snapshots/scheduled' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"frequency":3,"next_run":"2023-11-30 15:00"}'

POST /ccloud/servers/{hostname}/snapshots/scheduled

Body parameter

{
  "frequency": 3,
  "next_run": "2023-11-30 15:00"
}

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.
body	body	#/paths/~1ccloud~1servers~1%7Bhostname%7D~1snapshots~1scheduled/get/responses/200/content/application~1json/schema	true	none

Responses

Status	Meaning	Description	Schema
204	No Content	No-Content	None

Delete Scheduler for automatic snapshots

Code samples

curl --request DELETE \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/snapshots/scheduled \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = { 'Authorization': "Bearer {access-token}" }

conn.request("DELETE", "/api/v1/ccloud/servers/vs10000/snapshots/scheduled", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/snapshots/scheduled",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/snapshots/scheduled' -Method DELETE -Headers $headers

DELETE /ccloud/servers/{hostname}/snapshots/scheduled

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.

Responses

Status	Meaning	Description	Schema
204	No Content	No-Content	None

Snapshots

Get the snapshots of a server by its hostname.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/snapshots \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/servers/vs10000/snapshots", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/snapshots",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/snapshots' -Method GET -Headers $headers

GET /ccloud/servers/{hostname}/snapshots

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.

Example responses

200 Response

[
  {
    "id": "string",
    "name": "string",
    "active": true,
    "creationTime": "2019-08-24T14:15:22Z",
    "parentSnapshotId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string¦null	false	none	none
» name	string¦null	false	none	none
» active	boolean	false	none	none
» creationTime	string(date-time)	false	none	none
» parentSnapshotId	string¦null	false	none	none

Create a new Snapshot

Code samples

curl --request POST \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/snapshots \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"name":"string"}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

payload = "{\"name\":\"string\"}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("POST", "/api/v1/ccloud/servers/vs10000/snapshots", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/snapshots",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"name\":\"string\"}",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/snapshots' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"name":"string"}'

POST /ccloud/servers/{hostname}/snapshots

Body parameter

{
  "name": "string"
}

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.
body	body	ServerCreateSnapshotRequest	true	none

Example responses

200 Response

{
  "type": "object",
  "properties": null,
  "id": {
    "type": "integer",
    "example": 0
  },
  "data": {
    "type": "array",
    "items": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "example": "string"
        },
        "hostname": {
          "type": "string",
          "example": "string",
          "description": "Hostname of the Server"
        },
        "customer_id": {
          "type": "string",
          "example": "string",
          "description": "Customer ID submitting the request."
        },
        "username": {
          "type": "string",
          "example": "string",
          "description": "Username submitting the request."
        }
      }
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Task ID of Create Snapshots Task	AddedSnapshotTaskResponse

Restore (apply) a snapshot on the Server

Code samples

curl --request POST \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/snapshots/51c1d831-784b-4550-8c54-a2ced31b5099 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("POST", "/api/v1/ccloud/servers/vs10000/snapshots/51c1d831-784b-4550-8c54-a2ced31b5099", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/snapshots/51c1d831-784b-4550-8c54-a2ced31b5099",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/snapshots/51c1d831-784b-4550-8c54-a2ced31b5099' -Method POST -Headers $headers

POST /ccloud/servers/{hostname}/snapshots/{id}

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.
id	path	string	true	id of the snapshot

Example responses

200 Response

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": null,
    "id": {
      "type": "integer",
      "example": 0
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "string"
          },
          "hostname": {
            "type": "string",
            "example": "string",
            "description": "Hostname of the Server"
          },
          "customer_id": {
            "type": "string",
            "example": "string",
            "description": "Customer ID submitting the request."
          },
          "username": {
            "type": "string",
            "example": "string",
            "description": "Username submitting the request."
          }
        }
      }
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[RestoreSnapshotTaskResponse]	false	none	none

Rename a Snapshot

Code samples

curl --request PUT \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/snapshots/51c1d831-784b-4550-8c54-a2ced31b5099 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"name":"string"}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

payload = "{\"name\":\"string\"}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("PUT", "/api/v1/ccloud/servers/vs10000/snapshots/51c1d831-784b-4550-8c54-a2ced31b5099", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/snapshots/51c1d831-784b-4550-8c54-a2ced31b5099",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "{\"name\":\"string\"}",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/snapshots/51c1d831-784b-4550-8c54-a2ced31b5099' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"name":"string"}'

PUT /ccloud/servers/{hostname}/snapshots/{id}

Body parameter

{
  "name": "string"
}

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.
id	path	string	true	id of the snapshot
body	body	ServerRenameSnapshotRequest	true	none

Example responses

200 Response

{
  "type": "object",
  "properties": null,
  "id": {
    "type": "integer",
    "example": 0
  },
  "data": {
    "type": "array",
    "items": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "string"
        },
        "name": {
          "type": "string",
          "example": "string"
        },
        "hostname": {
          "type": "string",
          "example": "string",
          "description": "Hostname of the Server"
        },
        "customer_id": {
          "type": "string",
          "example": "string",
          "description": "Customer ID submitting the request."
        },
        "username": {
          "type": "string",
          "example": "string",
          "description": "Username submitting the request."
        }
      }
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Task ID of rename Snapshots Task	RenameSnapshotTaskResponse

Delete a snapshot on the Server

Code samples

curl --request DELETE \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/snapshots/51c1d831-784b-4550-8c54-a2ced31b5099 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("DELETE", "/api/v1/ccloud/servers/vs10000/snapshots/51c1d831-784b-4550-8c54-a2ced31b5099", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/snapshots/51c1d831-784b-4550-8c54-a2ced31b5099",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/snapshots/51c1d831-784b-4550-8c54-a2ced31b5099' -Method DELETE -Headers $headers

DELETE /ccloud/servers/{hostname}/snapshots/{id}

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.
id	path	string	true	id of the snapshot

Example responses

200 Response

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": null,
    "id": {
      "type": "integer",
      "example": 0
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "string"
          },
          "hostname": {
            "type": "string",
            "example": "string",
            "description": "Hostname of the Server"
          },
          "customer_id": {
            "type": "string",
            "example": "string",
            "description": "Customer ID submitting the request."
          },
          "username": {
            "type": "string",
            "example": "string",
            "description": "Username submitting the request."
          }
        }
      }
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[DeleteSnapshotTaskResponse]	false	none	none

Performance

Get the Performance Data of a server by its hostname.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/performance/mem/year \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/servers/vs10000/performance/mem/year", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/performance/mem/year",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/performance/mem/year' -Method GET -Headers $headers

GET /ccloud/servers/{hostname}/performance/{resource}/{period}

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.
resource	path	string	true	Type of the Resource to get performance Data
period	path	string	true	Time Period to get performance Data

Enumerated Values

Parameter	Value
resource	mem
resource	cpu
resource	net
resource	disk
period	hour
period	day
period	week
period	month
period	year

Example responses

200 Response

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": null,
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "units": {
            "type": "integer",
            "format": "string",
            "example": "Byte/s",
            "description": "The Units of the Performance Data given back"
          },
          "perfdata": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "send_persec": {
                  "type": "integer",
                  "example": 54,
                  "description": "Example of Performance Data given back, this elements can change depending on what data is requested"
                }
              }
            }
          }
        }
      }
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[PerfomanceDataModel]	false	none	none

Bootorder

Get the Bootorder of a server by its hostname.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/bootorder \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/servers/vs10000/bootorder", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/bootorder",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/bootorder' -Method GET -Headers $headers

GET /ccloud/servers/{hostname}/bootorder

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.

Example responses

200 Response

[
  {
    "id": 1,
    "type": "DVD",
    "bootDevice": "sc0s1"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[BootOrderModel]	false	none	none
» id	integer(int32)	false	none	Order ID of the Device
» type	string¦null	false	none	Type of the Device
» bootDevice	string¦null	false	none	Device Name of the Device

Change the Bootorder of a server by its hostname.

Code samples

curl --request PUT \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/bootorder \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"type":"object","properties":null,"id":{"type":"integer","example":2}}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

payload = "{\"type\":\"object\",\"properties\":null,\"id\":{\"type\":\"integer\",\"example\":2}}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("PUT", "/api/v1/ccloud/servers/vs10000/bootorder", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/bootorder",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "{\"type\":\"object\",\"properties\":null,\"id\":{\"type\":\"integer\",\"example\":2}}",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/bootorder' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"type":"object","properties":null,"id":{"type":"integer","example":2}}'

PUT /ccloud/servers/{hostname}/bootorder

Body parameter

{
  "type": "object",
  "properties": null,
  "id": {
    "type": "integer",
    "example": 2
  }
}

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.
body	body	changeBootOrderRequest	true	none

Example responses

200 Response

{
  "id": 0,
  "job_id": "string",
  "action": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	TaskResponse

Server Notes

Notes for this Server

Code samples

curl --request PUT \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/notes \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"notes":"This is my Database Server"}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

payload = "{\"notes\":\"This is my Database Server\"}"

headers = {
    'Content-Type': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("PUT", "/api/v1/ccloud/servers/vs10000/notes", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/notes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "{\"notes\":\"This is my Database Server\"}",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer {access-token}",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/notes' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"notes":"This is my Database Server"}'

PUT /ccloud/servers/{hostname}/notes

Body parameter

{
  "notes": "This is my Database Server"
}

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.
body	body	ServerNotesRequest	true	none

Responses

Status	Meaning	Description	Schema
204	No Content	No-Content	None

delete Notes for this Server

Code samples

curl --request DELETE \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/notes \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = { 'Authorization': "Bearer {access-token}" }

conn.request("DELETE", "/api/v1/ccloud/servers/vs10000/notes", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/notes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/notes' -Method DELETE -Headers $headers

DELETE /ccloud/servers/{hostname}/notes

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.

Responses

Status	Meaning	Description	Schema
204	No Content	No-Content	None

GPUs

Get all GPU Models with its current availability.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/gpus \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/gpus", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/gpus",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/gpus' -Method GET -Headers $headers

GET /ccloud/gpus

Example responses

200 Response

[
  {
    "id": 1,
    "name": "AMD Barco MXRT 5450 1024 MB BIOS",
    "addon_name": "gpu_amd_barco_mxrt_5450_1024mb_bios",
    "pools": [
      "pool_iw3_ssd_gpu"
    ],
    "desc_de": "AMD Barco MXRT 5450 1024 MB BIOS",
    "desc_en": "AMD Barco MXRT 5450 1024 MB BIOS"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Success	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[GPUModel]	false	none	none
» id	number	false	none	Id of the GPU Model
» name	string	false	none	Name of the GPU
» addon_name	string	false	none	Addon Name of the GPU for ordering the addon
» pools	[string]	false	none	none
» desc_de	string	false	none	Description in German
» desc_en	string	false	none	Description in English

Get all available GPU Models for a server.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/gpus \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/servers/vs10000/gpus", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/gpus",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/gpus' -Method GET -Headers $headers

GET /ccloud/servers/{hostname}/gpus

Parameters

Name	In	Type	Required	Description
hostname	path	string	true	Hostname of the server.

Example responses

200 Response

[
  {
    "name": "AMD Barco MXRT 5450 1024 MB BIOS",
    "addon_name": "gpu_amd_barco_mxrt_5450_1024mb_bios",
    "desc_de": "AMD Barco MXRT 5450 1024 MB BIOS",
    "desc_en": "AMD Barco MXRT 5450 1024 MB BIOS",
    "count": 1
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Success	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[AvailableGPU]	false	none	none
» name	string	false	none	Name of the GPU
» addon_name	string	false	none	Addon Name of the GPU for ordering the addon
» desc_de	string	false	none	Description in German
» desc_en	string	false	none	Description in English
» count	number	false	none	Count of the available GPUs of this type

Tasks

Get all tasks for the given customer.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/tasks \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/tasks", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/tasks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/tasks' -Method GET -Headers $headers

GET /ccloud/tasks

Parameters

Name	In	Type	Required	Description
action	query	string	false	Filter by action
status	query	string	false	Filter by status
search	query	string	false	Search for server by hostname or error_message
limit	query	integer	false	Limit results
page	query	integer	false	Page Number for Pagination
sort	query	string	false	Comma-separated list of the columns to sort by.
order	query	string	false	Comma-separated list of order instructions.

Example responses

200 Response

[
  {
    "id": 0,
    "action": "create-server",
    "customer_id": "string",
    "username": "string",
    "hostname": "string",
    "status": "processing",
    "error_message": "string",
    "created_at": "2019-08-24T14:15:22Z"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Array of tasks belonging to the given customer.	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[TasksGetStatus]	false	none	none
» id	integer	false	none	none
» action	string	false	none	none
» customer_id	string	false	none	none
» username	string	false	none	none
» hostname	string	false	none	none
» status	string	false	none	none
» error_message	string	false	none	none
» created_at	string(date-time)	false	none	none

Enumerated Values

Property	Value
action	create-server
action	resize-server
action	start-server
action	stop-server
action	restart-server
action	delete-server
action	add-networkadpater
action	set-networkadapter
action	delete-networkadapter
action	add-disk-server
action	delete-disk-server
status	processing
status	failed
status	done

Get a Task by id.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/tasks/1 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/tasks/1", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/tasks/1",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/tasks/1' -Method GET -Headers $headers

GET /ccloud/tasks/{id}

Parameters

Name	In	Type	Required	Description
id	path	integer	true	id of the Task.

Example responses

200 Response

{
  "id": 0,
  "action": "create-server",
  "customer_id": "string",
  "username": "string",
  "hostname": "string",
  "status": "processing",
  "error_message": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	Status of Task with details.	TasksGetStatus

Pools

Get a list of all public pools and your personal pools.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/pools \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/pools", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/pools",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/pools' -Method GET -Headers $headers

GET /ccloud/pools

Parameters

Name	In	Type	Required	Description
inactive	query	boolean	false	Include inactive pools (Inactive cause they are full and nagios_active flag is false).

Example responses

200 Response

[
  {
    "nagios_active": true,
    "gpu_supported": true,
    "tag": "string",
    "name": "string",
    "desc_de": "string",
    "desc_en": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[Pool]	false	none	none
» nagios_active	boolean	false	none	none
» gpu_supported	boolean	false	none	none
» tag	string	false	none	none
» name	string	false	none	none
» desc_de	string	false	none	none
» desc_en	string	false	none	none

Get a single pool by its tag.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/pools/ \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/pools/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/pools/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/pools/' -Method GET -Headers $headers

GET /ccloud/pools/{tag}

Example responses

200 Response

{
  "nagios_active": true,
  "gpu_supported": true,
  "tag": "string",
  "name": "string",
  "desc_de": "string",
  "desc_en": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Pool

Subscription

Returns all subscriptions of a customer

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/customers/subscriptions \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/customers/subscriptions", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/customers/subscriptions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/customers/subscriptions' -Method GET -Headers $headers

GET /ccloud/customers/subscriptions

Body parameter

Parameters

Name	In	Type	Required	Description
limit	query	integer	false	Limits results to the specified amount
page	query	integer	false	Page Number for Pagination
search	query	string	false	wildcard search filter
sort	query	string	false	Comma-separated list of the columns to sort by.
order	query	string	false	Comma-separated list of order instructions.

Example responses

200 Response

{
  "data": [
    {
      "id": 2,
      "customer_id": 328100,
      "pool": "pool_aw2_ssd",
      "name": "S328100-001",
      "display_name": "My Subscription",
      "confirmed": false,
      "runtime": 12,
      "discount": 10,
      "monthly_price": 500,
      "setup_fee": 50,
      "setup_fee_charged": true,
      "valid_to": "2024-06-01",
      "start_date": "2024-06-01",
      "end_date": "2025-06-01",
      "renew": false,
      "data": {
        "cores": 30,
        "memory": 64,
        "disk": 500,
        "support_hours": 6,
        "full_backup": 100,
        "licenses": [
          {
            "id": 12708,
            "count": 4
          }
        ],
        "addons": [
          {
            "name": "monitoring",
            "count": 4
          }
        ]
      },
      "replacement": 1,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "tags": [
        "string"
      ]
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» data	[#/paths/~1ccloud~1customers~1subscriptions/get/responses/200/content/application~1json/schema/properties/data/items]	false	none	none
»» id	number	false	none	none
»» customer_id	number	false	none	none
»» pool	string	false	none	none
»» name	string	false	none	none
»» display_name	string	false	none	none
»» confirmed	boolean	false	none	none
»» runtime	number	false	none	none
»» discount	number(double)	false	none	none
»» monthly_price	number(double)	false	none	none
»» setup_fee	number(double)	false	none	none
»» setup_fee_charged	boolean	false	none	none
»» valid_to	date	false	none	none
»» start_date	date	false	none	none
»» end_date	date	false	none	none
»» renew	boolean	false	none	none
»» data	object	false	none	none
»»» cores	number(double)	false	none	none
»»» memory	number(double)	false	none	none
»»» disk	number(double)	false	none	none
»»» support_hours	number	false	none	none
»»» full_backup	number	false	none	none
»»» licenses	[object]	false	none	none
»»»» id	number	false	none	none
»»»» count	number(double)	false	none	none
»»» addons	[object]	false	none	none
»»»» name	string(double)	false	none	none
»»»» count	number(double)	false	none	none
»» replacement	number¦null	false	none	none
»» created_at	string(date-time)	false	none	none
»» updated_at	string(date-time)	false	none	none
»» deleted_at	string(date-time)	false	none	none
»» tags	[string]	false	none	Array of tags the subscription belongs to.

Update display name for the Subscription.

Code samples

curl --request PUT \
  --url https://ccenter.internet1.de/api/v1/ccloud/subscriptions/0/customname \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"display_name":"Test"}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

payload = "{\"display_name\":\"Test\"}"

headers = {
    'Content-Type': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("PUT", "/api/v1/ccloud/subscriptions/0/customname", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/subscriptions/0/customname",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "{\"display_name\":\"Test\"}",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer {access-token}",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/subscriptions/0/customname' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"display_name":"Test"}'

PUT /ccloud/subscriptions/{id}/customname

Body parameter

{
  "display_name": "Test"
}

Parameters

Name	In	Type	Required	Description
id	path	integer	true	ID of the Subscription
body	body	object	true	none
» display_name	body	string	false	none

Responses

Status	Meaning	Description	Schema
204	No Content	No-Content	None

Returns the Details for a Subscription

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/subscriptions/0 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/subscriptions/0", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/subscriptions/0",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/subscriptions/0' -Method GET -Headers $headers

GET /ccloud/subscriptions/{id}

Body parameter

Parameters

Name	In	Type	Required	Description
id	path	integer	true	ID of the Subscription

Example responses

200 Response

{
  "id": 2,
  "customer_id": 328100,
  "pool": "pool_aw2_ssd",
  "name": "S328100-001",
  "display_name": "My Subscription",
  "confirmed": false,
  "runtime": 12,
  "discount": 10,
  "monthly_price": 500,
  "setup_fee": 50,
  "setup_fee_charged": true,
  "valid_to": "2024-06-01",
  "start_date": "2024-06-01",
  "end_date": "2025-06-01",
  "renew": false,
  "data": {
    "cores": 30,
    "memory": 64,
    "disk": 500,
    "support_hours": 6,
    "full_backup": 100,
    "licenses": [
      {
        "id": 12708,
        "count": 4
      }
    ],
    "addons": [
      {
        "name": "monitoring",
        "count": 4
      }
    ]
  },
  "replacement": 1,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "tags": [
    "string"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	number	false	none	none
» customer_id	number	false	none	none
» pool	string	false	none	none
» name	string	false	none	none
» display_name	string	false	none	none
» confirmed	boolean	false	none	none
» runtime	number	false	none	none
» discount	number(double)	false	none	none
» monthly_price	number(double)	false	none	none
» setup_fee	number(double)	false	none	none
» setup_fee_charged	boolean	false	none	none
» valid_to	date	false	none	none
» start_date	date	false	none	none
» end_date	date	false	none	none
» renew	boolean	false	none	none
» data	object	false	none	none
»» cores	number(double)	false	none	none
»» memory	number(double)	false	none	none
»» disk	number(double)	false	none	none
»» support_hours	number	false	none	none
»» full_backup	number	false	none	none
»» licenses	[object]	false	none	none
»»» id	number	false	none	none
»»» count	number(double)	false	none	none
»» addons	[object]	false	none	none
»»» name	string(double)	false	none	none
»»» count	number(double)	false	none	none
» replacement	number¦null	false	none	none
» created_at	string(date-time)	false	none	none
» updated_at	string(date-time)	false	none	none
» deleted_at	string(date-time)	false	none	none
» tags	[string]	false	none	Array of tags the subscription belongs to.

Import VM to a subscription

Code samples

curl --request POST \
  --url https://ccenter.internet1.de/api/v1/subscriptions/0/import \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"hostname":"ts12345"}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

payload = "{\"hostname\":\"ts12345\"}"

headers = {
    'Content-Type': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("POST", "/api/v1/subscriptions/0/import", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/subscriptions/0/import",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"hostname\":\"ts12345\"}",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer {access-token}",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/subscriptions/0/import' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"hostname":"ts12345"}'

POST /subscriptions/{id}/import

Body parameter

{
  "hostname": "ts12345"
}

Parameters

Name	In	Type	Required	Description
id	path	integer	true	ID of the Subscription
body	body	SubscriptionImportRequest	true	none

Responses

Status	Meaning	Description	Schema
204	No Content	VM imported to subscription	None

Export one server of a Subscription into its pool

Code samples

curl --request POST \
  --url https://ccenter.internet1.de/api/v1/subscriptions/0/export/string/pool \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = { 'Authorization': "Bearer {access-token}" }

conn.request("POST", "/api/v1/subscriptions/0/export/string/pool", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/subscriptions/0/export/string/pool",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/subscriptions/0/export/string/pool' -Method POST -Headers $headers

POST /subscriptions/{id}/export/{hostname}/pool

Parameters

Name	In	Type	Required	Description
id	path	integer	true	ID of the Subscription
hostname	path	string	true	Hostname of the Server to export

Responses

Status	Meaning	Description	Schema
204	No Content	VM exported into pool	None

Export all servers of a Subscription to another Subscription

Code samples

curl --request POST \
  --url https://ccenter.internet1.de/api/v1/subscriptions/0/export/all \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"target_subscription":"S328100-001"}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

payload = "{\"target_subscription\":\"S328100-001\"}"

headers = {
    'Content-Type': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("POST", "/api/v1/subscriptions/0/export/all", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/subscriptions/0/export/all",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"target_subscription\":\"S328100-001\"}",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer {access-token}",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/subscriptions/0/export/all' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"target_subscription":"S328100-001"}'

POST /subscriptions/{id}/export/all

Body parameter

{
  "target_subscription": "S328100-001"
}

Parameters

Name	In	Type	Required	Description
id	path	integer	true	ID of the Subscription
body	body	SubscriptionExportAllRequest	true	none

Responses

Status	Meaning	Description	Schema
204	No Content	All VMs exported to other subscription	None

Customers

Get the price of a pool for the given customer.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/customers/prices/pool_iw_ssd \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/customers/prices/pool_iw_ssd", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/customers/prices/pool_iw_ssd",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/customers/prices/pool_iw_ssd' -Method GET -Headers $headers

GET /ccloud/customers/prices/{pool}

Parameters

Name	In	Type	Required	Description
pool	path	string	true	Tag of the pool

Example responses

200 Response

{
  "cores": 0.1,
  "memory": 0.1,
  "disk": 0.1
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» cores	number(double)	false	none	none
» memory	number(double)	false	none	none
» disk	number(double)	false	none	none

Get a quote for a server with the given resources.

Code samples

curl --request POST \
  --url https://ccenter.internet1.de/api/v1/ccloud/customers/quotes \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"pool":"pool_iw_ssd","cores":0,"memory":0,"disk":0,"addons":[{"name":"string","count":0}],"ostype":"windows"}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

payload = "{\"pool\":\"pool_iw_ssd\",\"cores\":0,\"memory\":0,\"disk\":0,\"addons\":[{\"name\":\"string\",\"count\":0}],\"ostype\":\"windows\"}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("POST", "/api/v1/ccloud/customers/quotes", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/customers/quotes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"pool\":\"pool_iw_ssd\",\"cores\":0,\"memory\":0,\"disk\":0,\"addons\":[{\"name\":\"string\",\"count\":0}],\"ostype\":\"windows\"}",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/customers/quotes' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"pool":"pool_iw_ssd","cores":0,"memory":0,"disk":0,"addons":[{"name":"string","count":0}],"ostype":"windows"}'

POST /ccloud/customers/quotes

Body parameter

{
  "pool": "pool_iw_ssd",
  "cores": 0,
  "memory": 0,
  "disk": 0,
  "addons": [
    {
      "name": "string",
      "count": 0
    }
  ],
  "ostype": "windows"
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» pool	body	string	false	none
» cores	body	integer	false	none
» memory	body	integer	false	none
» disk	body	integer	false	none
» addons	body	[object]	false	none
»» name	body	string	false	none
»» count	body	integer	false	none
» ostype	body	string	false	OSType as given back from the os list

Example responses

200 Response

{
  "resources": {
    "cores": 0.1,
    "memory": 0.1,
    "disk": 0.1
  },
  "addons": {
    "additionalProperties": {
      "category": "string",
      "monthly_price": 0.1,
      "setup_fee": 0.1
    }
  },
  "licenses": {
    "additionalProperties": 0.1
  },
  "setup_fee_total": 0.1,
  "monthly_total": 0.1
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» resources	object	false	none	none
»» cores	number(double)	false	none	none
»» memory	number(double)	false	none	none
»» disk	number(double)	false	none	none
» addons	object	false	none	none
»» additionalProperties	object	false	none	none
»»» category	string	false	none	none
»»» monthly_price	number(double)	false	none	none
»»» setup_fee	number(double)	false	none	none
» licenses	object	false	none	none
»» additionalProperties	number(double)	false	none	none
» setup_fee_total	number(double)	false	none	none
» monthly_total	number(double)	false	none	none

Get customer invoices in short format.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/customers/invoices \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/customers/invoices", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/customers/invoices",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/customers/invoices' -Method GET -Headers $headers

GET /ccloud/customers/invoices

Example responses

200 Response

[
  {
    "id": 1323,
    "month": 11,
    "year": 2022,
    "total": 11.42
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Invoice Summary	Inline

Response Schema

Status Code 200

Summary of the invoices

Name	Type	Required	Restrictions	Description
» id	integer	false	none	none
» month	number	false	none	none
» year	number	false	none	none
» total	number(float)	false	none	none

Get all scheduled servers.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/customers/scheduled \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/customers/scheduled", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/customers/scheduled",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/customers/scheduled' -Method GET -Headers $headers

GET /ccloud/customers/scheduled

Example responses

200 Response

[
  {
    "hostname": "ts10000",
    "frequency": 1,
    "next_run": "2019-08-24T14:15:22Z"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Scheduled Summary	Inline

Response Schema

Status Code 200

Get all scheduled servers

Name	Type	Required	Restrictions	Description
» hostname	string	false	none	none
» frequency	string	false	none	none
» next_run	string(date-time)	false	none	none

Enumerated Values

Property	Value
frequency	1
frequency	3
frequency	6
frequency	12
frequency	24

Get all customer addons

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/customers/addons \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/customers/addons", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/customers/addons",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/customers/addons' -Method GET -Headers $headers

GET /ccloud/customers/addons

Example responses

200 Response

[
  [
    {
      "name": "string",
      "count": 1
    }
  ]
]

Responses

Status	Meaning	Description	Schema
200	OK	Customer Addons	Inline

Response Schema

Status Code 200

Get all customer addons

Name	Type	Required	Restrictions	Description
» name	string	false	none	none
» count	integer	false	none	none

Setup the given addon for the customer.

Code samples

curl --request PUT \
  --url https://ccenter.internet1.de/api/v1/ccloud/customers/addons/report \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"count":0}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

payload = "{\"count\":0}"

headers = {
    'Content-Type': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("PUT", "/api/v1/ccloud/customers/addons/report", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/customers/addons/report",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "{\"count\":0}",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer {access-token}",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/customers/addons/report' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"count":0}'

PUT /ccloud/customers/addons/{addon}

Body parameter

{
  "count": 0
}

Parameters

Name	In	Type	Required	Description
addon	path	string	true	Name of the addon to add.
body	body	object	false	none
» count	body	integer	false	Amount to book for the addon. Defaults to 1 if not given.

Enumerated Values

Parameter	Value
addon	report

Responses

Status	Meaning	Description	Schema
204	No Content	No-Content	None

Delete the given addon for the customer.

Code samples

curl --request DELETE \
  --url https://ccenter.internet1.de/api/v1/ccloud/customers/addons/report \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = { 'Authorization': "Bearer {access-token}" }

conn.request("DELETE", "/api/v1/ccloud/customers/addons/report", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/customers/addons/report",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/customers/addons/report' -Method DELETE -Headers $headers

DELETE /ccloud/customers/addons/{addon}

Parameters

Name	In	Type	Required	Description
addon	path	string	true	Name of the addon to delete.

Enumerated Values

Parameter	Value
addon	report

Responses

Status	Meaning	Description	Schema
204	No Content	No-Content	None

Get all available reports

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/customers/reports \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/customers/reports", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/customers/reports",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/customers/reports' -Method GET -Headers $headers

GET /ccloud/customers/reports

Example responses

200 Response

[
  [
    "2023-09"
  ]
]

Responses

Status	Meaning	Description	Schema
200	OK	Customer Addon Report	Inline

Response Schema

Status Code 200

Get all available reports

Name	Type	Required	Restrictions	Description

Get report pdf by date

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/customers/reports/ \
  --header 'Accept: application/pdf' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/pdf",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/customers/reports/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/customers/reports/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/pdf",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/pdf")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/customers/reports/' -Method GET -Headers $headers

GET /ccloud/customers/reports/{date}

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Customer Addon Report	file

Get customer invoice with details

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/customers/invoices/0 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/customers/invoices/0", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/customers/invoices/0",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/customers/invoices/0' -Method GET -Headers $headers

GET /ccloud/customers/invoices/{invoice_id}

Parameters

Name	In	Type	Required	Description
invoice_id	path	integer	false	none
tag	path	string	false	none

Example responses

200 Response

[
  {
    "id": 0,
    "month": 0,
    "year": 0,
    "total": 0,
    "customer_id": 0,
    "details": {
      "pools": {
        "worker": {
          "servers": {
            "property1": "string",
            "property2": "string"
          },
          "total": "string"
        },
        "performance": {
          "servers": {
            "property1": "string",
            "property2": "string"
          },
          "total": "string"
        },
        "total": "string"
      },
      "subscriptions": {
        "S328100-001": {
          "total": "string"
        },
        "S328100-002": {
          "total": "string"
        },
        "total": "string"
      },
      "total": "string"
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Invoice Summary	Inline

Response Schema

Status Code 200

Summary of the invoices

Name	Type	Required	Restrictions	Description
anonymous	[allOf]	false	none	Summary of the invoices
» id	number	false	none	none
» month	number	false	none	none
» year	number	false	none	none
» total	number	false	none	none
» customer_id	number	false	none	none
» details	CustomerInvoice/allOf/0/properties/details	false	none	none
»» pools	object	false	none	none
»»» worker	object	false	none	none
»»»» servers	object	false	none	none
»»»»» additionalProperties	string	false	none	none
»»»» total	string	false	none	none
»»» performance	object	false	none	none
»»»» servers	object	false	none	none
»»»»» additionalProperties	string	false	none	none
»»»» total	string	false	none	none
»»» total	string	false	none	none
»» subscriptions	object	false	none	none
»»» S328100-001	object	false	none	none
»»»» total	string	false	none	none
»»» S328100-002	object	false	none	none
»»»» total	string	false	none	none
»»» total	string	false	none	none
»» total	string	false	none	none

Get customer invoice preview of the current month

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/customers/invoices/preview \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/customers/invoices/preview", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/customers/invoices/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/customers/invoices/preview' -Method GET -Headers $headers

GET /ccloud/customers/invoices/preview

Parameters

Name	In	Type	Required	Description
invoice_id	path	integer	false	none
tag	path	string	false	none

Example responses

200 Response

[
  {
    "pools": {
      "worker": {
        "servers": {
          "property1": "string",
          "property2": "string"
        },
        "total": "string"
      },
      "performance": {
        "servers": {
          "property1": "string",
          "property2": "string"
        },
        "total": "string"
      },
      "total": "string"
    },
    "subscriptions": {
      "S328100-001": {
        "total": "string"
      },
      "S328100-002": {
        "total": "string"
      },
      "total": "string"
    },
    "total": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Invoice Summary	Inline

Response Schema

Status Code 200

Summary of the invoices

Name	Type	Required	Restrictions	Description
anonymous	[CustomerInvoice/allOf/0/properties/details]	false	none	Summary of the invoices
» pools	object	false	none	none
»» worker	object	false	none	none
»»» servers	object	false	none	none
»»»» additionalProperties	string	false	none	none
»»» total	string	false	none	none
»» performance	object	false	none	none
»»» servers	object	false	none	none
»»»» additionalProperties	string	false	none	none
»»» total	string	false	none	none
»» total	string	false	none	none
» subscriptions	object	false	none	none
»» S328100-001	object	false	none	none
»»» total	string	false	none	none
»» S328100-002	object	false	none	none
»»» total	string	false	none	none
»» total	string	false	none	none
» total	string	false	none	none

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/customers/monitoring \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/customers/monitoring", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/customers/monitoring",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/customers/monitoring' -Method GET -Headers $headers

GET /ccloud/customers/monitoring

Example responses

200 Response

{
  "url": "string"
}

Status	Meaning	Description	Schema
200	OK	Returns the login URL for your monitoring.	Monitoring

Various

Get a list of available os configuration

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/os \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/os", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/os",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/os' -Method GET -Headers $headers

GET /ccloud/os

Example responses

200 Response

{
  "name": "Linux Debian 11",
  "image": "stretch_uefi",
  "min_disk": "5",
  "language": "en-US",
  "ostype": "Windows",
  "cloud_init_support": true
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	OSConfiguration

Get a list of available Addons

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/addons \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/addons", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/addons",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/addons' -Method GET -Headers $headers

GET /ccloud/addons

Example responses

200 Response

[
  {
    "id": 1,
    "name": "cprotect",
    "supported_os": [
      "ubuntu-22"
    ],
    "addable": true,
    "deletable": true,
    "desc_de": "Dieses Addon bietet eine Hochverfügbarkeit der VM",
    "desc_en": "This addon provides high availability of the VM",
    "price": 9.99,
    "setup_fee": 9.99
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Success	AddonsList

Get a list of available Rollouts

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/rollouts \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/rollouts", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/rollouts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/rollouts' -Method GET -Headers $headers

GET /ccloud/rollouts

Example responses

200 Response

{
  "type": "ansible",
  "rollout": "app_apache",
  "name": "Apache2 Webserver",
  "desc_de": "Der Apache HTTP Server ist ein quelloffenes und freies Produkt der Apache Software Foundation und einer der meistbenutzten Webserver im Internet.",
  "desc_en": "The Apache HTTP Server is an open source and free product from the Apache Software Foundation and one of the most widely used web servers on the Internet.",
  "valid_for": [
    "buster_uefi"
  ],
  "depends_on": [
    "base_rollout"
  ],
  "managed_only": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ServerRollouts

Misc

Get Translations for CCloud Frontend

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/lang \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = { 'Authorization': "Bearer {access-token}" }

conn.request("GET", "/api/v1/ccloud/lang", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/lang",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/lang' -Method GET -Headers $headers

GET /ccloud/lang

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Get Config Values for CCloud Frontend

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/config \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = { 'Authorization': "Bearer {access-token}" }

conn.request("GET", "/api/v1/ccloud/config", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/config",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/config' -Method GET -Headers $headers

GET /ccloud/config

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Get resource infos for deploying a new VM.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/resource-info \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/ccloud/resource-info", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/ccloud/resource-info",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/ccloud/resource-info' -Method GET -Headers $headers

GET /ccloud/resource-info

Example responses

200 Response

{
  "resources_limited": true,
  "usage": {
    "cores": 2,
    "memory": 2,
    "disk": 100
  },
  "limits": {
    "cores": 2,
    "memory": 2,
    "disk": 100
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Resource Infos	ResourceInfo

Licenses

Get all available license products.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/licenses \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

import http.client

conn = http.client.HTTPSConnection("ccenter.internet1.de")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer {access-token}"
    }

conn.request("GET", "/api/v1/licenses", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ccenter.internet1.de/api/v1/licenses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {access-token}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Bearer {access-token}")
$response = Invoke-WebRequest -Uri 'https://ccenter.internet1.de/api/v1/licenses' -Method GET -Headers $headers

GET /licenses

Example responses

200 Response

[
  {
    "id": 999,
    "title": "Microsoft SQL Server 2017 Standard",
    "price": 9.99
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Ok	Licenses

Schemas

OAuth

{
  "grant_type": "client_credentials",
  "client_id": "90f63c80-bd90-89a3-4632-b16c4ab909ae",
  "client_secret": "GsqCDfjYUCceU8dTq1vQWxLnnRaf6UySWP7GAgI",
  "scope": "*"
}

Properties

Name	Type	Required	Restrictions	Description
grant_type	string	false	none	none
client_id	string(uuid)	false	none	none
client_secret	string(password)	false	none	none
scope	string	false	none	none

OSConfiguration

{
  "name": "Linux Debian 11",
  "image": "stretch_uefi",
  "min_disk": "5",
  "language": "en-US",
  "ostype": "Windows",
  "cloud_init_support": true
}

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
image	string	false	none	Internal centron image name.
min_disk	string	false	none	none
language	string	false	none	none
ostype	string	false	none	none
cloud_init_support	boolean	false	none	none

Addon

{
  "name": "string",
  "count": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
count	integer	false	none	none

AddonsList

[
  {
    "id": 1,
    "name": "cprotect",
    "supported_os": [
      "ubuntu-22"
    ],
    "addable": true,
    "deletable": true,
    "desc_de": "Dieses Addon bietet eine Hochverfügbarkeit der VM",
    "desc_en": "This addon provides high availability of the VM",
    "price": 9.99,
    "setup_fee": 9.99
  }
]

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
name	string	false	none	none
supported_os	[string]	false	none	none
addable	boolean	false	none	none
deletable	boolean	false	none	none
desc_de	string	false	none	none
desc_en	string	false	none	none
price	number(double)	false	none	none
setup_fee	number(double)	false	none	none

getPassword

{
  "username": "string",
  "password": "string"
}

Properties

Name	Type	Required	Restrictions	Description
username	string	false	none	none
password	string	false	none	none

OAuthResponse

{
  "token_type": "Bearer",
  "expires_in": 31536000,
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Properties

Name	Type	Required	Restrictions	Description
token_type	string	false	none	none
expires_in	integer	false	none	none
access_token	string	false	none	none

VMDVDModel

{
  "id": "string",
  "path": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string¦null	false	none	none
path	string¦null	false	none	none

DeleteDVDTaskResponse

{
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none

UpdateDVDTaskResponse

{
  "id": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "path": "string",
      "hostname": "string",
      "customer_id": "string",
      "username": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
data	[object]	false	none	none
» id	string	false	none	none
» name	string	false	none	Filename of the ISO Image
» path	string	false	none	Path of the ISO Image
» hostname	string	false	none	Hostname of the Server
» customer_id	string	false	none	Customer ID submitting the request.
» username	string	false	none	Username submitting the request.

VMNetModel

{
  "id": "string",
  "switch": "string",
  "vlan": 0,
  "mac_spoofing": true,
  "bandwith": 0,
  "ipAdresse": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	string¦null	false	none	none
switch	string¦null	false	none	none
vlan	integer(int32)	false	none	none
mac_spoofing	boolean	false	none	none
bandwith	integer(int64)	false	none	none
ipAdresse	[string]¦null	false	none	none

VMNetworkAddIPRequest

{
  "protocol": "IPv4"
}

Properties

Name	Type	Required	Restrictions	Description
protocol	string	false	none	none

Enumerated Values

Property	Value
protocol	IPv4
protocol	IPv6

VMNetworkAddIPResponse

{
  "type": "IPv6",
  "ip_address": "2a00:6140:a000:72::b",
  "network": "2a00:6140:a000:72::",
  "mask_bits": 64,
  "nameservers": [
    "2a00:6140:a000:72::1"
  ],
  "gateway": "2a00:6140:a000:72::1",
  "vlan": 708
}

Properties

Name	Type	Required	Restrictions	Description
type	string	false	none	none
ip_address	string	false	none	IP address added to the Interface
network	string	false	none	Network of the IP address
mask_bits	integer	false	none	Mask Bits of the Subnet
nameservers	[string]	false	none	Array with the IP adresses of the nameservers
gateway	string	false	none	Gateway of the Subnet
vlan	integer	false	none	VLAN Number of the Subnet

VMDVDAddModel

{
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	Filename of the ISO Image

AddedDVDTaskResponse

{
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	Task id

OAuthFailure

{
  "error": "string",
  "error_description": "string",
  "hint": "string",
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
error	string	false	none	none
error_description	string	false	none	none
hint	string	false	none	none
message	string	false	none	none

OAuthBadRequestResponse

{
  "error": "unsupported_grant_type",
  "error_description": "The authorization grant type is not supported by the authorization server.",
  "hint": "Check that all required parameters have been provided",
  "message": "The authorization grant type is not supported by the authorization server."
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	OAuthFailure	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

OAuthUnauthorizedResponse

{
  "error": "invalid_client",
  "error_description": "Client authentication failed",
  "message": "Client authentication failed"
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	OAuthFailure	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

PaginationLinks

{
  "first": "http://example.com",
  "last": "http://example.com",
  "prev": "http://example.com",
  "next": "http://example.com"
}

Properties

Name	Type	Required	Restrictions	Description
first	string(uri)	false	none	none
last	string(uri)	false	none	none
prev	string(uri)	false	none	none
next	string(uri)	false	none	none

PaginationMetadata

{
  "current_page": 0,
  "from": 0,
  "last_page": 0,
  "path": "http://example.com",
  "per_page": 0,
  "to": 0,
  "total": 0
}

Properties

Name	Type	Required	Restrictions	Description
current_page	integer	false	none	none
from	integer	false	none	none
last_page	integer	false	none	none
path	string(uri)	false	none	none
per_page	integer	false	none	none
to	integer	false	none	none
total	integer	false	none	none

DeploymentCreateRequest

{
  "pool": "string",
  "hostname": "string",
  "description": "string",
  "cores": 0,
  "memory": 0,
  "disks": [
    0
  ],
  "image": "string",
  "custom_name": "string",
  "password": "string",
  "sshkey": "string",
  "user_data": "#cloud-config\nruncmd:\n- [touch, /root/cloud-init-worked]\n",
  "type": "managed",
  "addons": [
    {
      "name": "string",
      "count": 0
    }
  ],
  "subnets": [
    0
  ],
  "subnets_intern": [
    0
  ],
  "tags": [
    "string"
  ],
  "rollouts": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
pool	string	true	none	none
hostname	string	false	none	none
description	string	false	none	none
cores	integer	true	none	Amount of cores
memory	integer	true	none	Amount of RAM in GB
disks	[integer]	true	none	Disk Sizes in GB
image	string	true	none	ctempl image
custom_name	string	false	none	Custom name
password	string	false	none	root (Linux) or Administrator (Windows) Password for the new Server with minimum 8 characters
sshkey	string	false	none	public ssh key for the new Server
user_data	string	false	none	Custom Cloud-Init instructions.
type	string	true	none	none
addons	[Addon]	false	none	Addons for this Server
subnets	[integer]	false	none	IPv4 and IPv6 subnet to use for this server (specified by their ID´s). Only one IPv4 and one IPv6 subnet is allowed.
subnets_intern	[integer]	false	none	IPv4 and IPv6 subnet IDs for the LAN interface. This option is only available for pfSense systems and only one IPv4 and IPv6 subnet is allowed.
tags	[string]	false	none	Tags which are to be set for the server.
rollouts	[string]	false	none	Optional Rollouts for Software to be installed on the new Server

Enumerated Values

Property	Value
type	managed
type	unmanaged

Pool

{
  "nagios_active": true,
  "gpu_supported": true,
  "tag": "string",
  "name": "string",
  "desc_de": "string",
  "desc_en": "string"
}

Properties

Name	Type	Required	Restrictions	Description
nagios_active	boolean	false	none	none
gpu_supported	boolean	false	none	none
tag	string	false	none	none
name	string	false	none	none
desc_de	string	false	none	none
desc_en	string	false	none	none

DeploymentCreateRequestSuccess

{
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	true	none	none

LaravelValidationFailure

{
  "errors": {
    "property1": "string",
    "property2": "string"
  },
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
errors	object	false	none	none
» additionalProperties	string	false	none	none
message	string	false	none	none

Error

{
  "error": {
    "errors": {},
    "code": 0,
    "msg": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
error	object	false	none	none
» errors	object	false	none	none
» code	integer	false	none	none
» msg	string	false	none	none

SubError

{}

Properties

None

TasksGetStatus

{
  "id": 0,
  "action": "create-server",
  "customer_id": "string",
  "username": "string",
  "hostname": "string",
  "status": "processing",
  "error_message": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
action	string	false	none	none
customer_id	string	false	none	none
username	string	false	none	none
hostname	string	false	none	none
status	string	false	none	none
error_message	string	false	none	none
created_at	string(date-time)	false	none	none

Enumerated Values

Property	Value
action	create-server
action	resize-server
action	start-server
action	stop-server
action	restart-server
action	delete-server
action	add-networkadpater
action	set-networkadapter
action	delete-networkadapter
action	add-disk-server
action	delete-disk-server
status	processing
status	failed
status	done

TasksGetCoresStatus

{
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none

TaskID

{
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none

GetISOs

{
  "name": "string",
  "fullName": "string",
  "customer": "string",
  "size": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	true	none	none
fullName	string¦null	true	none	none
customer	string¦null	false	none	none
size	integer(int64)	true	none	none

TaskResponse

{
  "id": 0,
  "job_id": "string",
  "action": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
job_id	string	false	none	none
action	string	false	none	none

ServerAddons

{
  "id": 0,
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
name	string	false	none	none

ServerCreateSnapshotRequest

{
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none

ServerResizeMemoryRequest

{
  "memory": 0
}

Properties

Name	Type	Required	Restrictions	Description
memory	integer	true	none	Amount of RAM in GB

ServerResizeCoresRequest

{
  "cores": 0
}

Properties

Name	Type	Required	Restrictions	Description
cores	integer	true	none	Amount of Cores

Server

{
  "id": 0,
  "customer_id": "string",
  "hostname": "string",
  "generation": 0,
  "created_at": "2019-08-24",
  "tags": [
    "string"
  ],
  "location": "string",
  "custom_name": "string",
  "credentials_available": true,
  "deletion_in_progress": true,
  "build_in_progress": true,
  "rootaccess": true,
  "network_adapters": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "server_id": 0,
      "vlan_number": 0,
      "bandwidth": 0,
      "switch": "string",
      "mac_address": "string",
      "mac_spoofing": true,
      "perf_counter_instance_name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "ip_addresses": [
        {
          "id": 0,
          "server_id": 0,
          "network_adapter_id": "08e934e8-2799-4546-ac08-238367e755eb",
          "subnet_id": 0,
          "customer_id": "string",
          "ip": "string",
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z",
          "subnet": {
            "id": 0,
            "customer_id": "string",
            "type": "IPv4",
            "network": "string",
            "gateway": "string",
            "mask_bits": 0,
            "nameservers": [
              "string"
            ],
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z"
          }
        }
      ]
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	ID of the server.
customer_id	string	false	none	Customer number.
hostname	string	false	none	Hostname of the server.
generation	integer	false	none	VM generation of the server.
created_at	string(date)	false	none	Date server entry was created.
tags	[string]	false	none	Array of tags attached to the server.
location	string	false	none	Location string from d42
custom_name	string	false	none	Customer defined Server Name
credentials_available	boolean	false	none	Server credentials available
deletion_in_progress	boolean	false	none	Whether a delete job for the given server is currently planned/running.
build_in_progress	boolean	false	none	Whether a build job for the given server is currently planned/running.
rootaccess	boolean	false	none	See if the customer have permissions for root access.
network_adapters	[allOf]	false	none	none

allOf

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none
»» id	string(uuid)	false	none	none
»» server_id	integer	false	none	none
»» vlan_number	integer	false	none	none
»» bandwidth	integer	false	none	Bandwith in MBit/s
»» switch	string	false	none	none
»» mac_address	string	false	none	none
»» mac_spoofing	boolean	false	none	none
»» perf_counter_instance_name	string	false	none	none
»» created_at	string(date-time)	false	none	none
»» updated_at	string(date-time)	false	none	none

and

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none
»» ip_addresses	[allOf]	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	integer	false	none	none
»»»» server_id	integer	false	none	none
»»»» network_adapter_id	string(uuid)	false	none	none
»»»» subnet_id	integer	false	none	none
»»»» customer_id	string	false	none	none
»»»» ip	string	false	none	none
»»»» created_at	string(date-time)	false	none	none
»»»» updated_at	string(date-time)	false	none	none

and

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» subnet	Subnet	false	none	none

ServerDetail

{
  "id": 0,
  "customer_id": "string",
  "hostname": "string",
  "generation": 0,
  "created_at": "2019-08-24",
  "tags": [
    "string"
  ],
  "location": "string",
  "custom_name": "string",
  "credentials_available": true,
  "deletion_in_progress": true,
  "build_in_progress": true,
  "rootaccess": true,
  "network_adapters": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "server_id": 0,
      "vlan_number": 0,
      "bandwidth": 0,
      "switch": "string",
      "mac_address": "string",
      "mac_spoofing": true,
      "perf_counter_instance_name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "ip_addresses": [
        {
          "id": 0,
          "server_id": 0,
          "network_adapter_id": "08e934e8-2799-4546-ac08-238367e755eb",
          "subnet_id": 0,
          "customer_id": "string",
          "ip": "string",
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z",
          "subnet": {
            "id": 0,
            "customer_id": "string",
            "type": "IPv4",
            "network": "string",
            "gateway": "string",
            "mask_bits": 0,
            "nameservers": [
              "string"
            ],
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z"
          }
        }
      ]
    }
  ],
  "data": {
    "cores": 0,
    "memory": 0,
    "disk": 0,
    "pool": "string",
    "type": "unmanaged",
    "os_name": "string",
    "ostype": "Windows",
    "hostname": "string",
    "username": "user@example.com",
    "customer_id": "string",
    "description": "string",
    "notes": "string",
    "addons": [
      {
        "name": "string",
        "count": 0
      }
    ]
  }
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	Server	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	ServerData	false	none	none

ServerDetailInclCustomPriceFlag

{
  "id": 0,
  "customer_id": "string",
  "hostname": "string",
  "generation": 0,
  "created_at": "2019-08-24",
  "tags": [
    "string"
  ],
  "location": "string",
  "custom_name": "string",
  "credentials_available": true,
  "deletion_in_progress": true,
  "build_in_progress": true,
  "rootaccess": true,
  "network_adapters": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "server_id": 0,
      "vlan_number": 0,
      "bandwidth": 0,
      "switch": "string",
      "mac_address": "string",
      "mac_spoofing": true,
      "perf_counter_instance_name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "ip_addresses": [
        {
          "id": 0,
          "server_id": 0,
          "network_adapter_id": "08e934e8-2799-4546-ac08-238367e755eb",
          "subnet_id": 0,
          "customer_id": "string",
          "ip": "string",
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z",
          "subnet": {
            "id": 0,
            "customer_id": "string",
            "type": "IPv4",
            "network": "string",
            "gateway": "string",
            "mask_bits": 0,
            "nameservers": [
              "string"
            ],
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z"
          }
        }
      ]
    }
  ],
  "data": {
    "cores": 0,
    "memory": 0,
    "disk": 0,
    "pool": "string",
    "type": "unmanaged",
    "os_name": "string",
    "ostype": "Windows",
    "hostname": "string",
    "username": "user@example.com",
    "customer_id": "string",
    "description": "string",
    "notes": "string",
    "addons": [
      {
        "name": "string",
        "count": 0
      }
    ]
  },
  "custom_price": true
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ServerDetail	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» custom_price	boolean	false	none	See if the server have a custom price.

AddedSnapshotTaskResponse

{
  "type": "object",
  "properties": null,
  "id": {
    "type": "integer",
    "example": 0
  },
  "data": {
    "type": "array",
    "items": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "example": "string"
        },
        "hostname": {
          "type": "string",
          "example": "string",
          "description": "Hostname of the Server"
        },
        "customer_id": {
          "type": "string",
          "example": "string",
          "description": "Customer ID submitting the request."
        },
        "username": {
          "type": "string",
          "example": "string",
          "description": "Username submitting the request."
        }
      }
    }
  }
}

Properties

None

RenameSnapshotTaskResponse

{
  "type": "object",
  "properties": null,
  "id": {
    "type": "integer",
    "example": 0
  },
  "data": {
    "type": "array",
    "items": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "string"
        },
        "name": {
          "type": "string",
          "example": "string"
        },
        "hostname": {
          "type": "string",
          "example": "string",
          "description": "Hostname of the Server"
        },
        "customer_id": {
          "type": "string",
          "example": "string",
          "description": "Customer ID submitting the request."
        },
        "username": {
          "type": "string",
          "example": "string",
          "description": "Username submitting the request."
        }
      }
    }
  }
}

Properties

None

DeleteSnapshotTaskResponse

{
  "type": "object",
  "properties": null,
  "id": {
    "type": "integer",
    "example": 0
  },
  "data": {
    "type": "array",
    "items": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "string"
        },
        "hostname": {
          "type": "string",
          "example": "string",
          "description": "Hostname of the Server"
        },
        "customer_id": {
          "type": "string",
          "example": "string",
          "description": "Customer ID submitting the request."
        },
        "username": {
          "type": "string",
          "example": "string",
          "description": "Username submitting the request."
        }
      }
    }
  }
}

Properties

None

RestoreSnapshotTaskResponse

{
  "type": "object",
  "properties": null,
  "id": {
    "type": "integer",
    "example": 0
  },
  "data": {
    "type": "array",
    "items": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "string"
        },
        "hostname": {
          "type": "string",
          "example": "string",
          "description": "Hostname of the Server"
        },
        "customer_id": {
          "type": "string",
          "example": "string",
          "description": "Customer ID submitting the request."
        },
        "username": {
          "type": "string",
          "example": "string",
          "description": "Username submitting the request."
        }
      }
    }
  }
}

Properties

None

ServerRenameSnapshotRequest

{
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none

ServerData

{
  "cores": 0,
  "memory": 0,
  "disk": 0,
  "pool": "string",
  "type": "unmanaged",
  "os_name": "string",
  "ostype": "Windows",
  "hostname": "string",
  "username": "user@example.com",
  "customer_id": "string",
  "description": "string",
  "notes": "string",
  "addons": [
    {
      "name": "string",
      "count": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
cores	integer	false	none	Amount of cores the server has.
memory	integer	false	none	Amount of RAM the server has.
disk	integer	false	none	Disk size of server.
pool	string	false	none	Pool the server belongs to.
type	string	false	none	Type of the server.
os_name	string	false	none	Name of the OS.
ostype	string	false	none	none
hostname	string	false	none	Hostname of the given server.
username	string(email)	false	none	Username of person who deployed the server.
customer_id	string	false	none	Customer number the server belongs to.
description	string	false	none	Description of the server.
notes	string	false	none	Notes of the server.
addons	[Addon]	false	none	Addons assigned to the server.

Enumerated Values

Property	Value
type	unmanaged
type	managed

TagsForCustomer

[
  "development",
  "production"
]

Array of tags.

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	Array of tags.

ServerTags

[
  "development",
  "production"
]

Array of tags.

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	Array of tags.

Console

{
  "url": "string"
}

Properties

Name	Type	Required	Restrictions	Description
url	string	true	none	none

Monitoring

{
  "url": "string"
}

Properties

Name	Type	Required	Restrictions	Description
url	string	false	none	none

VMDiskUpdateModel

{
  "size": 50
}

Properties

Name	Type	Required	Restrictions	Description
size	integer	true	none	Amount of Disk in GB

UpdateTaskResponse

{
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none

PerfomanceDataModel

{
  "type": "object",
  "properties": null,
  "data": {
    "type": "array",
    "items": {
      "type": "object",
      "properties": {
        "units": {
          "type": "integer",
          "format": "string",
          "example": "Byte/s",
          "description": "The Units of the Performance Data given back"
        },
        "perfdata": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "send_persec": {
                "type": "integer",
                "example": 54,
                "description": "Example of Performance Data given back, this elements can change depending on what data is requested"
              }
            }
          }
        }
      }
    }
  }
}

Properties

None

VMDiskModel

{
  "id": "string",
  "size": 0,
  "perfCounterInstancename": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
size	integer	false	none	none
perfCounterInstancename	string	false	none	none

ServerNotesRequest

{
  "notes": "This is my Database Server"
}

Properties

Name	Type	Required	Restrictions	Description
notes	string	true	none	none

UpdateBootOrderResponse

{
  "type": "object",
  "properties": null,
  "id": {
    "type": "integer",
    "example": 1554
  },
  "data": {
    "type": "array",
    "items": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32",
          "example": 1,
          "description": "Order ID of the Device"
        },
        "hostname": {
          "type": "string",
          "example": "ts123454",
          "description": "Hostname of the Server"
        },
        "customer_id": {
          "type": "string",
          "example": "328100",
          "description": "Customer ID submitting the request."
        },
        "username": {
          "type": "string",
          "example": "entwickler@centron.de",
          "description": "Username submitting the request."
        }
      }
    }
  }
}

Properties

None

changeBootOrderRequest

{
  "type": "object",
  "properties": null,
  "id": {
    "type": "integer",
    "example": 2
  }
}

Properties

None

BootOrderModel

{
  "id": 1,
  "type": "DVD",
  "bootDevice": "sc0s1"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	none	Order ID of the Device
type	string¦null	false	none	Type of the Device
bootDevice	string¦null	false	none	Device Name of the Device

ResourceInfo

{
  "resources_limited": true,
  "usage": {
    "cores": 2,
    "memory": 2,
    "disk": 100
  },
  "limits": {
    "cores": 2,
    "memory": 2,
    "disk": 100
  }
}

Properties

Name	Type	Required	Restrictions	Description
resources_limited	boolean	false	none	Are there resource limits for the given customer or not. The limits field contain the maximum possible resources.
usage	object	false	none	none
» cores	integer(int32)	false	none	Number of used CPU cores.
» memory	integer(int32)	false	none	Number of used GB of memory.
» disk	integer(int32)	false	none	Amount of used GB of disk space.
limits	object	false	none	none
» cores	integer(int32)	false	none	Number of available CPU cores.
» memory	integer(int32)	false	none	Number of available GB of memory.
» disk	integer(int32)	false	none	Amount of available GB of disk space.

Subnet

{
  "id": 0,
  "customer_id": "string",
  "type": "IPv4",
  "network": "string",
  "gateway": "string",
  "mask_bits": 0,
  "nameservers": [
    "string"
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
customer_id	string	false	none	none
type	string	false	none	none
network	string	false	none	none
gateway	string	false	none	none
mask_bits	integer	false	none	none
nameservers	[string]	false	none	none
created_at	string(date-time)	false	none	none
updated_at	string(date-time)	false	none	none

Enumerated Values

Property	Value
type	IPv4
type	IPv6

NetworkVPC

{
  "id": "string",
  "type": "string",
  "name": "string",
  "subnets": [
    [
      {
        "id": 2,
        "type": "IPv4",
        "name": "string",
        "network": "192.168.232.0",
        "gateway": "192.168.232.1",
        "mask_bits": 24,
        "nameservers": [
          [
            "192.168.232.1"
          ]
        ]
      }
    ]
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
type	string(public,private)	false	none	none
name	string	false	none	none
subnets	[NetworkSubnets]	false	none	none

NetworkSubnets

[
  {
    "id": 2,
    "type": "IPv4",
    "name": "string",
    "network": "192.168.232.0",
    "gateway": "192.168.232.1",
    "mask_bits": 24,
    "nameservers": [
      [
        "192.168.232.1"
      ]
    ]
  }
]

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	ID of the subnet
type	string	false	none	Subnet Type IPv4 or IPv6
name	string	false	none	Name of the subnet
network	string	false	none	Network of the subnet.
gateway	string	false	none	Subnet Gateway IP
mask_bits	string	false	none	Mask bits of the subnet
nameservers	[string]	false	none	none

Enumerated Values

Property	Value
type	IPv4
type	IPv6

NetworkIPs

{
  "hostname": "ts1000",
  "ip": "1.1.1.1",
  "subnetname": "VLAN_1"
}

Properties

Name	Type	Required	Restrictions	Description
hostname	string	false	none	none
ip	string	false	none	none
subnetname	string	false	none	none

NetworkIP

{
  "id": 0,
  "server_id": 0,
  "network_adapter_id": 0,
  "subnet_id": 0,
  "ip": "255.255.255.0",
  "hostname": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
server_id	integer	false	none	none
network_adapter_id	integer	false	none	none
subnet_id	integer	false	none	none
ip	string	false	none	none
hostname	string	false	none	none
created_at	string(date-time)	false	none	none
updated_at	string(date-time)	false	none	none

SubscriptionImportRequest

{
  "hostname": "ts12345"
}

Properties

Name	Type	Required	Restrictions	Description
hostname	string	false	none	hostname of the server to import

SubscriptionExportAllRequest

{
  "target_subscription": "S328100-001"
}

Properties

Name	Type	Required	Restrictions	Description
target_subscription	string	false	none	none

ServerRollouts

{
  "type": "ansible",
  "rollout": "app_apache",
  "name": "Apache2 Webserver",
  "desc_de": "Der Apache HTTP Server ist ein quelloffenes und freies Produkt der Apache Software Foundation und einer der meistbenutzten Webserver im Internet.",
  "desc_en": "The Apache HTTP Server is an open source and free product from the Apache Software Foundation and one of the most widely used web servers on the Internet.",
  "valid_for": [
    "buster_uefi"
  ],
  "depends_on": [
    "base_rollout"
  ],
  "managed_only": true
}

Properties

Name	Type	Required	Restrictions	Description
type	string	false	none	none
rollout	string	false	none	none
name	string	false	none	none
desc_de	string	false	none	none
desc_en	string	false	none	none
valid_for	[string]	false	none	none
depends_on	[string]	false	none	none
managed_only	boolean	false	none	none

Enumerated Values

Property	Value
type	ansible
type	dsc

CustomerInvoice

{
  "id": 0,
  "month": 0,
  "year": 0,
  "total": 0,
  "customer_id": 0,
  "details": {
    "pools": {
      "worker": {
        "servers": {
          "property1": "string",
          "property2": "string"
        },
        "total": "string"
      },
      "performance": {
        "servers": {
          "property1": "string",
          "property2": "string"
        },
        "total": "string"
      },
      "total": "string"
    },
    "subscriptions": {
      "S328100-001": {
        "total": "string"
      },
      "S328100-002": {
        "total": "string"
      },
      "total": "string"
    },
    "total": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
id	number	false	none	none
month	number	false	none	none
year	number	false	none	none
total	number	false	none	none
customer_id	number	false	none	none
details	object	false	none	none
» pools	object	false	none	none
»» worker	object	false	none	none
»»» servers	object	false	none	none
»»»» additionalProperties	string	false	none	none
»»» total	string	false	none	none
»» performance	object	false	none	none
»»» servers	object	false	none	none
»»»» additionalProperties	string	false	none	none
»»» total	string	false	none	none
»» total	string	false	none	none
» subscriptions	object	false	none	none
»» S328100-001	object	false	none	none
»»» total	string	false	none	none
»» S328100-002	object	false	none	none
»»» total	string	false	none	none
»» total	string	false	none	none
» total	string	false	none	none

GPUModel

{
  "id": 1,
  "name": "AMD Barco MXRT 5450 1024 MB BIOS",
  "addon_name": "gpu_amd_barco_mxrt_5450_1024mb_bios",
  "pools": [
    "pool_iw3_ssd_gpu"
  ],
  "desc_de": "AMD Barco MXRT 5450 1024 MB BIOS",
  "desc_en": "AMD Barco MXRT 5450 1024 MB BIOS"
}

Properties

Name	Type	Required	Restrictions	Description
id	number	false	none	Id of the GPU Model
name	string	false	none	Name of the GPU
addon_name	string	false	none	Addon Name of the GPU for ordering the addon
pools	[string]	false	none	none
desc_de	string	false	none	Description in German
desc_en	string	false	none	Description in English

AvailableGPU

{
  "name": "AMD Barco MXRT 5450 1024 MB BIOS",
  "addon_name": "gpu_amd_barco_mxrt_5450_1024mb_bios",
  "desc_de": "AMD Barco MXRT 5450 1024 MB BIOS",
  "desc_en": "AMD Barco MXRT 5450 1024 MB BIOS",
  "count": 1
}

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	Name of the GPU
addon_name	string	false	none	Addon Name of the GPU for ordering the addon
desc_de	string	false	none	Description in German
desc_en	string	false	none	Description in English
count	number	false	none	Count of the available GPUs of this type

RedeployRequest

{
  "image": "string",
  "password": "string",
  "sshkey": "string"
}

Properties

Name	Type	Required	Restrictions	Description
image	string	true	none	OS image to install
password	string	false	none	root (Linux) or Administrator (Windows) Password for the Server with minimum 8 characters
sshkey	string	false	none	public ssh key for the Server

Licenses

[
  {
    "id": 999,
    "title": "Microsoft SQL Server 2017 Standard",
    "price": 9.99
  }
]

Properties

Name	Type	Required	Restrictions	Description
id	number	false	none	Id of the product.
title	string	false	none	Title of the license.
price	number(float)	false	none	Price per unit of the license.

DeleteRequest

{
  "hostname": "string"
}

Properties

Name	Type	Required	Restrictions	Description
hostname	string	true	none	Hostname of the Server

Status	Meaning	Description	Schema
204	No Content	The server tags were successfully updated.	None
422	Unprocessable Entity	none	None