Skip to content
Management API Reference

Get project api keys

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

OAuth scopes

  • secrets:read

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

  • api_gateway_keys_read

Path parameters

  • ref
    Required
    string

    Project ref

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

  • 200
  • 401
  • 403
  • 429

Response (200)

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