Get API key

get/v1/projects/{ref}/api-keys/{id}

OAuth scopes

secrets:read

The fine-grained token must include the following permissions to access this endpoint:

api_gateway_keys_read
or
api_gateway_keys_read
api_gateway_keys_secret_read

Path parameters

ref
Required
string
Project ref
id
Required
string

Query parameters

reveal
Optional
string
Boolean string.

Truthy values: true, 1, yes, on, y, enabled

Falsy values: false, 0, no, off, n, disabled

Response codes

Response (200)

1
{
2
  "api_key": "lorem",
3
  "id": "lorem",
4
  "type": "legacy",
5
  "prefix": "lorem",
6
  "name": "lorem",
7
  "description": "lorem",
8
  "hash": "lorem",
9
  "secret_jwt_template": {
10
    "property1": null,
11
    "property2": null
12
  },
13
  "inserted_at": "4404-02-29T04:24Z",
14
  "updated_at": "4404-02-29T04:24Z"
15
}

1
{
2
  "type": "object",
3
  "properties": {
4
    "api_key": {
5
      "type": "string",
6
      "nullable": true
7
    },
8
    "id": {
9
      "type": "string",
10
      "nullable": true
11
    },
12
    "type": {
13
      "type": "string",
14
      "enum": [
15
        "legacy",
16
        "publishable",
17
        "secret",
18
        null
19
      ],
20
      "nullable": true
21
    },
22
    "prefix": {
23
      "type": "string",
24
      "nullable": true
25
    },
26
    "name": {
27
      "type": "string"
28
    },
29
    "description": {
30
      "type": "string",
31
      "nullable": true
32
    },
33
    "hash": {
34
      "type": "string",
35
      "nullable": true
36
    },
37
    "secret_jwt_template": {
38
      "type": "object",
39
      "propertyNames": {
40
        "type": "string"
41
      },
42
      "additionalProperties": {},
43
      "nullable": true
44
    },
45
    "inserted_at": {
46
      "type": "string",
47
      "format": "date-time",
48
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
49
      "nullable": true
50
    },
51
    "updated_at": {
52
      "type": "string",
53
      "format": "date-time",
54
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
55
      "nullable": true
56
    }
57
  },
58
  "required": [
59
    "name"
60
  ]
61
}