Skip to content

API overview

Base URL: https://api.amendable.io

Interactive OpenAPI: https://api.amendable.io/docs Machine OpenAPI: https://api.amendable.io/openapi.json

Auth: header access-token. JSON in, JSON out. Create often returns 201. Delete returns 204 with an empty body.

Git is not on the API host. Git is https://amendable.io/r/.... Staging hosts: Environments.

MethodPathGrant
POST/v1/auth/sessionsnone
GET/v1/auth/sessions/{id}/pollnone (secret query param)
GET/v1/account/usageany token
GET/v1/repositoriesany token
POST/v1/repositoriesAPI_REPOS_WRITE
GET/v1/repos/{user}/{name}any token that can see it
DELETE/v1/repos/{user}/{name}API_REPOS_WRITE
GET/v1/repos/{user}/{name}/branchesAPI_COMMITS_READ
GET/v1/repos/{user}/{name}/commitsAPI_COMMITS_READ
GET/POST/v1/access-tokensALL + ALL_REPO
GET/PUT/DELETE/v1/access-tokens/{id}ALL + ALL_REPO
GET/POST/v1/webhooksAPI_WEBHOOKS
GET/DELETE/v1/webhooks/{id}API_WEBHOOKS
POST/v1/webhooks/{id}/pingAPI_WEBHOOKS
GET/v1/webhooks/{id}/deliveriesAPI_WEBHOOKS
GET/POST/v1/storage-bucketsAPI_STORAGE
GET/v1/storage-buckets/oidc-setupAPI_STORAGE
GET/v1/storage-buckets/errorsAPI_STORAGE
PUT/DELETE/v1/storage-buckets/{id}API_STORAGE
POST/v1/storage-buckets/{id}/verifyAPI_STORAGE
POST/v1/oidc/tokennone (ID token in body)
GET/v1/oidc-trust-rules/setupAPI_OIDC_TRUST + ALL_REPO
GET/POST/v1/oidc-trust-rulesAPI_OIDC_TRUST + ALL_REPO
GET/PUT/DELETE/v1/oidc-trust-rules/{id}API_OIDC_TRUST + ALL_REPO

ALL satisfies any grant. Device-login session routes are omitted from the public OpenAPI schema (include_in_schema=False) but they work. The CLI uses them.

Errors: Errors.