Wiki Navigation

API Reference
Singleton

Weather API

Configure weather settings for your DayZ server (cfgweather.xml). Control overcast, fog, rain, wind, snowfall, and storm parameters.

Authentication required: All endpoints require a valid Bearer token. See Authentication for details.

GET

Get Weather Settings

Retrieve the weather configuration for an instance.

Endpoint

GET /api/instance/{instance_sid}/weather

Response

{
  "sid": "abc123",
  "reset": 0,
  "enable": 1,
  "o_current_actual": 0.5,
  "o_limits_min": 0.0,
  "o_limits_max": 1.0,
  "r_limits_min": 0.0,
  "r_limits_max": 0.8,
  "storm_density": 10,
  "storm_threshold": 0.9,
  "storm_timeout": 60
}
POST PATCH

Create or Update Weather

Create or update weather settings. Only one weather config exists per instance.

Endpoint

POST /api/instance/{instance_sid}/weather PATCH /api/instance/{instance_sid}/weather

Weather Sections

Overcast (o_)

Cloud coverage settings

Fog (f_)

Fog density settings

Rain (r_)

Precipitation settings

Wind Magnitude (wm_)

Wind strength settings

Wind Direction (wd_)

Wind direction settings

Snowfall (s_)

Snow settings

Common Parameters (per section)

*_current_actual

Current value (0.0-1.0)

*_limits_min/max

Value range limits

*_tlimits_min/max

Time limits (seconds)

*_climits_min/max

Change rate limits

DELETE

Delete Weather Settings

DELETE /api/instance/{instance_sid}/weather

Reset weather to default by deleting the configuration.

Pro Tips

Set reset to 1 to reset weather on server restart. Use r_threshold_min to control when rain starts based on overcast level. Storm settings only trigger during heavy weather conditions.