curl Python PHP Powershell

ccloud Customer API v1.40.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:

Authentication

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

Example responses

200 Response

{
  "data": [
    {
      "id": 0,
      "customer_id": "string",
      "hostname": "string",
      "created_at": "2019-08-24",
      "tags": [
        "string"
      ],
      "location": "string",
      "custom_name": "string",
      "credentials_available": true,
      "deletion_in_progress": true,
      "build_in_progress": true,
      "data": {
        "cores": 0,
        "memory": 0,
        "disk": 0,
        "pool": "string",
        "os_name": "string",
        "hostname": "string",
        "username": "user@example.com",
        "customer_id": "string",
        "description": "string",
        "notes": "string",
        "addons": [
          "string"
        ],
        "network": {
          "INTERFACE": {
            "ip_addresses": [
              {
                "gateway": "string",
                "network": "string",
                "mask_bits": 0,
                "ip_address": "string"
              }
            ]
          }
        }
      }
    }
  ]
}

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

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.
»»»» os_name string false none Name of the OS.
»»»» 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 [string] false none none
»»»» network object false none none
»»»»» INTERFACE object false none none
»»»»»» ip_addresses [object] false none none
»»»»»»» gateway string false none Gateway of the network.
»»»»»»» network string false none Network.
»»»»»»» mask_bits integer false none Amount of bits used for network masking
»»»»»»» ip_address string false none IP address.

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","type":"managed","addons":["string"],"subnets":[0],"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\",\"type\":\"managed\",\"addons\":[\"string\"],\"subnets\":[0],\"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\",\"type\":\"managed\",\"addons\":[\"string\"],\"subnets\":[0],\"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","type":"managed","addons":["string"],"subnets":[0],"rollouts":["string"]}'

POST /ccloud/servers

Body parameter

{
  "pool": "string",
  "hostname": "string",
  "description": "string",
  "cores": 0,
  "memory": 0,
  "disks": [
    0
  ],
  "image": "string",
  "custom_name": "string",
  "type": "managed",
  "addons": [
    "string"
  ],
  "subnets": [
    0
  ],
  "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",
  "created_at": "2019-08-24",
  "tags": [
    "string"
  ],
  "location": "string",
  "custom_name": "string",
  "credentials_available": true,
  "deletion_in_progress": true,
  "build_in_progress": true,
  "data": {
    "cores": 0,
    "memory": 0,
    "disk": 0,
    "pool": "string",
    "os_name": "string",
    "hostname": "string",
    "username": "user@example.com",
    "customer_id": "string",
    "description": "string",
    "notes": "string",
    "addons": [
      "string"
    ],
    "network": {
      "INTERFACE": {
        "ip_addresses": [
          {
            "gateway": "string",
            "network": "string",
            "mask_bits": 0,
            "ip_address": "string"
          }
        ]
      }
    }
  }
}

Responses

Status Meaning Description Schema
200 OK Success ServerDetail

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}'
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", 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 => "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' -Method DELETE -Headers $headers

DELETE /ccloud/servers/{hostname}

Parameters

Name In Type Required Description
hostname path string true Hostname of the server.
hostname body string true Hostname of the server (for confirmation).

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 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 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 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",
  "size": 0
}

Responses

Status Meaning Description Schema
200 OK Get all ISOs. GetISOs

Server Actions

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 Status

Get the status of a server by its hostname.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/status \
  --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/status", 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/status",
  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/status' -Method GET -Headers $headers

GET /ccloud/servers/{hostname}/status

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

start, stop, shutdown, reset the server.

Code samples

curl --request POST \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/status/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/status/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/status/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/status/start' -Method POST -Headers $headers

POST /ccloud/servers/{hostname}/status/{status}

Parameters

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

Enumerated Values

Parameter Value
status start
status stop
status shutdown
status 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

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

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

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

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

