Player Lists

Ban and whitelist entries.

Endpoints

GET POST PUT DELETE

Methods

Read/write

Access

Base path

/api/v1/instances/{instance}/player-lists

Route parameters

Pass public sid values for these route parameters.

{instance} {playerList}

Example request

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

Endpoints

Method	Path	Purpose
GET	`/api/v1/instances/{instance}/player-lists`	List player list entries
POST	`/api/v1/instances/{instance}/player-lists`	Create a player list entry
GET	`/api/v1/instances/{instance}/player-lists/{playerList}`	Get player list entry details
PUT	`/api/v1/instances/{instance}/player-lists/{playerList}`	Update a player list entry
DELETE	`/api/v1/instances/{instance}/player-lists/{playerList}`	Delete a player list entry

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 player name.
`type`	string	Filter by list type, such as ban or whitelist.

Request fields

Field	Type	Required	Description
`type`	string	required	List type: "ban" or "whitelist"
`player_id`	string	required	Player identifier (Steam64 ID)
`name`	string	required	Player name
`note`	string	optional	Admin note
`steam_name`	string	optional	Steam display name
`steam_id`	string	optional	Steam64 ID
`be_id`	string	optional	BattlEye GUID
`expires_at`	date	optional	Expiry date (null = permanent)
`is_public`	boolean	optional	Publicly visible

Example response

{
    "data": {
        "id": 7,
        "sid": "nO4pQr",
        "instance_id": 1,
        "type": "ban",
        "player_id": "76561198000000001",
        "name": "PlayerName",
        "note": "Banned for cheating",
        "steam_name": "SteamUser123",
        "be_id": null,
        "steam_id": "76561198000000001",
        "expires_at": "2026-12-31T23:59:59.000000Z",
        "is_public": false,
        "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}/player-lists?page=1",
        "last": "https://beta.dzconfig.com/api/v1/instances/{instance}/player-lists?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.