Wiki Navigation

API Reference
CRUD Operations

Events API

Manage dynamic events for your server. Control helicopter crashes, police car spawns, contaminated zones, and other special events that spawn throughout the map.

Authentication required: All endpoints require a valid Bearer token.

Available Endpoints

GET /api/instance/{instance_sid}/event

List all events for an instance

GET /api/instance/{instance_sid}/event/{event_sid}

Get a specific event

POST /api/instance/{instance_sid}/event

Create a new event

PATCH /api/instance/{instance_sid}/event/{event_sid}

Update an event

DELETE /api/instance/{instance_sid}/event/{event_sid}

Delete an event

Request Body Parameters

name required

Event name identifier

nominal integer

Target active count

min integer

Minimum active count

max integer

Maximum active count

lifetime integer

Event duration in seconds

active boolean

Whether event is enabled