[
  {
    "id": 0,
    "data": [
      {
        "id": "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 [RestoreSnapshotTaskResponse] false none none
» id integer false none none
» data [object] false none none
»» id string false none none
»» 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.

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

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

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

[
  {
    "id": 0,
    "data": [
      {
        "id": "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 [DeleteSnapshotTaskResponse] false none none
» id integer false none none
» data [object] false none none
»» id string false none none
»» 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.

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

[
  {
    "data": [
      {
        "units": "Byte/s",
        "perfdata": [
          {
            "send_persec": 54
          }
        ]
      }
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [PerfomanceDataModel] false none none
» data [object] false none none
»» units integer(string) false none The Units of the Performance Data given back
»» perfdata [object] false none none
»»» send_persec integer false none Example of Performance Data given back, this elements can change depending on what data is requested

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 '{"id":2}'
import http.client

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

payload = "{\"id\":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 => "{\"id\":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 '{"id":2}'

PUT /ccloud/servers/{hostname}/bootorder

Body parameter

{
  "id": 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

Tags

Get all Tags for the given customer.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/tags \
  --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/tags", 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/tags",
  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/tags' -Method GET -Headers $headers

GET /ccloud/tags

Example responses

200 Response

[
  "development",
  "production"
]

Responses

Status Meaning Description Schema
200 OK Array of tags belonging to the given customer. TagsForCustomer

Get tags for a server by its hostname.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/tags \
  --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/tags", 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/tags",
  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/tags' -Method GET -Headers $headers

GET /ccloud/servers/{hostname}/tags

Parameters

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

Example responses

200 Response

[
  "development",
  "production"
]

Responses

Status Meaning Description Schema
200 OK Success ServerTags

Update tags for the server.

Code samples

curl --request POST \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/tags \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"tags":["development","production"]}'
import http.client

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

payload = "{\"tags\":[\"development\",\"production\"]}"

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

conn.request("POST", "/api/v1/ccloud/servers/vs10000/tags", 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/tags",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"tags\":[\"development\",\"production\"]}",
  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/tags' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"tags":["development","production"]}'

POST /ccloud/servers/{hostname}/tags

Body parameter

{
  "tags": [
    "development",
    "production"
  ]
}

Parameters

Name In Type Required Description
hostname path string true Hostname of the server.
body body object true none
» tags body [string] false Array of tags to set for the server.

Responses

Status Meaning Description Schema
204 No Content The server tags were successfully updated. None
422 Unprocessable Entity none None

Delete all tags for the server.

Code samples

curl --request DELETE \
  --url https://ccenter.internet1.de/api/v1/ccloud/servers/vs10000/tags \
  --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/tags", 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/tags",
  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/tags' -Method DELETE -Headers $headers

DELETE /ccloud/servers/{hostname}/tags

Parameters

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

Responses

Status Meaning Description Schema
204 No Content The server tags were successfully deleted. None

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

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

Networkcontroller VLANs/Subnets

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,
    "subnet": "192.168.1.0/24",
    "description": "Internal Subnet",
    "vlan_id": 4,
    "type": "IPv4"
  }
]

Responses

Status Meaning Description Schema
200 OK a List of Subnets NetworkSubnets

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

Example responses

200 Response

[
  {
    "tag": "string",
    "name": "string",
    "desc_de": "string",
    "desc_en": "string",
    "prices": {
      "disk": 0,
      "memory": 0,
      "cores": 0,
      "onetime": {
        "price": 0
      },
      "additionalProperties": {
        "depencies": [
          null
        ],
        "onetime": {
          "depencies": [
            null
          ],
          "description": "string",
          "disk": 0,
          "price": 0
        },
        "range": [
          null
        ]
      }
    }
  }
]

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Pool] 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
» prices PoolPrice false none none
»» disk number(decimal) false none Price in Euros per GB of disk space.
»» memory number(decimal) false none Price in Euros per GB of RAM.
»» cores number(decimal) false none Price in Euros per core.
»» onetime object false none none
»»» price number(decimal) false none Setup fee in Euros.
»» additionalProperties PoolPriceAddon false none none
»»» depencies [any] false none Dependencies of the addon.
»»» onetime object false none none
»»»» depencies [any] false none Dependencies of the setup fee.
»»»» description string false none Description of the setup fee.
»»»» disk number(decimal) false none Price in Euros per GB of disk space.
»»»» price number(decimal) false none Setup fee in Euros.
»»» range [any] false none Range?

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

{
  "tag": "string",
  "name": "string",
  "desc_de": "string",
  "desc_en": "string",
  "prices": {
    "disk": 0,
    "memory": 0,
    "cores": 0,
    "onetime": {
      "price": 0
    },
    "additionalProperties": {
      "depencies": [
        null
      ],
      "onetime": {
        "depencies": [
          null
        ],
        "description": "string",
        "disk": 0,
        "price": 0
      },
      "range": [
        null
      ]
    }
  }
}

Responses

Status Meaning Description Schema
200 OK OK Pool

Invoices

Get customer invoices by month.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/invoices/0/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/invoices/0/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/invoices/0/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/invoices/0/0' -Method GET -Headers $headers

GET /ccloud/invoices/{year}/{month}

Parameters

Name In Type Required Description
year path integer true Year of the Invoice
month path integer true Month of the Invoice
tag query string false Filter the output and include only servers with this tag.
search query string false wildcard search filter

Example responses

200 Response

{
  "items": [
    {
      "product_name": "vServer",
      "hostname": "xv10000",
      "amount": 1,
      "description": "(436) Host xv10000 pool 2 CORE",
      "price": 2.03
    }
  ],
  "total": 0
}

Responses

Status Meaning Description Schema
200 OK Invoice Details Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» items [Invoice] false none Details of the Invoice
»» product_name string false none none
»» hostname string false none none
»» amount integer false none none
»» description string false none none
»» price number(float) false none none
» total number false none Total sum of prices.

Get customer invoices by year in short format.

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/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/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/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/invoices/0' -Method GET -Headers $headers

GET /ccloud/invoices/{year}

Parameters

Name In Type Required Description
year path integer true Year of the Invoice

Example responses

200 Response

[
  {
    "month": "2022/8",
    "items": [
      {
        "hostname": "xv10000",
        "price": 2.03
      }
    ],
    "total": 0
  }
]

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 [InvoiceSummary] false none Summary of the invoices
» month string false none none
» items [object] false none none
»» hostname string false none none
»» price number(float) false none none
» total number(float) false none none

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",
  "ostype": "linux",
  "image": "stretch_uefi",
  "min_hdd": "5"
}

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",
    "desc_de": "Dieses Addon bietet eine Hochverfügbarkeit der VM",
    "desc_en": "This addon provides high availability of the VM"
  }
]

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 free available Resources for Deploy new VM or resize VM

Code samples

curl --request GET \
  --url https://ccenter.internet1.de/api/v1/ccloud/availableresources \
  --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/availableresources", 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/availableresources",
  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/availableresources' -Method GET -Headers $headers

GET /ccloud/availableresources

Example responses

200 Response

{
  "resource_limits": true,
  "available_resources": {
    "cores": 2,
    "disk": 100,
    "memory": 2
  }
}

Responses

Status Meaning Description Schema
200 OK Available Resources AvailableResources

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",
  "ostype": "linux",
  "image": "stretch_uefi",
  "min_hdd": "5"
}

Properties

Name Type Required Restrictions Description
name string false none none
ostype string false none none
image string false none Internal centron image name.
min_hdd string false none none

Enumerated Values

Property Value
ostype linux
ostype windows
ostype pfsense
ostype noimage

AddonsList

[
  {
    "id": 1,
    "name": "cprotect",
    "desc_de": "Dieses Addon bietet eine Hochverfügbarkeit der VM",
    "desc_en": "This addon provides high availability of the VM"
  }
]

Properties

Name Type Required Restrictions Description
id integer false none none
name string false none none
desc_de string false none none
desc_en string 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.

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

{
  "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",
  "type": "managed",
  "addons": [
    "string"
  ],
  "subnets": [
    0
  ],
  "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
type string true none none
addons [string] 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.
rollouts [string] false none Optional Rollouts for Software to be installed on the new Server

Enumerated Values

Property Value
type managed
type unmanaged

Pool

{
  "tag": "string",
  "name": "string",
  "desc_de": "string",
  "desc_en": "string",
  "prices": {
    "disk": 0,
    "memory": 0,
    "cores": 0,
    "onetime": {
      "price": 0
    },
    "additionalProperties": {
      "depencies": [
        null
      ],
      "onetime": {
        "depencies": [
          null
        ],
        "description": "string",
        "disk": 0,
        "price": 0
      },
      "range": [
        null
      ]
    }
  }
}

Properties

Name Type Required Restrictions Description
tag string false none none
name string false none none
desc_de string false none none
desc_en string false none none
prices PoolPrice false none none

PoolPrice

{
  "disk": 0,
  "memory": 0,
  "cores": 0,
  "onetime": {
    "price": 0
  },
  "additionalProperties": {
    "depencies": [
      null
    ],
    "onetime": {
      "depencies": [
        null
      ],
      "description": "string",
      "disk": 0,
      "price": 0
    },
    "range": [
      null
    ]
  }
}

Properties

Name Type Required Restrictions Description
disk number(decimal) false none Price in Euros per GB of disk space.
memory number(decimal) false none Price in Euros per GB of RAM.
cores number(decimal) false none Price in Euros per core.
onetime object false none none
» price number(decimal) false none Setup fee in Euros.
additionalProperties PoolPriceAddon false none Price of addons for the pool.

PoolPriceAddon

{
  "depencies": [
    null
  ],
  "onetime": {
    "depencies": [
      null
    ],
    "description": "string",
    "disk": 0,
    "price": 0
  },
  "range": [
    null
  ]
}

Properties

Name Type Required Restrictions Description
depencies [any] false none Dependencies of the addon.
onetime object false none none
» depencies [any] false none Dependencies of the setup fee.
» description string false none Description of the setup fee.
» disk number(decimal) false none Price in Euros per GB of disk space.
» price number(decimal) false none Setup fee in Euros.
range [any] false none Range?

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",
  "size": 0
}

Properties

Name Type Required Restrictions Description
name string¦null true none none
fullName string¦null true 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",
  "created_at": "2019-08-24",
  "tags": [
    "string"
  ],
  "location": "string",
  "custom_name": "string",
  "credentials_available": true,
  "deletion_in_progress": true,
  "build_in_progress": true
}

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

ServerDetail

{
  "id": 0,
  "customer_id": "string",
  "hostname": "string",
  "created_at": "2019-08-24",
  "tags": [
    "string"
  ],
  "location": "string",
  "custom_name": "string",
  "credentials_available": true,
  "deletion_in_progress": true,
  "build_in_progress": true,
  "data": {
    "cores": 0,
    "memory": 0,
    "disk": 0,
    "pool": "string",
    "os_name": "string",
    "hostname": "string",
    "username": "user@example.com",
    "customer_id": "string",
    "description": "string",
    "notes": "string",
    "addons": [
      "string"
    ],
    "network": {
      "INTERFACE": {
        "ip_addresses": [
          {
            "gateway": "string",
            "network": "string",
            "mask_bits": 0,
            "ip_address": "string"
          }
        ]
      }
    }
  }
}

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

AddedSnapshotTaskResponse

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

Properties

Name Type Required Restrictions Description
id integer false none none
data [object] false none none
» name string false none none
» 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.

RenameSnapshotTaskResponse

{
  "id": 0,
  "data": [
    {
      "id": "string",
      "name": "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 none
» 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.

DeleteSnapshotTaskResponse

{
  "id": 0,
  "data": [
    {
      "id": "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
» 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.

RestoreSnapshotTaskResponse

{
  "id": 0,
  "data": [
    {
      "id": "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
» 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.

ServerRenameSnapshotRequest

{
  "name": "string"
}

Properties

Name Type Required Restrictions Description
name string true none none

ServerData

{
  "cores": 0,
  "memory": 0,
  "disk": 0,
  "pool": "string",
  "os_name": "string",
  "hostname": "string",
  "username": "user@example.com",
  "customer_id": "string",
  "description": "string",
  "notes": "string",
  "addons": [
    "string"
  ],
  "network": {
    "INTERFACE": {
      "ip_addresses": [
        {
          "gateway": "string",
          "network": "string",
          "mask_bits": 0,
          "ip_address": "string"
        }
      ]
    }
  }
}

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.
os_name string false none Name of the OS.
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 [string] false none none
network object false none none
» INTERFACE object false none none
»» ip_addresses [object] false none none
»»» gateway string false none Gateway of the network.
»»» network string false none Network.
»»» mask_bits integer false none Amount of bits used for network masking
»»» ip_address string false none IP address.

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

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

{
  "data": [
    {
      "units": "Byte/s",
      "perfdata": [
        {
          "send_persec": 54
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
data [object] false none none
» units integer(string) false none The Units of the Performance Data given back
» perfdata [object] false none none
»» send_persec integer false none Example of Performance Data given back, this elements can change depending on what data is requested

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

{
  "id": 1554,
  "data": [
    {
      "id": 1,
      "hostname": "ts123454",
      "customer_id": "328100",
      "username": "entwickler@centron.de"
    }
  ]
}

Properties

Name Type Required Restrictions Description
id integer false none none
data [object] false none none
» id integer(int32) false none Order ID of the Device
» 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.

changeBootOrderRequest

{
  "id": 2
}

Properties

Name Type Required Restrictions Description
id integer false none 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

Invoice

{
  "product_name": "vServer",
  "hostname": "xv10000",
  "amount": 1,
  "description": "(436) Host xv10000 pool 2 CORE",
  "price": 2.03
}

Properties

Name Type Required Restrictions Description
product_name string false none none
hostname string false none none
amount integer false none none
description string false none none
price number(float) false none none

InvoiceSummary

{
  "month": "2022/8",
  "items": [
    {
      "hostname": "xv10000",
      "price": 2.03
    }
  ],
  "total": 0
}

Properties

Name Type Required Restrictions Description
month string false none none
items [object] false none none
» hostname string false none none
» price number(float) false none none
total number(float) false none none

AvailableResources

{
  "resource_limits": true,
  "available_resources": {
    "cores": 2,
    "disk": 100,
    "memory": 2
  }
}

Properties

Name Type Required Restrictions Description
resource_limits boolean false none Are there Resource Limits for the given Customer or not. If there are Limits the available_resources fields show the details
available_resources object false none none
» cores int32 false none Number of available cpu cores
» disk int32 false none Amount of available GB for Disk
» memory int32 false none Number of available free GB for Memory

NetworkSubnets

[
  {
    "id": 2,
    "subnet": "192.168.1.0/24",
    "description": "Internal Subnet",
    "vlan_id": 4,
    "type": "IPv4"
  }
]

Properties

Name Type Required Restrictions Description
id integer false none ID of the subnet
subnet string false none Subnet with Subnet Mask
description integer false none Description / Name of the Subnet
vlan_id integer false none ID of the vlan the subnet is belonging to
type string false none Subnet Type IPv4 or IPv4

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