Skip to content

Reference

Precise descriptions of how the AppGantry API behaves on the wire. These pages are written to be looked things up in, not read through.

Canonical owners

Where the same subject appears on more than one page, one page owns it and the others link here. If two pages disagree, the owner wins.

Subject Canonical page
The upload contract, retry semantics, pagination, envelopes API conventions
Error codes, statuses, billing gates, feature limits Errors
Roles, scopes, and the permission model Authorization
The webhook event catalogue, signing, and delivery behaviour Webhook events
Credential types and how long each one lasts Authentication → Credential types and Lifetimes
The 402 billing taxonomy Errors → 402 Payment Required
Response headers on errors, including Retry-After and X-Audit-Truncated Errors → Retry-After and other error headers
Count, size and rate limits, and the code each produces Errors → Feature limits
Which platforms are supported, and what each install flow looks like SDK versioning → Platform support
What is gated by plan or environment, and the API-only controls Feature availability
Tester access: grant levels, groups, invitation lifetimes Managing testers & groups

Three of those owners live outside this section, which is deliberate: the platform table belongs with the SDK it constrains, availability belongs with the other "does this exist yet" material, and tester access belongs with the guide that walks through granting it.

The pages

  • API conventions — base URL, content types, the two-phase build upload, parent scoping, cursor pagination, and what is and isn't safe to retry.
  • API surface map — every public OpenAPI resource family, the three versioned surfaces, common automation paths, and the operations not yet present in the schema.
  • Authentication — every credential type, its lifetime, and how sign-in and refresh work.
  • Authorization — roles, scopes, and the surfaces that refuse long-lived tokens.
  • Errors — the full error code catalogue by status, the 402 billing taxonomy, and the feature limits.
  • Rate limits — what a 429 means and how to back off.
  • Webhook events — the event catalogue, the delivery contract, and receiver guidance.
  • Audit events — the vocabulary of the audit trail, how to read and export it, and retention.
  • Glossary — the terms these docs use, defined once.

Also reference-shaped

Where to go next

If you want Read
To ship your first build Getting started
The model behind a behaviour Concepts
Step-by-step instructions Guides
A quick answer FAQ