Manage your DayZ server instances programmatically. Create, read, update, and delete instances along with their associated configurations and resources.
Authentication required: All endpoints require a valid Bearer token. See Authentication for details.
Retrieve a paginated list of all your instances.
GET /api/instance
page
integer
Page number for pagination. Defaults to 1.
amount
integer
Number of items per page. Defaults to 30.
like
string
Filter instances by name using partial match.
{
"current_page": 1,
"data": [
{
"id": 1,
"sid": "abc123",
"name": "My DayZ Server",
"map_id": 1,
"ip": "192.168.1.1",
"port": 2302,
"query_port": 27016
}
],
"per_page": 30,
"total": 1
}Retrieve details of a specific instance by its SID.
GET /api/instance/{instance_sid}
instance_sid
The unique SID identifier of the instance.
{
"id": 1,
"sid": "abc123",
"name": "My DayZ Server",
"map_id": 1,
"ip": "192.168.1.1",
"port": 2302,
"query_port": 27016,
"hostname": "example.com",
"connection_port": 21,
"username": "ftpuser",
"is_sftp": false,
"dir": "/dayz",
"use_vanilla_classnames": true,
"use_types_config": true,
"map": {
"id": 1,
"name": "Chernarus",
"name_short": "cherno"
}
}Create a new server instance with the specified configuration.
POST /api/instance
name
Name of the instance
map_id
ID of the map
ip
string
Server IP address
port
integer
Game port (default: 2302)
query_port
integer
Query port for server status
hostname
string
FTP/SFTP hostname
is_sftp
boolean
Use SFTP instead of FTP
dir
string
Server directory path
Update an existing instance. Include only the fields you want to change.
PATCH /api/instance/{instance_sid}
instance_sid
The unique SID identifier of the instance to update.
Request body accepts the same fields as Create Instance. Only include fields you want to update.
Permanently delete an instance and all associated data. This action cannot be undone.
DELETE /api/instance/{instance_sid}
instance_sid
The unique SID identifier of the instance to delete.
Warning: Deleting an instance removes all associated classnames, types, categories, and configurations permanently.
Use the like parameter to search for instances by name when managing multiple servers. Store instance SIDs in your application for quick access to specific servers without listing all instances first.