List API keys

Retrieve a list of API keys for function authentication. Keys can be filtered by name and expiration status.

GET /cloud/v1/faas/keys/{project_id}/{region_id}

List API keys

cURL

curl --request GET \
  --url https://api.gcore.com/cloud/v1/faas/keys/{project_id}/{region_id} \
  --header 'Authorization: <api-key>'

200

{
  "count": 1,
  "results": [
    {
      "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

Query Parameters

expire_in · integer

Days to expire

Required range: x >= 1

Example:

5

limit · integer · default: 1000

Optional. Limit the number of returned items

Required range: x <= 1000

Example:

1000

offset · integer · default: 0

Optional. Offset value is used to exclude the first set of records from the result

Required range: x >= 0

Example:

0

order_by · enum<string> · default: created_at.desc

Ordering fields and directions.

Available options: created_at.asc, created_at.desc, expire.asc, expire.desc, name.asc, name.desc

Example:

"created_at.desc"

search · string

Search through which value

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

Example:

"search-value"

Response

200 - application/json

OK

count · integer · required

Number of objects

Required range: x >= 0

Example:

1

results · FaasApiKeySerializer · object[] · required

Objects

Show child attributes