Skip to main content

Get a Project

GET /v2/projects/{projectId}/
v2
GET
project-get-project

Request

  • projectIdstring (uuid)
    required

    ID of the Project to be retrieved.

Responses

application/json

OK

  • clusterDomainstring (hostname)
  • clusterIDstring
  • createdAtstring (date-time)
    required
  • customerIdstring
    required
  • descriptionstring
    required
  • directoriesobject
    required
    • *string
  • disableReasonstring (one of: maliciousCode, illegalContent, maliciousConduct, suspended)
  • disabledAtstring (date-time)
  • enabledboolean
    required
  • idstring (uuid)
    required
  • imageRefIdstring (uuid)
  • isReadyboolean
    required

    deprecated

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

    deprecated

  • serverIdstring (uuid)
  • serverShortIdstring
  • shortIdstring
    required
  • specone of 2 alternatives
  • statisticsBaseDomainstring (hostname)
  • statusstring (one of: pending, ready, preparingForVolumeMigration, migratingVolume, error, disabled)
    required
  • statusSetAtstring (date-time)
    required
  • webStorageUsageInBytesinteger (int64)
    required
  • webStorageUsageInBytesSetAtstring (date-time)
    required

Usage examples

$ curl \
--fail \
--location \
-H "Authorization: Bearer $MITTWALD_API_TOKEN" \
https://api.mittwald.de/v2/projects/f0f86186-0a5a-45b2-aa33-502777496347