Project IP Access

Try an address against a project's IP access policy

Changed on

Evaluates the stored policy, or an unsaved draft when mode and cidrs are supplied, using the same matcher the proxy uses.

post/projects/{project_id}/ip-access/test

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/test
  • Auth: HTTP bearer

Path parameters

project_idinteger required

Project ID

Request body

ipstring required

Address to evaluate.

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

How a scope's CIDR list is applied.

Example request

{
  "cidrs": [
    {
      "cidr": "100.64.0.0/10",
      "description": "Tailscale"
    }
  ],
  "ip": "100.101.102.103"
}

Response

Evaluation result

allowedboolean required
ipstring required

The address as evaluated (IPv4-mapped IPv6 is shown as IPv4).

matched_cidrstring nullable

The listed CIDR the address fell inside, when one did.

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

How a scope's CIDR list is applied.

reasonstring required

One-sentence explanation suitable for display.

source'draft' | 'environment' | 'project' | 'none' required

Which policy decided a test.

Changes