StatusDashboard
DashboardsNetwork

Get IP allowlist

Retrieve the IP allowlist configuration for a dashboard.

View Markdown

GET /app/dashboards/{id}/ipallowlist

Returns the current IP allowlist configuration for a dashboard. Requires the IP Allowlist feature entitlement.


Path parameters

ParameterDescription
idThe UUID of the dashboard.

Request

See API Basics for required headers.

This endpoint takes no request body.


Sample request

curl https://api.statusdashboard.com/app/dashboards/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ipallowlist \
  -H "Authorization: Bearer bcf847abf5c6:def456"

Sample response

Status: 200 OK

{
  "enabled": true,
  "allowlist": ["203.0.113.0/24", "198.51.100.42", "2001:db8::1"]
}

When no allowlist has been configured yet, enabled and allowlist are undefined (absent from the response).


Response fields

FieldTypeDescription
enabledboolean | omittedWhether IP allowlist enforcement is active. Same semantics as Toggle IP allowlist. Omitted when never configured.
allowliststring[] | omittedAllowed IP addresses and CIDR ranges. Same format and constraints as Update IP allowlist. Omitted when never configured.

Error responses

StatusWhen
403Insufficient permissions, or the IP Allowlist feature is not enabled.
404Dashboard not found or does not belong to the caller's organization.

On this page

We use cookies

We use essential cookies to keep the site working, and optional analytics cookies to understand how it's used. Read our Privacy Policy.