Get KMS Key

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://openapi-v2.exoscale.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "Exoscale APIv2 MCP server": {
    "url": "https://openapi-v2.exoscale.com/mcp"
  }
}

Close
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

      An optional detailed description providing additional context about the key's intended use case.

    • rotation object Required
      Hide rotation attributes Show rotation attributes object
      • manual-count integer Required

        Total running tally of manual key rotation tasks executed by users over this key resource's lifecycle.

      • automatic boolean Required

        When set to true, dictates that the system automatically rotates material periodically.

      • rotation-period integer Required

        The set frequency period (measured in days) for triggers monitoring auto-rotation loops.

      • next-at string(date-time) Required

        Scheduled deadline calculation pinpointing the next automated rotational iteration target date.

    • revision object Required
      Hide revision attributes Show revision attributes object
      • at string(date-time) Required

        The timestamp recording exactly when this specific revision iteration occurred.

      • seq integer Required

        Monotonically increasing sequencing value utilized for optimistic concurrency control locks.

        Minimum value is 0.

    • delete-at string(date-time)
    • name string Required

      The display name of the KMS key.

    • multi-zone boolean Required

      True if this is a multi-zone key.

    • source string Required

      Value is exoscale-kms.

    • usage string Required

      The cryptographic operation constraints allowed on this key.

    • replicas-status array[object]

      Detailed synchronization metrics for each regional replica mirror.

      Hide replicas-status attributes Show replicas-status attributes object
      • zone string Required

        The destination target zone tracking this specific replica instance.

      • last-applied-watermark integer Required

        The latest logical sequence number or state watermark successfully synced to this regional replica.

      • last-failure object
        Hide last-failure attributes Show last-failure attributes object
        • attempted-watermark integer Required

          The target sync sequence watermark that triggered the replication failure.

        • error string Required

          A descriptive message containing error logs or system details regarding the sync failure.

        • failed-at string(date-time) Required

          The UTC timestamp showing exactly when the replication sync window failed.

    • status string Required

      Values are enabled, disabled, or pending-deletion.

    • status-since string(date-time) Required

      The timestamp indicating exactly when the current key status was last transitioned.

    • id string(uuid) Required

      The globally unique identifier (UUID) of the retrieved KMS key.

    • replicas array[string]

      A list of availability zones where this specific key has active replica mirrors.

    • material object Required
      Hide material attributes Show material attributes object
      • version integer Required

        The incremental index tracing internal key rotation cycles for the key material.

      • created-at string(date-time) Required

        The UTC date-time indicating when this particular generation of physical cryptographic material was seeded.

      • automatic boolean Required

        A boolean flag indicating whether this specific material version was created during an automated system rotation window.

    • origin-zone string Required

      The creation zone of the KMS key.

    • created-at string(date-time) Required

      The UTC timestamp showing when the KMS key was originally provisioned.

  • 400 application/json

    400

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

      An absolute or relative URI reference pointing to human-readable documentation concerning the specific problem type encountered.

    • title string Required

      A brief summary defining the class of failure, optimal for quick user interface groupings.

    • status integer Required

      Minimum value is 100, maximum value is 599.

    • detail string Required

      A highly contextual, readable explanation breaking down explicitly what triggered this error scenario.

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
  },
  "delete-at": "2026-05-04T09:42:00Z",
  "name": "string",
  "multi-zone": true,
  "source": "exoscale-kms",
  "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"
}