API reference · tag system
System
Gateway health and key introspection: tenant and scopes.
This page is generated from the contract (data/gateway-v1.json): each operation shows its verb,
path, parameters, body, responses, whether it carries an Idempotency-Key, and the equivalent method in all five SDKs.
For the end-to-end flow with complete examples, see the implementation guide.
Operations in tag system #
Contract description: Gateway health and key/scope introspection.
| Method | Path | Operation | Scope | Idem. |
|---|---|---|---|---|
| GET | /v1/gateway/health/ | Health — validate the API key and return its scopes | — | — |
Health — validate the API key and return its scopes #
GET/v1/gateway/health/
Responses
| Code | Description | Body |
|---|---|---|
| 200 | Key valid. | GatewayHealth
application/json |
Possible errors (400, 401, 403, 404, 409, 422, 429, 500) — application/problem+json
| 400 | Malformed request. | about:blank |
| 401 | Missing or invalid API key. | about:blank |
| 403 | The key is valid but lacks the required scope, or the source IP is not allow-listed. | about:blank |
| 404 | The requested resource does not exist. | about:blank |
| 409 | Idempotency conflict — same key, original still processing. | https://errors.compense.co/gateway/idempotency-conflict |
| 422 | Request body failed validation. | https://errors.compense.co/gateway/validation |
| 429 | Per-key rate limit or monthly quota exceeded; see Retry-After. | https://errors.compense.co/gateway/rate-limited |
| 500 | Unexpected gateway error; quote the trace_id to support. | about:blank |
See problem+json errors for the equivalent exception in each SDK.
Example
client.system.health()client.system.health()$client->system->health()await client.System.HealthAsync()client.System.Health(ctx, …)curl "https://sandbox.dev.compense.co/gw/v1/gateway/health/" \
-H "X-API-Key: $COMPENSE_API_KEY"Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.