Classname API Endpoints

The Classname API allows you to manage item classnames for your DayZ server instances. Classnames are the unique identifiers for items in the game.

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

List Classnames

Retrieve a paginated list of classnames for a specific instance.

Request

GET /api/instance/{instance_sid}/classname

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

Response

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

Get Classname

Retrieve details of a specific classname.

Request

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

URL Parameters

Parameter	Type	Description
`instance_sid`	string	The SID of the instance
`classname_sid`	string	The SID of the classname

Response

{
  "id": 1,
  "sid": "abc123",
  "instance_id": 1,
  "mod_id": 1,
  "category_id": 1,
  "subcategory_id": 2,
  "name": "AKM",
  "has_image": true,
  "has_stats": true,
  "created_at": "2023-05-01T12:00:00.000000Z",
  "updated_at": "2023-05-01T12:00:00.000000Z"
}

Create Classname

Create a new classname for an instance.

Request

POST /api/instance/{instance_sid}/classname

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 classname
`mod_id`	integer	Optional	ID of the mod
`category_id`	integer	Required	ID of the category
`subcategory_id`	integer	Optional	ID of the subcategory
`has_image`	boolean	Optional	Whether the classname has an image
`has_stats`	boolean	Optional	Whether the classname has stats

Response

{
  "id": 1,
  "sid": "abc123",
  "instance_id": 1,
  "mod_id": 1,
  "category_id": 1,
  "subcategory_id": 2,
  "name": "AKM",
  "has_image": true,
  "has_stats": true,
  "created_at": "2023-05-01T12:00:00.000000Z",
  "updated_at": "2023-05-01T12:00:00.000000Z"
}

Update Classname

Update an existing classname.

Request

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

URL Parameters

Parameter	Type	Description
`instance_sid`	string	The SID of the instance
`classname_sid`	string	The SID of the classname

Request Body

Include any of the fields from the Create Classname endpoint that you want to update.

Response

{
  "id": 1,
  "sid": "abc123",
  "instance_id": 1,
  "mod_id": 2,
  "category_id": 3,
  "subcategory_id": 4,
  "name": "AKM_Updated",
  "has_image": true,
  "has_stats": true,
  "created_at": "2023-05-01T12:00:00.000000Z",
  "updated_at": "2023-05-01T12:30:00.000000Z"
}

Delete Classname

Delete a classname.

Request

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

URL Parameters

Parameter	Type	Description
`instance_sid`	string	The SID of the instance
`classname_sid`	string	The SID of the classname

Response

{
  "result": true
}

Back to API Documentation Next: Categories API

Wiki Navigation

Classname API Endpoints

List Classnames

Request

URL Parameters

Query Parameters

Response

Get Classname

Request

URL Parameters

Response

Create Classname

Request

URL Parameters

Request Body

Response

Update Classname

Request

URL Parameters

Request Body

Response

Delete Classname

Request

URL Parameters

Response