Mods

Custom mod definitions.

Endpoints

GET POST PUT DELETE

Methods

Read/write

Access

Base path

/api/v1/mods

Route parameters

Pass public sid values for these route parameters.

{mod}

Example request

curl -X GET 'https://beta.dzconfig.com/api/v1/mods?per_page=10' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

Endpoints

Method	Path	Purpose
GET	`/api/v1/mods`	List mods
POST	`/api/v1/mods`	Create a mod
GET	`/api/v1/mods/{mod}`	Get mod details
PUT	`/api/v1/mods/{mod}`	Update a mod
DELETE	`/api/v1/mods/{mod}`	Delete a mod

Query parameters

Parameter	Type	Description
`page`	integer	Page number. Defaults to 1.
`per_page`	integer	Items per page. Values are clamped from 1 to 100.

Request fields

Field	Type	Required	Description
`name`	string	required	Mod name (max 255 chars)
`steam_id`	string	optional	Steam Workshop ID
`app_id`	string	optional	Steam App ID
`description`	string	optional	Mod description

Example response

{
    "data": {
        "id": 5,
        "sid": "qR4tYu",
        "name": "Expansion",
        "slug": "expansion",
        "steam_id": "2116157322",
        "app_id": "221100",
        "description": "DayZ Expansion mod",
        "enabled": true,
        "classnames_count": 340,
        "created_at": "2026-01-15T10:30:00.000000Z",
        "updated_at": "2026-04-20T08:15:00.000000Z"
    }
}

Paginated list shape

{
    "data": [
        {
            "sid": "abc123xy",
            "...": "resource fields"
        }
    ],
    "links": {
        "first": "https://beta.dzconfig.com/api/v1/mods?page=1",
        "last": "https://beta.dzconfig.com/api/v1/mods?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "per_page": 10,
        "total": 1
    }
}

Status codes

Code	Label	Description
`200`	OK	Returned for successful reads, updates, and deletes.
`201`	Created	Returned when a POST creates a resource.
`401`	Unauthorized	Missing or invalid bearer token.
`403`	Forbidden	Your plan or permissions do not allow this action.
`404`	Not found	The route parameter did not match an accessible resource.
`413`	Storage limit exceeded	Storing the file would exceed your plan's upload count, generated count, or total storage cap.
`422`	Validation error	Request fields failed validation.
`429`	Rate limited	Too many API requests in a short period.