Alpine· Docs
Contents

Reference

Endpoints

Receiving and programmable endpoints.

Create a receiving endpointPOST/v1/receiving-endpoints

Provision the endpoint that receives value into the environment for an owner and value unit.

Read the current receiving endpointGET/v1/receiving-endpoints/current

Resolve the active receiving endpoint for an owner and value unit.

Create a programmable endpointPOST/v1/programmable-endpoints

Mint an endpoint from one of the supported templates; the template decides how it will behave.

List programmable endpointsGET/v1/programmable-endpoints

Page through the environment's programmable endpoints.

Read a programmable endpointGET/v1/programmable-endpoints/{endpointRef}

Read one endpoint's posture: what it will accept, what it will refuse, and why.

Read effective operation readinessGET/v1/programmable-endpoints/{endpointRef}/effective-operation-readiness

Inspect which operation families the endpoint can perform now and the customer-safe reason code behind each posture.

Manage endpoint lifecyclePOST/v1/programmable-endpoints/{endpointRef}/lifecycle

Suspend or resume an endpoint; a suspended endpoint refuses new operations while its record stays readable.

generated from openapi.json · gateway 0.1.0 · sandbox