ApiKeyLifecycleResponse

Response for API key revoke operations.

  • action
    Type: stringenum
    required

    Whether the requested credential was revoked or rotated.

    values
    • revoked

      The requested key was revoked.

    • rotated

      The requested key was rotated and a replacement key was created.

  • replacement
    Type: object ยท ApiKeyCreateResponse

    Response returned when creating or rotating an API key.

    • id
      Type: string
      required

      ID of the API key.

    • secret
      Type: string
      required

      The secret key for API authentication.

      This value is returned only when creating or rotating an API key. Store it securely before the response is discarded.