Skip to content

REST API

The API under /api/v1 reads the matrix, services, environments, targets, history and drift, and creates acknowledgements.

  • Authentication: Authorization: Bearer glsh_api_… with an API token (Users → API tokens, or goliash token create), or a browser session. A token belongs to one workspace and is a viewer (reads) or a member (also acknowledges).
  • Errors: application/problem+json (RFC 9457).
  • Description: api/public-v1.yaml, also served by every server at /api/v1/openapi.yaml. A test checks every response against it.
Terminal window
curl -s -H "Authorization: Bearer $GOLIASH_TOKEN" https://goliash.example.com/api/v1/drifts | jq
curl -s -X POST -H "Authorization: Bearer $GOLIASH_TOKEN" -H 'Content-Type: application/json' \
-d '{"service":"postgres","kind":"release","until_version":"17.0"}' \
https://goliash.example.com/api/v1/acks

Prometheus metrics are at GET /metrics, with the same authentication; see Notifications.