Get a Server

GET/servers/{serverId}/

API version

v2

Request method

GET

Operation ID

project-get-server

---

Request

• serverIdstring

  required

  ID of the Server to be retrieved.

Responses

Format

application/json

Description

OK

Schema documentation

• clusterNamestring

  required
• createdAtstring (date-time)

  required
• customerIdstring

  required
• descriptionstring

  required
• disabledReason"suspended"
• idstring (uuid)

  required
• imageRefIdstring (uuid)
• isReadyboolean

  required

  deprecated by property status

• machineTypeobject

  required
  • cpustring

    required
  • memorystring

    required
  • namestring

    required
• readinessstring (one of: creating, ready, unready)

  required

  deprecated by property status

• shortIdstring

  required
• statisticsBaseDomainstring (hostname)
• statusstring (one of: pending, ready, unready)

  required
• storagestring

  required

Example

{
  "clusterName": "string",
  "createdAt": "2024-11-08T18:07:43.255Z",
  "customerId": "673c107f-75e1-451c-8eaa-5bf101bd2b2c",
  "description": "My first Server!",
  "disabledReason": "suspended",
  "id": "f0f86186-0a5a-45b2-aa33-502777496347",
  "imageRefId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "isReady": true,
  "machineType": {
    "cpu": "2",
    "memory": "4Gi",
    "name": "shared.large"
  },
  "readiness": "creating",
  "shortId": "s-4e7tz3",
  "statisticsBaseDomain": "pe-prod.staging.mcloud.services",
  "status": "pending",
  "storage": "50Gi"
}

JSON Schema

{
  "properties": {
    "clusterName": {
      "type": "string"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "customerId": {
      "example": "673c107f-75e1-451c-8eaa-5bf101bd2b2c",
      "type": "string"
    },
    "description": {
      "example": "My first Server!",
      "type": "string"
    },
    "disabledReason": {
      "enum": [
        "suspended"
      ],
      "type": "string"
    },
    "id": {
      "format": "uuid",
      "type": "string"
    },
    "imageRefId": {
      "format": "uuid",
      "type": "string"
    },
    "isReady": {
      "deprecated": true,
      "description": "deprecated by property status",
      "type": "boolean"
    },
    "machineType": {
      "properties": {
        "cpu": {
          "example": "2",
          "type": "string"
        },
        "memory": {
          "example": "4Gi",
          "type": "string"
        },
        "name": {
          "example": "shared.large",
          "type": "string"
        }
      },
      "required": [
        "name",
        "cpu",
        "memory"
      ],
      "type": "object"
    },
    "readiness": {
      "deprecated": true,
      "description": "deprecated by property status",
      "enum": [
        "creating",
        "ready",
        "unready"
      ],
      "type": "string"
    },
    "shortId": {
      "example": "s-4e7tz3",
      "type": "string"
    },
    "statisticsBaseDomain": {
      "example": "pe-prod.staging.mcloud.services",
      "format": "hostname",
      "type": "string"
    },
    "status": {
      "enum": [
        "pending",
        "ready",
        "unready"
      ],
      "type": "string"
    },
    "storage": {
      "example": "50Gi",
      "type": "string"
    }
  },
  "required": [
    "id",
    "shortId",
    "customerId",
    "machineType",
    "storage",
    "description",
    "isReady",
    "readiness",
    "createdAt",
    "clusterName",
    "status"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/servers/string

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.project.getServer({
  "serverId": "string"
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Project\GetServer\GetServerRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new GetServerRequest(
  serverId: "string"
));
$response = $client->project()->getServer($request);

var_dump($response->getBody();