Build on a stable version.
The API version is part of every address. Changes add things, and anything that would break your code is deprecated first, with a Sunset date.
Base URL
https://api.appenda.app/v1
Every path in the API reference and every example on these pages starts there. Use the same address wherever your workspace is hosted: your key decides where the request goes.
What can change in v1
Additive changes can ship at any time:
- new operations;
- new optional request fields;
- new response fields;
- new enum values.
Make your client ignore fields and enum values it does not know. A client that refuses unknown fields will break on a change we consider safe.
A change that could break a working client is never made in place. The old behaviour is deprecated first and keeps working until its Sunset date:
- removing or renaming an operation, field or enum value;
- making an optional request field required;
- changing a field's type or meaning.
The Sunset date is at least 90 days after the deprecation, and the Changelog names the replacement. Beta operations follow the notice below instead.
Stability levels
Each operation in the reference carries one of three levels.
| Level | What it promises |
|---|---|
| Stable | Never breaks without a deprecation and a Sunset date. |
| Beta | Can change with at least 14 days' notice in the Changelog. Marked with a Beta badge. |
| Deprecated | Still works for at least 90 days, names its replacement and answers with the deprecation headers below. Its title ends in (deprecated). |
The level is also in the downloadable spec, so a code generator can see it.
Deprecations
A deprecated operation is announced in the Changelog at least 90 days before it stops working. Until then it keeps answering normally, with three extra headers:
HTTP/2 200
Deprecation: @1798761600
Sunset: Thu, 01 Apr 2027 00:00:00 GMT
Link: <https://appenda.app/docs/api/changelog>; rel="deprecation"
| Header | Meaning |
|---|---|
Deprecation | When the operation was deprecated, as @ and seconds since 1970-01-01 UTC. |
Sunset | The date after which it may stop working. Never earlier than 90 days after Deprecation. |
Link | The Changelog entry that names the replacement. |
To check whether anything you call is deprecated, look for the header in your logs or run:
curl -sI https://api.appenda.app/v1/tables \
-H "Authorization: Bearer $APPENDA_API_KEY" | grep -iE "deprecation|sunset"
No output means the operation is not deprecated.
Download the spec
The public spec describes every operation, field and example:
The same files are at appenda.app/openapi.json and appenda.app/openapi.yaml. Feed either one to a client generator, or to an agent that writes code against the API.