API reference

The Halyard public API lets scripts, CI jobs, and external agents drive Halyard without the web or desktop app: create and manage projects, issues, and enclaves; list sessions and check their status; read project configuration; and work with the library.

New to the API? Start with Authentication, then the scripts quickstart or agents quickstart. The errors and pagination pages cover the cross-cutting conventions.

The console talks to the real API

The Try it panel below sends real requests to the live API using the token you paste in. It reads and writes real data under your account. Use a dedicated, least-privilege token (for example, a *:read token) when experimenting, and revoke it when you’re done.