List Projects belonging to the executing user

GET /v2/projects/

API version

v2

Request method

GET

Operation ID

project-list-projects

---

Request

Responses

Response headers

• X-Pagination-Limitnumber

  The limit used to select the resources for the response

• X-Pagination-Skipnumber

  The number of skipped items

• X-Pagination-Pagenumber

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

• X-Pagination-TotalCountnumber

  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

Description

OK

Schema documentation

• Array[
• *object
  • createdAtstring (date-time)

    required
  • customerIdstring

    required
  • customerMetaobject

    required
    • idstring

      required
  • descriptionstring

    required
  • disableReasonstring (one of: maliciousCode, illegalContent, maliciousConduct, suspended)
  • disabledAtstring (date-time)
  • enabledboolean

    required
  • idstring

    required
  • imageRefIdstring
  • isReadyboolean

    required

    deprecated

  • projectHostingIdstring (uuid)
  • readinessstring (one of: creating, ready, unready)

    required

    deprecated by property status

  • serverIdstring
  • shortIdstring

    required
  • statusstring (one of: pending, ready, preparingForVolumeMigration, migratingVolume, error, disabled)

    required
  • statusSetAtstring (date-time)

    required
  • webStorageUsageInBytesinteger

    required
  • webStorageUsageInBytesSetAtstring (date-time)

    required
]

Example

[
  {
    "createdAt": "2024-09-16T00:26:53.633Z",
    "customerId": "string",
    "customerMeta": {
      "id": "string"
    },
    "description": "string",
    "disableReason": "maliciousCode",
    "disabledAt": "2024-09-16T00:26:53.633Z",
    "enabled": true,
    "id": "string",
    "imageRefId": "string",
    "isReady": true,
    "projectHostingId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "readiness": "creating",
    "serverId": "string",
    "shortId": "string",
    "status": "pending",
    "statusSetAt": "2024-09-16T00:26:53.633Z",
    "webStorageUsageInBytes": 123,
    "webStorageUsageInBytesSetAt": "2024-09-16T00:26:53.633Z"
  }
]

JSON Schema

{
  "items": {
    "properties": {
      "createdAt": {
        "format": "date-time",
        "type": "string"
      },
      "customerId": {
        "type": "string"
      },
      "customerMeta": {
        "properties": {
          "id": {
            "type": "string"
          }
        },
        "required": [
          "id"
        ],
        "type": "object"
      },
      "description": {
        "type": "string"
      },
      "disableReason": {
        "enum": [
          "maliciousCode",
          "illegalContent",
          "maliciousConduct",
          "suspended"
        ],
        "type": "string"
      },
      "disabledAt": {
        "format": "date-time",
        "type": "string"
      },
      "enabled": {
        "type": "boolean"
      },
      "id": {
        "type": "string"
      },
      "imageRefId": {
        "type": "string"
      },
      "isReady": {
        "deprecated": true,
        "description": "deprecated",
        "type": "boolean"
      },
      "projectHostingId": {
        "format": "uuid",
        "type": "string"
      },
      "readiness": {
        "deprecated": true,
        "description": "deprecated by property status",
        "enum": [
          "creating",
          "ready",
          "unready"
        ],
        "type": "string"
      },
      "serverId": {
        "type": "string"
      },
      "shortId": {
        "type": "string"
      },
      "status": {
        "enum": [
          "pending",
          "ready",
          "preparingForVolumeMigration",
          "migratingVolume",
          "error",
          "disabled"
        ],
        "type": "string"
      },
      "statusSetAt": {
        "format": "date-time",
        "type": "string"
      },
      "webStorageUsageInBytes": {
        "type": "integer"
      },
      "webStorageUsageInBytesSetAt": {
        "format": "date-time",
        "type": "string"
      }
    },
    "required": [
      "id",
      "shortId",
      "description",
      "enabled",
      "customerMeta",
      "customerId",
      "createdAt",
      "isReady",
      "readiness",
      "status",
      "statusSetAt",
      "webStorageUsageInBytes",
      "webStorageUsageInBytesSetAt"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/projects?customerId=15b8a787-8d46-43b0-907e-01af35032c0a&serverId=f0f86186-0a5a-45b2-aa33-502777496347&limit=50&page=1

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.listProjects({
  "queryParameters": {
    "customerId": "15b8a787-8d46-43b0-907e-01af35032c0a",
    "serverId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "limit": 50,
    "page": 1
  }
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new ListProjectsRequest())
  ->withCustomerId("15b8a787-8d46-43b0-907e-01af35032c0a")
  ->withServerId("f0f86186-0a5a-45b2-aa33-502777496347")
  ->withLimit(50)
  ->withPage(1);
$response = $client->project()->listProjects($request);

var_dump($response->getBody();