Skip to main content
PATCH
Update API key

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

project_id
integer
required

Project id

Example:

1

region_id
integer
required

Region id

Example:

1

key_name
string
required

Key name

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9.-]+[a-zA-Z0-9]$
Example:

"key-name"

Body

application/json
containers
CaasNamespacedName · object[] | null

List of containers using key

Example:
description
string | null

Key description

Example:

"my first key"

expire
string<date-time> | null

Key expires at

Example:

"2023-07-31T00:00:00Z"

is_disabled
boolean | null

Set to true if key is disabled

Example:

false

Response

200 - application/json

OK

containers
CaasNamespacedName · object[]
required

List of containers using key

Example:
created_at
string<date-time>
required

Key starts to work

Example:

"2023-08-22T11:21:00Z"

description
string
required

Key description

Example:

"my first key"

expire
string<date-time> | null
required

Key expires at

Example:

"2023-07-31T00:00:00Z"

is_disabled
boolean
required

Set to true if key is disabled

Example:

false

name
string
required

Key name

Example:

"my-key"

source
string
required

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

Example:

"cloud"

status
string
required

Key status

Example:

"Expired"