Instance API Endpoints

The Instance API allows you to manage your DayZ server instances. You can list, create, view, update, and delete instances.

Note: All API requests require authentication. See the Authentication page for details.

List Instances

Retrieve a paginated list of all your instances.

Request

GET /api/instance

Query Parameters

Parameter	Type	Description
`page`	integer	Page number for pagination (default: 1)
`amount`	integer	Number of items per page (default: 30)
`like`	string	Filter instances by name (partial match)

Response

{
  "current_page": 1,
  "data": [
    {
      "id": 1,
      "sid": "abc123",
      "name": "My DayZ Server",
      "map_id": 1,
      "ip": "192.168.1.1",
      "port": 2302,
      "query_port": 27016,
      "hostname": "example.com",
      "connection_port": 21,
      "username": "ftpuser",
      "is_sftp": false,
      "dir": "/dayz",
      "share_uid": null,
      "use_vanilla_classnames": true,
      "use_types_config": true,
      "created_at": "2023-05-01T12:00:00.000000Z",
      "updated_at": "2023-05-01T12:00:00.000000Z"
    }
  ],
  "first_page_url": "http://example.com/api/instance?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "http://example.com/api/instance?page=1",
  "links": [
    {
      "url": null,
      "label": "« Previous",
      "active": false
    },
    {
      "url": "http://example.com/api/instance?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": null,
      "label": "Next »",
      "active": false
    }
  ],
  "next_page_url": null,
  "path": "http://example.com/api/instance",
  "per_page": 6,
  "prev_page_url": null,
  "to": 1,
  "total": 1
}

Get Instance

Retrieve details of a specific instance.

Request

GET /api/instance/{instance_sid}

URL Parameters

Parameter	Type	Description
`instance_sid`	string	The SID of the instance

Response

{
  "id": 1,
  "sid": "abc123",
  "name": "My DayZ Server",
  "map_id": 1,
  "ip": "192.168.1.1",
  "port": 2302,
  "query_port": 27016,
  "hostname": "example.com",
  "connection_port": 21,
  "username": "ftpuser",
  "is_sftp": false,
  "dir": "/dayz",
  "share_uid": null,
  "use_vanilla_classnames": true,
  "use_types_config": true,
  "created_at": "2023-05-01T12:00:00.000000Z",
  "updated_at": "2023-05-01T12:00:00.000000Z",
  "map": {
    "id": 1,
    "name": "Chernarus",
    "name_short": "cherno",
    "url": "https://example.com/maps/chernarus.jpg",
    "is_modded": false
  }
}

Create Instance

Create a new instance.

Request

POST /api/instance

Request Body

Parameter	Type	Required	Description
`name`	string	Required	Name of the instance
`map_id`	integer	Required	ID of the map
`ip`	string	Optional	IP address of the server
`port`	integer	Optional	Game port of the server
`query_port`	integer	Optional	Query port of the server
`hostname`	string	Optional	Hostname for FTP/SFTP connection
`connection_port`	integer	Optional	Port for FTP/SFTP connection
`username`	string	Optional	Username for FTP/SFTP connection
`password`	string	Optional	Password for FTP/SFTP connection
`is_sftp`	boolean	Optional	Whether to use SFTP instead of FTP
`dir`	string	Optional	Directory path on the server
`use_vanilla_classnames`	boolean	Optional	Whether to use vanilla classnames
`use_types_config`	boolean	Optional	Whether to use types config

Response

{
  "id": 1,
  "sid": "abc123",
  "name": "My DayZ Server",
  "map_id": 1,
  "ip": "192.168.1.1",
  "port": 2302,
  "query_port": 27016,
  "hostname": "example.com",
  "connection_port": 21,
  "username": "ftpuser",
  "is_sftp": false,
  "dir": "/dayz",
  "share_uid": null,
  "use_vanilla_classnames": true,
  "use_types_config": true,
  "created_at": "2023-05-01T12:00:00.000000Z",
  "updated_at": "2023-05-01T12:00:00.000000Z"
}

Update Instance

Update an existing instance.

Request

PATCH /api/instance/{instance_sid}

URL Parameters

Parameter	Type	Description
instance_sid	string	The SID of the instance

Request Body

Include any of the fields from the Create Instance endpoint that you want to update.

Response

{
  "id": 1,
  "sid": "abc123",
  "name": "Updated DayZ Server",
  "map_id": 1,
  "ip": "192.168.1.1",
  "port": 2302,
  "query_port": 27016,
  "hostname": "example.com",
  "connection_port": 21,
  "username": "ftpuser",
  "is_sftp": false,
  "dir": "/dayz",
  "share_uid": null,
  "use_vanilla_classnames": true,
  "use_types_config": true,
  "created_at": "2023-05-01T12:00:00.000000Z",
  "updated_at": "2023-05-01T12:30:00.000000Z",
  "map": {
    "id": 1,
    "name": "Chernarus",
    "name_short": "cherno",
    "url": "https://example.com/maps/chernarus.jpg",
    "is_modded": false
  }
}

Delete Instance

Delete an instance.

Request

DELETE /api/instance/{instance_sid}

URL Parameters

Parameter	Type	Description
instance_sid	string	The SID of the instance

Response

{
  "result": true
}

Back to API Documentation Next: Classnames API

Wiki Navigation

Instance API Endpoints

List Instances

Request

Query Parameters

Response

Get Instance

Request

URL Parameters

Response

Create Instance

Request

Request Body

Response

Update Instance

Request

URL Parameters

Request Body

Response

Delete Instance

Request

URL Parameters

Response