Wiki Navigation

API Reference
CRUD Operations

Categories API

Manage item categories for your DayZ server instances. Categories help organize items into logical groups like weapons, clothing, food, and tools.

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

GET

List Categories

Retrieve a paginated list of categories for a specific instance.

Endpoint

GET /api/instance/{instance_sid}/category

Parameters

instance_sid
string required

The SID of the instance (URL parameter)

page integer

Page number for pagination. Defaults to 1.

like string

Filter categories by name using partial match.

Response

{
  "current_page": 1,
  "data": [
    { "sid": "abc123", "name": "Weapons" },
    { "sid": "def456", "name": "Clothing" }
  ],
  "per_page": 30,
  "total": 45
}
GET

Get Category

Retrieve details of a specific category.

Endpoint

GET /api/instance/{instance_sid}/category/{category_sid}
POST

Create Category

Create a new category for an instance.

Endpoint

POST /api/instance/{instance_sid}/category

Request Body

name
string required

Name of the category (e.g., "Weapons", "Food", "Tools")

PATCH

Update Category

PATCH /api/instance/{instance_sid}/category/{category_sid}

Update an existing category name.

DELETE

Delete Category

DELETE /api/instance/{instance_sid}/category/{category_sid}

Permanently delete a category. Items in this category may become uncategorized.