Wiki Navigation

Wiki Home
Configuration Files
Overview types.xml events.xml globals.xml economy.xml messages.xml
Config Settings
cfgeconomycore.xml cfgEffectArea.json cfgenvironment.xml cfgeventspawns.xml cfggameplay.json cfgIgnoreList.xml cfgweather.xml
Server Config
cfglimitsdefinition.xml cfgplayerspawnpoints.xml cfgrandompresets.xml cfgspawnabletypes.xml serverDZ.cfg Server Start .bat
API
Overview Authentication Instances Classnames Categories Subcategories Mods Types File Generates File Uploads Messages Events Trader Items
Legal
Terms & Conditions
API Reference
CRUD Operations

Classnames API

Manage item classnames for your DayZ server instances. Classnames are the unique identifiers for items in the game, used throughout configuration files.

Authentication required: All endpoints require a valid Bearer token. See Authentication for details.

GET

List Classnames

Retrieve a paginated list of classnames for a specific instance.

Endpoint

GET /api/instance/{instance_sid}/classname

Parameters

instance_sid
string required

The SID of the instance (URL parameter)

page integer

Page number for pagination. Defaults to 1.

like string

Filter classnames by name using partial match.

Response

{
  "current_page": 1,
  "data": [
    {
      "sid": "abc123",
      "mod_id": 1,
      "category_id": 1,
      "subcategory_id": 2,
      "name": "AKM"
    }
  ],
  "per_page": 30,
  "total": 300
}
GET

Get Classname

Retrieve details of a specific classname.

Endpoint

GET /api/instance/{instance_sid}/classname/{classname_sid}

URL Parameters

instance_sid required

The SID of the instance

classname_sid required

The SID of the classname

POST

Create Classname

Create a new classname for an instance.

Endpoint

POST /api/instance/{instance_sid}/classname

Request Body

name
string required

The classname identifier

category_id
integer required

ID of the category

mod_id integer

ID of the mod (optional)

subcategory_id integer

ID of the subcategory (optional)

PATCH

Update Classname

PATCH /api/instance/{instance_sid}/classname/{classname_sid}

Update an existing classname. Include only fields to change.

DELETE

Delete Classname

DELETE /api/instance/{instance_sid}/classname/{classname_sid}

Permanently delete a classname from the instance.

Instances API Next: Categories API