Skip to content

CLI and API Reference

Use this section to look up commands, resource fields, HTTP endpoints, and authentication requirements. For a guided workflow, start with Server and Client Guides or Deployment and Operations.

Choose the reference you need

Question Reference
Which command, flag, or profile should I use? CLI Commands
What fields do servers, grants, and sessions accept, or what does an endpoint return? API and Resources
Which credentials and permissions does an endpoint require? Authentication and Authorization
Where is a Go symbol defined and how is it implemented? Go Packages

For API integrations, read the resource and endpoint contract together with the authentication and authorization matrix. A valid payload alone does not give the caller permission to manage the resource.

Concepts and Architecture explains why the contracts are shaped this way. Implementation Details maps them to source packages and tests. Troubleshooting covers common failures encountered while using the CLI or platform APIs.