GET /kms-key/{id}

Retrieve KMS Key details.

Path parameters

  • id string(uuid) Required

Responses

  • 200 application/json

    200

    Hide response attributes Show response attributes object
    • description string Required
    • rotation object Required
      Hide rotation attributes Show rotation attributes object
      • manual-count integer Required
      • automatic boolean Required
      • rotation-period integer Required
      • next-at string(date-time) Required
    • revision object Required
      Hide revision attributes Show revision attributes object
      • at string(date-time) Required
      • seq integer Required

        Minimum value is 0.

    • name string Required
    • multi-zone boolean Required
    • source string Required

      Value is exoscale-kms.

    • policy string Required
    • usage string Required
    • replicas-status array[object]
      Hide replicas-status attributes Show replicas-status attributes object
      • zone string Required
      • last-applied-watermark integer Required
      • last-failure object
        Hide last-failure attributes Show last-failure attributes object
        • attempted-watermark integer Required
        • error string Required
        • failed-at string(date-time) Required
    • status string Required

      Values are enabled, disabled, or pending-deletion.

    • status-since string(date-time) Required
    • id string(uuid) Required
    • replicas array[string] Required
    • material object Required
      Hide material attributes Show material attributes object
      • version integer Required
      • created-at string(date-time) Required
      • automatic boolean Required
    • origin-zone string Required
    • created-at string(date-time) Required
  • 400 application/json

    400

    Hide response attributes Show response attributes object
    • type string(uri-reference) Required
    • title string Required
    • status integer Required

      Minimum value is 100, maximum value is 599.

    • detail string Required
    • instance string(uri-reference)
    • errors array[object]
      Hide errors attributes Show errors attributes object
      • path string
      • detail string
      • pointer string
      • location string
  • 404 application/json

    404

    Hide response attributes Show response attributes object
    • type string(uri-reference) Required
    • title string Required
    • status integer Required

      Minimum value is 100, maximum value is 599.

    • detail string Required
    • instance string(uri-reference)
    • errors array[object]
      Hide errors attributes Show errors attributes object
      • path string
      • detail string
      • pointer string
      • location string
GET /kms-key/{id}
curl \
 --request GET 'https://api-ch-gva-2.exoscale.com/v2/kms-key/{id}'
Response examples (200)
{
  "description": "string",
  "rotation": {
    "manual-count": 42,
    "automatic": true,
    "rotation-period": 42,
    "next-at": "2026-05-04T09:42:00Z"
  },
  "revision": {
    "at": "2026-05-04T09:42:00Z",
    "seq": 42
  },
  "name": "string",
  "multi-zone": true,
  "source": "exoscale-kms",
  "policy": "string",
  "usage": "string",
  "replicas-status": [
    {
      "zone": "string",
      "last-applied-watermark": 42,
      "last-failure": {
        "attempted-watermark": 42,
        "error": "string",
        "failed-at": "2026-05-04T09:42:00Z"
      }
    }
  ],
  "status": "enabled",
  "status-since": "2026-05-04T09:42:00Z",
  "id": "string",
  "replicas": [
    "string"
  ],
  "material": {
    "version": 42,
    "created-at": "2026-05-04T09:42:00Z",
    "automatic": true
  },
  "origin-zone": "string",
  "created-at": "2026-05-04T09:42:00Z"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string",
  "errors": [
    {
      "path": "string",
      "detail": "string",
      "pointer": "string",
      "location": "string"
    }
  ]
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string",
  "errors": [
    {
      "path": "string",
      "detail": "string",
      "pointer": "string",
      "location": "string"
    }
  ]
}