Wiki Navigation

📁 Configuration Files
⚙️ Configuration Settings
🖥️ Server Configuration
🔌 API Documentation
📋 Legal

Mod API Endpoints

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.

List Mods

Retrieve a paginated list of mods for a specific instance.

Request

GET /api/instance/{instance_sid}/mod

URL Parameters

Parameter Type Description
instance_sid string The SID of the instance

Query Parameters

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)

Response

{
  "current_page": 1,
  "data": [
    {
      "sid": "abc123",
      "name": "Vanilla",
      "url": null,
      "is_vanilla": true
    },
    {
      "sid": "def456",
      "name": "CUP Weapons",
      "url": "https://steamcommunity.com/sharedfiles/filedetails/?id=123456789",
      "is_vanilla": false
    }
  ],
  "first_page_url": "http://example.com/api/instance/xyz789/mod?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "http://example.com/api/instance/xyz789/mod?page=1",
  "links": [
    {
      "url": null,
      "label": "« Previous",
      "active": false
    },
    {
      "url": "http://example.com/api/instance/xyz789/mod?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": null,
      "label": "Next »",
      "active": false
    }
  ],
  "next_page_url": null,
  "path": "http://example.com/api/instance/xyz789/mod",
  "per_page": 30,
  "prev_page_url": null,
  "to": 2,
  "total": 2
}

Get Mod

Retrieve details of a specific mod.

Request

GET /api/instance/{instance_sid}/mod/{mod_sid}

URL Parameters

Parameter Type Description
instance_sid string The SID of the instance
mod_sid string The SID of the mod

Response

{
  "id": 1,
  "sid": "abc123",
  "instance_id": 1,
  "name": "Vanilla",
  "url": null,
  "is_vanilla": true,
  "created_at": "2023-05-01T12:00:00.000000Z",
  "updated_at": "2023-05-01T12:00:00.000000Z"
}

Create Mod

Create a new mod for an instance.

Request

POST /api/instance/{instance_sid}/mod

URL Parameters

Parameter Type Description
instance_sid string The SID of the instance

Request Body

Parameter Type Required Description
name string Required Name of the mod
url string Optional URL to the mod (e.g., Steam Workshop link)
is_vanilla boolean Optional Whether this is the vanilla (base game) mod

Response

{
  "id": 2,
  "sid": "def456",
  "instance_id": 1,
  "name": "CUP Weapons",
  "url": "https://steamcommunity.com/sharedfiles/filedetails/?id=123456789",
  "is_vanilla": false,
  "created_at": "2023-05-01T12:00:00.000000Z",
  "updated_at": "2023-05-01T12:00:00.000000Z"
}

Update Mod

Update an existing mod.

Request

PATCH /api/instance/{instance_sid}/mod/{mod_sid}

URL Parameters

Parameter Type Description
instance_sid string The SID of the instance
mod_sid string The SID of the mod

Request Body

Parameter Type Required Description
name string Optional New name of the mod
url string Optional New URL to the mod
is_vanilla boolean Optional Whether this is the vanilla (base game) mod

Response

{
  "id": 2,
  "sid": "def456",
  "instance_id": 1,
  "name": "CUP Weapons and Vehicles",
  "url": "https://steamcommunity.com/sharedfiles/filedetails/?id=123456789",
  "is_vanilla": false,
  "created_at": "2023-05-01T12:00:00.000000Z",
  "updated_at": "2023-05-01T12:30:00.000000Z"
}

Delete Mod

Delete a mod.

Warning: Deleting a mod will also delete all classnames associated with it. This action cannot be undone.

Request

DELETE /api/instance/{instance_sid}/mod/{mod_sid}

URL Parameters

Parameter Type Description
instance_sid string The SID of the instance
mod_sid string The SID of the mod

Response

{
  "result": true
}
Back to API Documentation Next: Types API