Project IP Access

Get a project's IP access policy

Changed on

Returns configured: false and mode disabled when nothing is stored.

get/projects/{project_id}/ip-access

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/projects/{project_id}/ip-access
  • Auth: HTTP bearer

Path parameters

project_idinteger required

Project ID

Response

The project-wide IP access policy

configuredboolean required

false when nothing is stored for this scope. For an environment that means it inherits the project-wide policy.

environment_idinteger nullable

null for the project-wide policy.

max_cidrsinteger required

Maximum number of CIDRs a policy may hold.

mode'disabled' | 'allow' | 'deny' required

How a scope's CIDR list is applied.

project_idinteger required
updated_atstring date-time nullable
your_ipstring nullable

The address this request arrived from, as the console resolved it. It is the address the project will see only if the console and the project are reached over the same network path.

Example response

{
  "cidrs": [
    {
      "cidr": "100.64.0.0/10",
      "description": "Tailscale"
    }
  ],
  "updated_at": "2026-10-13T09:30:00Z",
  "your_ip": "203.0.113.9"
}

Changes