APIs
- Version
- v1
- In force since
- Not yet
- Next review
- At adoption
- Snapshot
- None yet
- Adopted by
- Proposed for founding adoption
- Signature
- At adoption
- Log entry
- Not appended yet
- Binding text
- English
Proposed, not in force
Open for comment until 28 October 2026, 00:00 UTC. Nothing here binds anyone until it is adopted.
Scope
This policy binds every GOpenCDR API and every client Tier 0 ships.
API first
Every action is a documented API call first, and the portals use the same public API. No action ships in a portal alone.
The contract
The OpenAPI 3.1 document is generated from the schemas that validate requests and published as the contract. Every error is an RFC 9457 problem with a stable code, and lists page with opaque cursors.
Rule api.contract.
The SDKs, the command line tools and the Terraform provider are generated from the contract or tested against it.
Versions
The major version is part of the path, and within a version the API only ever gains things: nothing is removed or changed in place.
A deprecation is announced at least 12 monthsfixed ahead, with Deprecation and Sunset headers and in a public changelog.
Retries
Every endpoint that changes something accepts an Idempotency-Key and answers a retry with the original result for 24 hoursfixed.
Rate limits
Every endpoint has published limits per credential and per address. Answers carry RateLimit headers, a refused request gets 429 with Retry-After, and no request is ever dropped silently.
Rule api.rate_limits.