Skip to Content
dgateway/ docs
API reference

Client keys and settings

Manage application access and gateway defaults.

Client keys identify the apps that call the public API. They are checked only when the require_client_keys setting is on. This page covers the admin endpoints that create and revoke those keys and change gateway settings. Send Authorization: Bearer <ADMIN_TOKEN> to every endpoint below. Requests and responses are JSON; timestamps use ISO-8601. A missing or incorrect admin token returns 401. Error bodies have an error object with message, type, and optionally code.

Tested example

Run this against a development gateway with Bun and ADMIN_TOKEN available. BASE_URL defaults to http://127.0.0.1:8790. The script creates a key, lists keys and revokes the key. It then reads the settings and sends a patch that keeps the current default route. The full key appears only once, in the create response, so keep real output private.

Shell
#!/bin/sh
set -eu

base_url=${BASE_URL:-http://127.0.0.1:8790}
: "${ADMIN_TOKEN:?Set ADMIN_TOKEN to the gateway admin token}"

admin() {
  endpoint=$1
  shift
  curl --fail-with-body --silent --show-error --max-time 10 "$base_url$endpoint" \
    -H "Authorization: Bearer $ADMIN_TOKEN" -H 'Content-Type: application/json' -w '\n' "$@"
}


client=$(admin /admin/api/clients -X POST -d '{"name":"Documentation example"}')
printf '%s\n' "$client"
client_id=$(printf '%s' "$client" | bun -e 'console.log((await Bun.stdin.json()).id)')
admin /admin/api/clients
admin "/admin/api/clients/$client_id" -X DELETE
settings=$(admin /admin/api/settings)
printf '%s\n' "$settings"
default_route=$(printf '%s' "$settings" | bun -e 'console.log(JSON.stringify((await Bun.stdin.json()).default_route))')
admin /admin/api/settings -X PATCH -d "{\"default_route\":$default_route}"

Client keys

OperationEndpointRequestResponse
ListGET /admin/api/clientsNo bodyArray of id, name, key_last4, created_at, last_used_at objects.
CreatePOST /admin/api/clients{ "name": "..." }id, name, key, key_last4, created_at. The full key appears only in this response.
RevokeDELETE /admin/api/clients/:idNo body{ "ok": true }

Settings

Settings are gateway-wide defaults. GET /admin/api/settings returns the whole object. PATCH /admin/api/settings takes any subset of the fields, saves it and returns the whole updated object. Unknown fields and values of the wrong type return HTTP 400.

SettingTypeEffect
require_client_keysbooleanWhen true, POST /v1/decisions and GET /v1/models need Authorization: Bearer <client key>.
capture_payloadsbooleanWhen true, new log entries keep the request and response bodies. See Security.
default_routestring or nullAlias used when a decision omits model. It must match [a-z0-9-]+; the gateway does not check that the route exists.

A new database starts with these values:

JSON
{ "require_client_keys": false, "capture_payloads": false, "default_route": "default" }

On this page