Messages

Server broadcast messages.

Endpoints

GET POST PUT DELETE

Methods

Read/write

Access

Base path

/api/v1/instances/{instance}/messages

Route parameters

Pass public sid values for these route parameters.

{instance} {message}

Example request

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

Endpoints

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

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
`message`	string	required	Message text
`delay`	integer	optional	Delay in seconds before showing
`repeat`	integer	optional	Repeat interval (0 = once)
`deadline`	integer	optional	Deadline (-1 = none)
`on_connect`	boolean	optional	Show on player connect
`shutdown`	boolean	optional	Show before shutdown

Example response

{
    "data": {
        "id": 12,
        "sid": "cD7eFg",
        "instance_id": 1,
        "message": "Server restart in 5 minutes!",
        "delay": 300,
        "repeat": 0,
        "deadline": -1,
        "on_connect": false,
        "shutdown": 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}/messages?page=1",
        "last": "https://beta.dzconfig.com/api/v1/instances/{instance}/messages?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.