Instance Classnames

Classnames scoped to a specific instance.

Endpoints

GET POST PUT DELETE

Methods

Read/write

Access

Base path

/api/v1/instances/{instance}/classnames

Route parameters

Pass public sid values for these route parameters.

{instance} {instanceClassname}

Example request

curl -X GET 'https://beta.dzconfig.com/api/v1/instances/{instance}/classnames?per_page=10' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

Endpoints

Method	Path	Purpose
GET	`/api/v1/instances/{instance}/classnames`	List instance classnames
POST	`/api/v1/instances/{instance}/classnames`	Create an instance classname
GET	`/api/v1/instances/{instance}/classnames/{instanceClassname}`	Get instance classname details
PUT	`/api/v1/instances/{instance}/classnames/{instanceClassname}`	Update an instance classname
DELETE	`/api/v1/instances/{instance}/classnames/{instanceClassname}`	Delete an instance classname

Query parameters

Parameter	Type	Description
`page`	integer	Page number. Defaults to 1.
`per_page`	integer	Items per page. Values are clamped from 1 to 100.

Request fields

Field	Type	Required	Description
`name`	string	required	Classname (unique within instance)
`display_name`	string	optional	Human-readable display name
`classname_id`	integer	optional	Link to global classname
`category_id`	integer	optional	Category ID
`sub_category_id`	integer	optional	Subcategory ID
`mod_id`	integer	optional	Mod ID
`payload`	object	optional	Custom metadata JSON
`default_type_values`	object	optional	Default economy values
`is_creature`	boolean	optional	Whether this is a creature
`enabled`	boolean	optional	Whether enabled

Example response

{
    "data": {
        "id": 100,
        "sid": "pQ4rSt",
        "instance_id": 1,
        "user_id": 1,
        "classname_id": 42,
        "category_id": 1,
        "sub_category_id": 3,
        "mod_id": 5,
        "name": "AKM_Custom",
        "display_name": "Custom AKM",
        "payload": {
            "kind": "weapon"
        },
        "default_type_values": {
            "nominal": 4,
            "min": 2
        },
        "is_creature": false,
        "enabled": true,
        "created_at": "2026-02-01T12:00:00.000000Z",
        "updated_at": "2026-04-10T09:30:00.000000Z"
    }
}

Paginated list shape

{
    "data": [
        {
            "sid": "abc123xy",
            "...": "resource fields"
        }
    ],
    "links": {
        "first": "https://beta.dzconfig.com/api/v1/instances/{instance}/classnames?page=1",
        "last": "https://beta.dzconfig.com/api/v1/instances/{instance}/classnames?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "per_page": 10,
        "total": 1
    }
}

Status codes

Code	Label	Description
`200`	OK	Returned for successful reads, updates, and deletes.
`201`	Created	Returned when a POST creates a resource.
`401`	Unauthorized	Missing or invalid bearer token.
`403`	Forbidden	Your plan or permissions do not allow this action.
`404`	Not found	The route parameter did not match an accessible resource.
`413`	Storage limit exceeded	Storing the file would exceed your plan's upload count, generated count, or total storage cap.
`422`	Validation error	Request fields failed validation.
`429`	Rate limited	Too many API requests in a short period.