Get API key

Get detailed information about a specific API key.

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

Get API key

cURL

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

200

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

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"

Response

200 - application/json

OK

containers · CaasNamespacedName · object[] · required

List of containers using key

Show child attributes

Example:

[
  {
    "name": "my-container",
    "namespace": "space"
  }
]

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"