The Mod API allows you to manage mods for your DayZ server instances. Mods are used to track which game modifications items belong to.
Note: All API requests require authentication. See the Authentication page for details.
Retrieve a paginated list of mods for a specific instance.
GET /api/instance/{instance_sid}/mod| Parameter | Type | Description |
|---|---|---|
instance_sid
|
string | The SID of the instance |
| Parameter | Type | Description |
|---|---|---|
page
|
integer | Page number for pagination (default: 1) |
amount
|
integer | Number of items per page (default: 30) |
like
|
string | Filter mods by name (partial match) |
Retrieve details of a specific mod.
GET /api/instance/{instance_sid}/mod/{mod_sid}| Parameter | Type | Description |
|---|---|---|
instance_sid
|
string | The SID of the instance |
mod_sid
|
string | The SID of the mod |
Create a new mod for an instance.
POST /api/instance/{instance_sid}/mod| Parameter | Type | Description |
|---|---|---|
| instance_sid | string | The SID of the instance |
| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Name of the mod |
| url | string | No | URL to the mod (e.g., Steam Workshop link) |
| is_vanilla | boolean | No | Whether this is the vanilla (base game) mod |
Update an existing mod.
PATCH /api/instance/{instance_sid}/mod/{mod_sid}| Parameter | Type | Description |
|---|---|---|
| instance_sid | string | The SID of the instance |
| mod_sid | string | The SID of the mod |
| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | No | New name of the mod |
| url | string | No | New URL to the mod |
| is_vanilla | boolean | No | Whether this is the vanilla (base game) mod |
Delete a mod.
Warning: Deleting a mod will also delete all classnames associated with it. This action cannot be undone.
DELETE /api/instance/{instance_sid}/mod/{mod_sid}| Parameter | Type | Description |
|---|---|---|
| instance_sid | string | The SID of the instance |
| mod_sid | string | The SID of the mod |