Pūnaha API overview

OpenAPI 3.2 customer contract

Build with a contract you can trust

The available runtime routes depend on the services enabled on that server. Product interface, setup, and private service operations stay outside this customer contract.

Operations

96

Paths

73

Models

186

Stable

3

93 Preview operations are documented so you can evaluate them, but they may change. Check the lifecycle label before committing an integration.

Use the four documentation parts

Explore API categories

The category names, descriptions, order, and operation membership come from the Product customer OpenAPI contract. They match the groups shown in Swagger.

Check the API health

Start with the Ready health request. It does not need sign in.

curl http://localhost:3001/health/ready

A successful response means that the API is ready to receive work.

Open Swagger if you need it

Swagger is included in the Pūnaha executable. The API address sends you to /swagger/. With the normal development ports, use http://localhost:3001/swagger/.

You do not need Swagger to read the API reference on this website.

1. Choose an API group.
2. Open the request you need.
3. Read its method, address, input, and possible responses.
4. Only try a request when you understand what it will change.

Download the OpenAPI file

The customer OpenAPI 3.2 file is at /openapi.json. Save the file from the exact Pūnaha version and server type you use. The current documentation source digest is 8c568bec762d5d5568af9f763ae9a39eb50c6d820f83e8fb1f0273b7dae773b7.

Build an API client

1. Create the client from the saved OpenAPI file.
2. Choose how the program will sign in.
3. Give it only the access it needs.
4. Test successful requests and errors.
5. Test the client again before you update Pūnaha.