Wiki Navigation

REST API
JSON Format

API Documentation

The DZconfig API allows you to programmatically manage your DayZ server configurations. Interact with instances, classnames, categories, types, and more through a simple RESTful interface.

Quick Start

All API requests require Bearer token authentication and return responses in JSON format. Find your API token in your user profile settings, then include it in the Authorization header of every request.

curl -X GET "https://dzconfig.com/api/instance" \
     -H "Authorization: Bearer YOUR_API_TOKEN" \
     -H "Accept: application/json"

Base URL

All API endpoints are relative to:

https://dzconfig.com/api

Rate Limiting

API requests are limited to 60 requests per minute to ensure fair usage across all users. Exceeding this limit returns a 429 status code.

Rate limit exceeded response: 429 Too Many Requests

Error Handling

Errors return JSON with an error key and appropriate HTTP status code. Always check the response status before processing data.

{
  "error": "Unauthorized",
  "message": "Invalid API token"
}

Response Format

All responses are returned in JSON format. Successful responses return a 2xx status code, while errors return 4xx or 5xx status codes with descriptive error messages.

Success
200, 201, 204
Client Error
400, 401, 403, 404, 422, 429
Server Error
500, 502, 503

Pro Tips

Store your API token securely and never expose it in client-side code. Use environment variables in your applications. For bulk operations, batch your requests to stay within rate limits. Each endpoint documentation page includes detailed examples with request and response formats.