Events

Central economy event definitions.

Endpoints

GET POST PUT DELETE

Methods

Read/write

Access

Base path

/api/v1/instances/{instance}/events

Route parameters

Pass public sid values for these route parameters.

{instance} {event}

Example request

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

Endpoints

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

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 event name.
`active`	boolean	Use 1 for active or 0 for inactive.

Request fields

Field	Type	Required	Description
`name`	string	required	Event name
`nominal`	integer	required	Target spawn count
`min`	integer	required	Minimum count
`max`	integer	required	Maximum count
`lifetime`	integer	required	Lifetime in seconds
`restock`	integer	optional	Restock time
`active`	boolean	optional	Whether event is active

Example response

{
    "data": {
        "id": 20,
        "sid": "eF7gHi",
        "instance_id": 1,
        "name": "InfectedArmy",
        "nominal": 30,
        "min": 20,
        "max": 40,
        "lifetime": 150,
        "restock": 0,
        "safe_radius": 0,
        "distance_radius": 0,
        "cleanup_radius": 100,
        "active": true,
        "children_count": 3,
        "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}/events?page=1",
        "last": "https://beta.dzconfig.com/api/v1/instances/{instance}/events?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.