Types

Loot economy type definitions for an instance.

Endpoints

GET POST PUT DELETE

Methods

Read/write

Access

Base path

/api/v1/instances/{instance}/types

Route parameters

Pass public sid values for these route parameters.

{instance} {type}

Example request

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

Endpoints

Method	Path	Purpose
GET	`/api/v1/instances/{instance}/types`	List types
POST	`/api/v1/instances/{instance}/types`	Create a type
GET	`/api/v1/instances/{instance}/types/{type}`	Get type details
PUT	`/api/v1/instances/{instance}/types/{type}`	Update a type
DELETE	`/api/v1/instances/{instance}/types/{type}`	Delete a type

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.
`search`	string	Match the linked instance classname.
`category`	integer	Filter by category ID.
`tag`	integer	Filter by type tag ID.
`status`	string	Use enabled or disabled.

Request fields

Field	Type	Required	Description
`instance_classname_id`	integer	required	Instance classname ID
`nominal`	integer	required	Target spawn count
`lifetime`	integer	required	Lifetime in seconds
`restock`	integer	required	Restock time in seconds
`min`	integer	required	Minimum count before restock
`qmin`	integer	optional	Quantity min (-1 = disabled)
`qmax`	integer	optional	Quantity max (-1 = disabled)
`cost`	integer	optional	Priority cost (100 = default)
`count_in_cargo`	boolean	optional	Count items in cargo
`count_in_hoarders`	boolean	optional	Count items in stashes
`count_in_players`	boolean	optional	Count items on players
`count_in_map`	boolean	optional	Count items on map
`crafted`	boolean	optional	Is a crafted item
`deloot`	boolean	optional	Dynamic event loot

Example response

{
    "data": {
        "id": 500,
        "sid": "uV5wXy",
        "instance_id": 1,
        "instance_classname_id": 100,
        "nominal": 10,
        "lifetime": 7200,
        "restock": 1800,
        "min": 5,
        "qmin": -1,
        "qmax": -1,
        "cost": 100,
        "count_in_cargo": false,
        "count_in_hoarders": false,
        "count_in_players": false,
        "count_in_map": true,
        "crafted": false,
        "deloot": 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}/types?page=1",
        "last": "https://beta.dzconfig.com/api/v1/instances/{instance}/types?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.