API Reference

The App Config.json REST API allows you to programmatically manage application configurations, sync changes across environments, and version control your settings. All API requests must be made over HTTPS.

Base URL

https://api.appconfig.json/v3

Authentication

All requests require a Bearer token in the Authorization header. Generate tokens from your dashboard under Settings → API Keys.

Authorization: Bearer <your_api_key>

Authentication

App Config.json uses API keys to authenticate requests. Keep your keys secure and never expose them in client-side code or public repositories.

POST /auth/token/refresh

Refresh an expired access token using a valid refresh token. Tokens expire after 1 hour by default.

Parameter	Type	Required	Description
refresh_token	string	Required	Your valid refresh token
grant_type	string	Optional	Must be `refresh_token`

List Applications

Returns a paginated list of all applications associated with your API key.

GET /v3/apps Retrieve all applications

Query Parameter	Type	Required	Description
limit	integer	Optional	Number of items per page (max 100)
cursor	string	Optional	Pagination cursor from previous response

curl -X GET \n https://api.appconfig.json/v3/apps?limit=20 \n -H "Authorization: Bearer YOUR_API_KEY"

200 OK Response

{\n "data": [\n {\n "id": "app_2Xk9mP4vL",\n "name": "payment-service",\n "environment": "production",\n "created_at": "2025-01-15T08:30:00Z",\n "config_count": 42\n }\n ],\n "meta": {\n "total": 12,\n "next_cursor": "eyJpZCI6MTB9"\n }\n}

Create Application

Registers a new application and initializes its configuration namespace.

POST /v3/apps Register new application

Body Parameter	Type	Required	Description
name	string	Required	Unique application identifier
environment	string	Required	Target environment (`dev`, `staging`, `prod`)
region	string	Optional	Deployment region (`us-east-1`, `eu-west-1`, etc.)

curl -X POST \n https://api.appconfig.json/v3/apps \n -H "Authorization: Bearer YOUR_API_KEY" \n -H "Content-Type: application/json" \n -d '{\n "name": "auth-service"\n "environment": "production"\n}'

Update Configuration

Updates or creates a configuration key-value pair for an application. Changes are queued for real-time sync.

PUT /v3/apps/{app_id}/configs/{key} Upsert configuration

Body Parameter	Type	Required	Description
value	any	Required	Configuration value (string, number, bool, object, or array)
description	string	Optional	Human-readable description
encrypt	boolean	Optional	Enable server-side encryption for this key

200 OK Response

{\n "id": "cfg_8Hj2nQ9wX",\n "key": "api.timeout_ms",\n "value": 5000,\n "updated_at": "2025-08-12T14:22:01Z",\n "version": 4,\n "sync_status": "propagating"\n}

Sync Configurations

Triggers an immediate configuration push to all connected application instances. Use this after bulk updates.

POST /v3/apps/{app_id}/configs/sync Force real-time sync

202 Accepted Response

{\n "sync_id": "sync_3Lm7vR2pY",\n "status": "queued",\n "target_instances": 14,\n "estimated_completion": "2025-08-12T14:22:05Z"\n}

Error Codes

App Config.json uses standard HTTP status codes and returns detailed error payloads.

Status	Code	Description
200	OK	Request successful
201	Created	Resource successfully created
202	Accepted	Request accepted for async processing
400	Bad Request	Invalid parameters or malformed JSON
401	Unauthorized	Missing or invalid API key
403	Forbidden	Insufficient permissions for this resource
404	Not Found	Resource does not exist
429	Too Many Requests	Rate limit exceeded (100 req/min)
500	Internal Error	Unexpected server failure