Endpoints
Put a stable, callable address in front of one saved version of a setup.
An endpoint is a stable, callable address in front of one setup version. You point it at a version you have saved, and calls to that address run against that exact state.
Endpoints live under Infrastructure, Endpoints in the console.
Creating one
aq endpoint create <setup> <version> --max-instances <n> --spend-cap-cents <n>Both caps are required, and they are the reason an endpoint is safe to leave up:
| Flag | What it bounds |
|---|---|
--max-instances | The maximum number of instances this endpoint may run at once |
--spend-cap-cents | The spend, in cents, after which the endpoint stops accepting calls |
--name is optional and defaults to the setup's own name.
The caps are hard stops, not alerts
An endpoint that hits its spend cap stops accepting calls. It does not warn and keep going. Set the cap to a number you are genuinely willing to spend.
Repointing it at a newer version
The address stays, the version behind it changes:
aq endpoint point <name> <version>That is the shape of a deploy. Save a new version of the setup, test it, then point the endpoint at it. Callers do not change anything on their side.
Calling it
aq call <endpoint>
aq call <endpoint> --input params.json
aq call <endpoint> --wait
aq call <endpoint> --wait --wait-seconds 120--input takes a path to a JSON file of the declared params. Without --wait the call
returns as soon as it is accepted. With it, the CLI waits for completion, up to 30
seconds by default and 120 at most.
Seeing what has been called
aq calls <endpoint>Lists the endpoint's recent calls and their status.
Removing it
aq endpoint rm <name>That takes the address down. The setup and its versions are untouched.