List Api Keys Endpoints

List Endpoint API Keys

GET /v1/endpoints/{uuid}/api-keys

List the per-endpoint API keys you've issued for this endpoint. These are client-facing keys: visitors hitting the public URL present them in a header (typically X-API-Key or Authorization: Bearer ...) and the platform validates at the edge before forwarding to your agent. Distinct from account-level API keys which authenticate to this management API.

Each key carries an optional per-key rate limit (RPS) and an optional expiry. Maximum 50 keys per endpoint. Keys are returned masked — the full value (etk_…) is shown only once at creation; list returns a key prefix + hash for identification.

Path parameters

uuid string (uuid) Req

Endpoint UUID.

Query parameters

page int

Optional. When present (> 0), switches the response to a paged object ({items, total, page, page_size}) instead of a bare array.

page_size int

Optional. Items per page when paging. Defaults to the server default (15) and is capped at the server maximum (200).

Response (200 OK)

By default a JSON array of key objects (not wrapped in items). When page is supplied, a paged object {items, total, page, page_size} is returned instead. Each key object:

id int64

Numeric ID.

uuid string

UUID for use in update/delete URLs.

name string

Friendly label.

key_prefix string

First few chars of the key (etk_a1b2c3) — enough to identify but not impersonate. Display in dashboards / audit logs.

rate_limit_rps int

Per-key requests-per-second limit. 0 = no per-key limit (the endpoint's policy still applies).

is_active boolean

false = key is disabled but kept in the table (audit-trail). The platform rejects with 401 at the edge.

expires_at datetime | null

Optional expiry. null = non-expiring.

last_used_at datetime | null

Most recent successful use. null if never used.

request_count int64

Total requests authenticated with this key.

created_at, updated_at datetime

RFC 3339 UTC timestamps.

Errors

401 Unauthorized

Missing auth.

403 Forbidden

Endpoint doesn't exist or doesn't belong to you (handler returns 403, not 404, on this path).

Request
curl "https://api.ngris.com/v1/endpoints/<uuid>/api-keys" \
  -H "X-API-KEY: <your_api_key>"

Python
from ngris import Ngris

client = Ngris(api_key="<your_api_key>")
keys = client._get_raw("/endpoints/<endpoint_uuid>/api-keys")
# raw helper wraps lists as {"items": [...]}
for k in keys["items"]:
    print(f"#{k['id']} {k['name']} ({k['key_prefix']}...)")

Response — 200 OK
[
  {
    "id": 11,
    "uuid": "abc-123",
    "name": "mobile-app",
    "key_prefix": "etk_a1b2c3",
    "rate_limit_rps": 100,
    "is_active": true,
    "expires_at": "2027-04-29T00:00:00Z",
    "last_used_at": "2026-04-29T12:34:56Z",
    "created_at": "2026-04-01T00:00:00Z",
    "updated_at": "2026-04-01T00:00:00Z"
  }
]

PreviousUpdate mTLS Config NextCreate Endpoint API Key

On this page

List Endpoint API Keys