Subcategory API Endpoints

The Subcategory API allows you to manage item subcategories for your DayZ server instances. Subcategories provide a more detailed organization of items within categories.

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

List Subcategories

Retrieve a paginated list of subcategories for a specific instance.

Request

GET /api/instance/{instance_sid}/subcategory

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

Response

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

Get Subcategory

Retrieve details of a specific subcategory.

Request

GET /api/instance/{instance_sid}/subcategory/{subcategory_sid}

URL Parameters

Parameter	Type	Description
`instance_sid`	string	The SID of the instance
`subcategory_sid`	string	The SID of the subcategory

Response

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

Create Subcategory

Create a new subcategory for an instance.

Request

POST /api/instance/{instance_sid}/subcategory

URL Parameters

Parameter	Type	Description
instance_sid	string	The SID of the instance

Request Body

Parameter	Type	Required	Description
name	string	Yes	Name of the subcategory
category_id	integer	Yes	ID of the parent category

Response

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

Update Subcategory

Update an existing subcategory.

Request

PATCH /api/instance/{instance_sid}/subcategory/{subcategory_sid}

URL Parameters

Parameter	Type	Description
instance_sid	string	The SID of the instance
subcategory_sid	string	The SID of the subcategory

Request Body

Parameter	Type	Required	Description
name	string	No	New name of the subcategory
category_id	integer	No	New parent category ID

Response

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

Delete Subcategory

Delete a subcategory.

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

Request

DELETE /api/instance/{instance_sid}/subcategory/{subcategory_sid}

URL Parameters

Parameter	Type	Description
instance_sid	string	The SID of the instance
subcategory_sid	string	The SID of the subcategory

Response

{
  "result": true
}

Back to API Documentation Next: Mods API

Wiki Navigation

Subcategory API Endpoints

List Subcategories

Request

URL Parameters

Query Parameters

Response

Get Subcategory

Request

URL Parameters

Response

Create Subcategory

Request

URL Parameters

Request Body

Response

Update Subcategory

Request

URL Parameters

Request Body

Response

Delete Subcategory

Request

URL Parameters

Response