DZconfig / Wiki
Log in
API Home
Operational 1
API resources

Instance Resources

Effect Areas

Map effect area zones (contamination, etc.).

5
Endpoints
GET POST PUT DELETE
Methods
Read/write
Access

Base path

/api/v1/instances/{instance}/effect-areas

Route parameters

Pass public sid values for these route parameters.

{instance} {effectArea}

Example request

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

Endpoints

Method Path Purpose
GET /api/v1/instances/{instance}/effect-areas List effect areas
POST /api/v1/instances/{instance}/effect-areas Create an effect area
GET /api/v1/instances/{instance}/effect-areas/{effectArea} Get effect area details
PUT /api/v1/instances/{instance}/effect-areas/{effectArea} Update an effect area
DELETE /api/v1/instances/{instance}/effect-areas/{effectArea} Delete an effect area

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 effect area name.

Request fields

Field Type Required Description
area_name string required Area name identifier
type string optional Area type (e.g. ContaminatedArea_Dynamic)
trigger_type string optional Trigger type (e.g. Player)
x numeric optional X coordinate
y numeric optional Y coordinate (height)
z numeric optional Z coordinate
radius numeric optional Effect radius
height numeric optional Effect height
particle_name string optional Particle effect name

Example response

{
    "data": {
        "id": 4,
        "sid": "xY6zAb",
        "instance_id": 1,
        "area_name": "Rify_Contamination",
        "type": "ContaminatedArea_Dynamic",
        "trigger_type": "Player",
        "x": "13254.50",
        "y": "0.00",
        "z": "3283.75",
        "radius": "200.00",
        "height": "30.00",
        "particle_name": null,
        "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}/effect-areas?page=1",
        "last": "https://beta.dzconfig.com/api/v1/instances/{instance}/effect-areas?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.