API How-Tos

Die ccloud API lässt Sie via herkömmlichen HTTP Requests Ressourcen programmatisch steuern. Alle Funktionen, die in der centron ccloud verfügbar sind, lassen sich über die ccloud API steuern.

Sie können die ccloud API Nutzen, um Instanzen zu erstellen, löschen oder Informationen über Ihre VMs zu erhalten. Sie können die ccloud API ebenfalls dafür verwenden, Instanzen anzuhalten oder zu starten.

centron ccloud API

ccloud Customer API v1.40.0

Informationen beziehen

Get all Servers for the given customer.

GET https://doku.ccloud.de/#get-all-servers-for-the-given-customer

Query Parameters

Name	Type	Description
tag	String
limit	String
page	String
search	String

200: OK

{
  "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,
      "rootaccess": true,
      "data": {
        "cores": 0,
        "memory": 0,
        "disk": 0,
        "pool": "string",
        "os_name": "string",
        "hostname": "string",
        "username": "[e-mail]",
        "customer_id": "string",
        "description": "string",
        "notes": "string",
        "addons": [
          "string"
        ],
        "network": {
          "INTERFACE": {
            "ip_addresses": [
              {
                "gateway": "string",
                "network": "string",
                "mask_bits": 0,
                "ip_address": "string"
              }
            ]
          }
        }
      }
    }
  ]
}

Get details for a server by its hostname.

GET https://doku.ccloud.de/#get-details-for-a-server-by-its-hostname

Path Parameters

Name	Type	Description
hostnamee*	String

200: OK

{
  "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,
  "rootaccess": true,
  "data": {
    "cores": 0,
    "memory": 0,
    "disk": 0,
    "pool": "string",
    "os_name": "string",
    "hostname": "string",
    "username": "[e-mail]",
    "customer_id": "string",
    "description": "string",
    "notes": "string",
    "addons": [
      "string"
    ],
    "network": {
      "INTERFACE": {
        "ip_addresses": [
          {
            "gateway": "string",
            "network": "string",
            "mask_bits": 0,
            "ip_address": "string"
          }
        ]
      }
    }
  }
}

Instanzen erstellen & anhalten

Create a new server

POST https://doku.ccloud.de/#create-a-new-server

Request Body

Name	Type	Description
body*	body

200: OK

{
  "id": 0
}

422: Unprocessable Entity

Create a new Snapshot

POST https://doku.ccloud.de/#create-a-new-snapshot

Path Parameters

Name	Type	Description
hostname*	String

Request Body

Name	Type	Description
body*	String

200: OK

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

Stop an Instance

POST https://doku.ccloud.de/#start-stop-shutdown-reset-the-server

Path Parameters

Name	Type	Description
hostname*	String
status*	stop

200: OK

{
  "id": 32
}

Diese Aktion löscht die Vm nicht. Ressourcen werden weiterhin berechnet.

Start, Reset & Delete einer Instanz

Start an Instance

POST https://doku.ccloud.de/#start-stop-shutdown-reset-the-server

Path Parameters

Name	Type	Description
hostname*	String
status*	start

200: OK

{
  "id": 32
}

Reset an Instance

POST https://doku.ccloud.de/#start-stop-shutdown-reset-the-server

Path Parameters

Name	Type	Description
hostname*	String
status*	stop

200: OK

{
  "id": 32
}

Delete an Instance

DELETE https://doku.ccloud.de/#start-stop-shutdown-reset-the-server

Path Parameters

Name	Type	Description
hostname*	String

Request Body

Name	Type	Description
hostname*	String

200: OK

{
  "id": 32
}

422: Unprocessable Entity

Das Löschen einer VM löscht ebenfalls alle gespeicherten Daten. Sie sollten vor dem Löschvorgang Snapshots anlegen, um Daten wiederherzustellen.