Skip to main content

API reference

CSTAR API details are documented in the OpenAPI specification.

Use the API reference for endpoint paths, request bodies, response shapes, and authentication requirements.

Local API docs​

When the backend is running locally, the Swagger UI is available at:

http://localhost:4144/docs

Lower environment API docs​

DEV:

https://cstar-dev.apps.gold.devops.gov.bc.ca/docs/

TEST:

https://cstar-test.apps.gold.devops.gov.bc.ca/docs/

Use the API docs for exact endpoint details. Use this documentation site for concepts, workflows, and integration notes.