PATCH /ai/ai-api-key/{id}

Update AI API key name and/or scope

Path parameters

  • id string(uuid) Required
application/json

Body Required

  • name string

    Human-readable name for the AI API key

  • scope string

    Key scope: 'public' for all deployments, or a specific deployment UUID

Responses

  • 403 application/json

    403

    Hide response attributes Show response attributes object
    • code string Required

      Machine-readable forbidden error code

      Value is forbidden_operation.

    • error string Required

      Forbidden error message
  • 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
  • 200 application/json

    200

    Hide response attributes Show response attributes object
    • updated-at string(date-time)

      Last update timestamp

    • name string

      Human-readable name for the AI API key

    • scope string

      Key scope: 'public' for all deployments, or a specific deployment UUID

    • id string(uuid)

      AI API key ID

    • org-uuid string(uuid)

      Organization UUID that owns this key

    • created-at string(date-time)

      Creation timestamp
  • 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
PATCH /ai/ai-api-key/{id} 
curl \
 --request PATCH 'https://api-ch-gva-2.exoscale.com/v2/ai/ai-api-key/{id}' \
 --header "Content-Type: application/json" \
 --data '{"name":"string","scope":"string"}'
Request examples 
{
  "name": "string",
  "scope": "string"
}
Response examples (403) 
{
  "code": "forbidden_operation",
  "error": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string",
  "errors": [
    {
      "path": "string",
      "detail": "string",
      "pointer": "string",
      "location": "string"
    }
  ]
}
Response examples (200) 
{
  "updated-at": "2026-05-04T09:42:00Z",
  "name": "string",
  "scope": "string",
  "id": "string",
  "org-uuid": "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"
    }
  ]
}