API Endpoints Reference
Interact with App Config.json programmatically. All endpoints use JSON request/response bodies and return standard HTTP status codes.
Overview
Base URL: https://api.appconfig.json/v1
All requests and responses are UTF-8 encoded. The API supports CORS for cross-origin requests. Timestamps are returned in ISO 8601 format.
Authentication
Authenticate requests using Bearer tokens. Include your API key in the Authorization header.
Generate keys in Dashboard → Settings → API Keys
Rate Limits
| Plan | Requests / min | Burst |
|---|---|---|
| Starter | 60 | 10 |
| Pro | 600 | 50 |
| Enterprise | Unlimited | Custom |
Exceeding limits returns 429 Too Many Requests. Headers include X-RateLimit-Remaining and X-RateLimit-Reset.
Apps
Manage application registries and metadata.
Retrieve a paginated list of all applications associated with your account.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
limit | integer | Max results per page (default: 20, max: 100) |
offset | integer | Pagination cursor |
sort | string | Sort field: created_at, name, updated_at |
Response Example
Create a new application instance.
Request Body
Environments
Define and manage deployment environments per app.
List environments for a specific application. Deprecated in v3.2
Use GET /v1/configs?app_id={app_id}&env=* for the updated workflow.
Configurations
Core endpoints for pushing, fetching, and versioning configuration snapshots.
Push a new configuration snapshot. Triggers real-time sync to connected instances.
Request Body
Response
Fetch a specific configuration snapshot by ID. Used by SDKs for hydration.
Webhooks
Subscribe to configuration events for CI/CD pipelines and alerting.
Register a new webhook endpoint.
Request Body
Error Handling
The API uses conventional HTTP response codes:
| Code | Meaning |
|---|---|
200 | Success |
400 | Bad Request (validation failed) |
401 | Unauthorized (invalid/missing token) |
403 | Forbidden (insufficient permissions) |
404 | Not Found |
429 | Too Many Requests |
500 | Internal Server Error |
Error responses include a JSON payload with error.code and error.message.