v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB

Container as a Service

Update API key

Update the configuration of an existing API key.

patch/cloud/v1/caas/keys/{project_id}/{region_id}/{key_name}

Path parameters

project_idinteger required

Project id

Example:1

Project id

region_idinteger required

Region id

Example:1

Region id

key_namestring required

Key name

Example:key-name

Key name

Request body

descriptionstring nullable

Key description

expirestring date-time nullable

Key expires at

is_disabledboolean nullable

Set to true if key is disabled

Example request

{
  "containers": [
    {
      "name": "my-container",
      "namespace": "space"
    }
  ],
  "description": "my first key",
  "expire": "2023-07-31T00:00:00Z"
}

Response

created_atstring date-time required

Key starts to work

descriptionstring required

Key description

expirestring date-time nullable required

Key expires at

is_disabledboolean required

Set to true if key is disabled

namestring required

Key name

sourcestring required

Source of the apikey, can be 'cloud' or 'iate'

statusstring required

Key status

Example response

{
  "containers": [
    {
      "name": "my-container",
      "namespace": "space"
    }
  ],
  "created_at": "2023-08-22T11:21:00Z",
  "description": "my first key",
  "expire": "2023-07-31T00:00:00Z",
  "name": "my-key",
  "source": "cloud",
  "status": "Expired"
}