List Servers belonging to the executing user

GET/servers/

API version

v2

Request method

GET

Operation ID

project-list-servers

---

Request

Responses

Response-Header

• X-Pagination-Limitinteger

  The limit used to select the resources for the response

• X-Pagination-Skipinteger

  The number of skipped items

• X-Pagination-Pagenumber

  The calculate page of the list response. Refer to parameters to learn more.

• X-Pagination-TotalCountinteger

  The total amount of items available in the remote ressource. Use this value in combination with the limit to calculate the available pages.

Format

application/json

Beschreibung

OK

Schema-Dokumentation

• Array[
  • *object
    • clusterNamestring

      required
    • createdAtstring (date-time)

      required
    • customerIdstring

      required
    • descriptionstring

      required
    • disabledReason"suspended"
    • idstring (uuid)

      required
    • imageRefIdstring (uuid)
    • isReadyboolean

      deprecated

      required

      deprecated by property status

    • machineTypeobject

      required
      • cpustring

        required
      • memorystring

        required
      • namestring

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

      deprecated

      required

      deprecated by property status

    • shortIdstring

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

      required
    • storagestring

      required
  ]

Beispiel

Content-Type: application/json

[
  {
    "clusterName": "string",
    "createdAt": "1985-10-26T01:21:00.000Z",
    "customerId": "673c107f-75e1-451c-8eaa-5bf101bd2b2c",
    "description": "My first Server!",
    "disabledReason": "suspended",
    "id": "f0f86186-0a5a-45b2-aa33-502777496347",
    "imageRefId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "machineType": {
      "cpu": "2",
      "memory": "4Gi",
      "name": "shared.large"
    },
    "shortId": "s-4e7tz3",
    "statisticsBaseDomain": "pe-prod.staging.mcloud.services",
    "status": "pending",
    "storage": "50Gi"
  }
]

JSON Schema

{
  "items": {
    "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",
          "suspended"
        ],
        "type": "string"
      },
      "storage": {
        "example": "50Gi",
        "type": "string"
      }
    },
    "required": [
      "id",
      "shortId",
      "customerId",
      "machineType",
      "storage",
      "description",
      "isReady",
      "readiness",
      "createdAt",
      "clusterName",
      "status"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/servers?customerId=string&searchTerm=string&limit=50&page=1&sort=createdAt&order=asc

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.listServers({
  "queryParameters": {
    "customerId": "string",
    "searchTerm": "string",
    "limit": 50,
    "page": 1,
    "sort": "createdAt",
    "order": "asc"
  }
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new ListServersRequest())
  ->withCustomerId("string")
  ->withSearchTerm("string")
  ->withLimit(50)
  ->withPage(1)
  ->withSort("createdAt")
  ->withOrder("asc");
$response = $client->project()->listServers($request);

var_dump($response->getBody();