Update API key

Update the configuration of an existing API key. Only specified fields will be modified.

PATCH /cloud/v1/faas/keys/{project_id}/{region_id}/{key_name}

Update API key

cURL

curl --request PATCH \
  --url https://api.gcore.com/cloud/v1/faas/keys/{project_id}/{region_id}/{key_name} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "functions": [
    {
      "name": "function-name",
      "namespace": "namespace-name"
    }
  ],
  "description": "key-description",
  "expire": "2023-08-22T11:21:00Z"
}
'

200

{
  "created_at": "2023-08-22T11:21:00Z",
  "functions": [
    {
      "name": "function-name",
      "namespace": "namespace-name"
    }
  ],
  "name": "key-name",
  "status": "Expired",
  "description": "key-description",
  "expire": "2023-08-22T11:21:00Z"
}

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-z][-a-z0-9]{0,24}[a-z0-9]$

Example:

"key-name"

Body

application/json

functions · NamespacedName · object[] · required

List of functions using key

Show child attributes

description · string | null

Optional key description

Example:

"key-description"

expire · string<date-time> | null

Key expires at

Example:

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

Response

200 - application/json

OK

created_at · string · required

Key starts to work

Example:

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

functions · NamespacedName · object[] · required

List of functions using key

Show child attributes

name · string · required

Key name

Pattern: ^[a-z][-a-z0-9]{0,24}[a-z0-9]$

Example:

"key-name"

status · string · required

Key status

Example:

"Expired"

description · string | null

Optional key description

Example:

"key-description"

expire · string<date-time> | null

Key expires at

Example:

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