Category API Endpoints

The Category API allows you to manage item categories for your DayZ server instances. Categories are used to organize items in the game.

Note: All API requests require authentication. See the Authentication page for details.

List Categories

Retrieve a paginated list of categories for a specific instance.

Request

GET /api/instance/{instance_sid}/category

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 categories by name (partial match)

Response

{
  "current_page": 1,
  "data": [
    {
      "sid": "abc123",
      "name": "Weapons"
    },
    {
      "sid": "def456",
      "name": "Clothing"
    }
  ],
  "first_page_url": "http://example.com/api/instance/xyz789/category?page=1",
  "from": 1,
  "last_page": 2,
  "last_page_url": "http://example.com/api/instance/xyz789/category?page=2",
  "links": [
    {
      "url": null,
      "label": "« Previous",
      "active": false
    },
    {
      "url": "http://example.com/api/instance/xyz789/category?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": "http://example.com/api/instance/xyz789/category?page=2",
      "label": "2",
      "active": false
    },
    {
      "url": "http://example.com/api/instance/xyz789/category?page=2",
      "label": "Next »",
      "active": false
    }
  ],
  "next_page_url": "http://example.com/api/instance/xyz789/category?page=2",
  "path": "http://example.com/api/instance/xyz789/category",
  "per_page": 30,
  "prev_page_url": null,
  "to": 30,
  "total": 45
}

Get Category

Retrieve details of a specific category.

Request

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

URL Parameters

Parameter	Type	Description
`instance_sid`	string	The SID of the instance
`category_sid`	string	The SID of the category

Response

{
  "id": 1,
  "sid": "abc123",
  "instance_id": 1,
  "name": "Weapons",
  "created_at": "2023-05-01T12:00:00.000000Z",
  "updated_at": "2023-05-01T12:00:00.000000Z"
}

Create Category

Create a new category for an instance.

Request

POST /api/instance/{instance_sid}/category

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 category

Response

{
  "id": 1,
  "sid": "abc123",
  "instance_id": 1,
  "name": "Weapons",
  "created_at": "2023-05-01T12:00:00.000000Z",
  "updated_at": "2023-05-01T12:00:00.000000Z"
}

Update Category

Update an existing category.

Request

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

URL Parameters

Parameter	Type	Description
`instance_sid`	string	The SID of the instance
`category_sid`	string	The SID of the category

Request Body

Parameter	Type	Required	Description
`name`	string	Optional	New name of the category

Response

{
  "id": 1,
  "sid": "abc123",
  "instance_id": 1,
  "name": "Firearms",
  "created_at": "2023-05-01T12:00:00.000000Z",
  "updated_at": "2023-05-01T12:30:00.000000Z"
}

Delete Category

Delete a category.

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

Request

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

URL Parameters

Parameter	Type	Description
`instance_sid`	string	The SID of the instance
`category_sid`	string	The SID of the category

Response

{
  "result": true
}

Back to API Documentation Next: Subcategories API

Wiki Navigation

Category API Endpoints

List Categories

Request

URL Parameters

Query Parameters

Response

Get Category

Request

URL Parameters

Response

Create Category

Request

URL Parameters

Request Body

Response

Update Category

Request

URL Parameters

Request Body

Response

Delete Category

Request

URL Parameters

Response