Docs / Automation

API and keys

Use SysJ from scripts and CI with workspace-scoped API keys.

Everything the console does will be available over HTTPS to scripts and CI, with keys that belong to the workspace rather than to a person.

API keys

  • Keys will be created in Settings, API keys.
  • A key belongs to one workspace and carries only the permissions you give it.
  • Keys are independent of any member and can be revoked at any time.

Making a request

Request a plan for a cluster
curl -X POST https://api.sysj.com/v1/plans \
  -H "Authorization: Bearer $SYSJ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"cluster": "staging-eu"}'

Writes will be idempotent: send an Idempotency-Key header and a retried request will not create a second plan.