IP Allowlist

Use these operations to interact with the IP allowlist in Cortex.

Required permissions

Your API key must have the Configure IP allowlist permission.

Operations

Gets allowlist of IP addresses & ranges

get

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Query parameters

pageSizeinteger · int32Required

Number of results to return per page, between 1 and 1000. Default 250.

Default: 250

pageinteger · int32Required

Page number to return, 0-indexed. Default 0.

Default: 0

Responses

200

Successfully retrieved IP allowlist

application/json

pageinteger · int32Required

Current page number, 0-indexed

totalinteger · int32Required

Total number of results

totalPagesinteger · int32Required

Total number of pages

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

get

/api/v1/ip-allowlist

HTTPcURLJavaScriptPython

GET /api/v1/ip-allowlist?pageSize=250&page=0 HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "entries": [
    {
      "address": "10.0.0.1",
      "description": "text"
    }
  ],
  "page": 1,
  "total": 1,
  "totalPages": 1
}

Validates allowlist of IP addresses & ranges

post

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Body

application/json

Responses

200

Successfully validated allowlist

application/json

or

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

post

/api/v1/ip-allowlist/validate

HTTPcURLJavaScriptPython

POST /api/v1/ip-allowlist/validate HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "entries": [
    {
      "address": "10.0.0.1",
      "description": "text"
    }
  ]
}

{
  "address": "10.0.0.1",
  "description": "text",
  "valid": true
}

Replace existing allowlist with provided list of IP addresses & ranges

put

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Query parameters

forcebooleanOptional

When true, entries will be updated even if the list doesn't contain the requestor's IP address

Body

application/json

Responses

200

Successfully replaced allowlist

application/json

pageinteger · int32Required

Current page number, 0-indexed

totalinteger · int32Required

Total number of results

totalPagesinteger · int32Required

Total number of pages

400

Bad Request

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

put

/api/v1/ip-allowlist

HTTPcURLJavaScriptPython

PUT /api/v1/ip-allowlist HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "entries": [
    {
      "address": "10.0.0.1",
      "description": "text"
    }
  ]
}

{
  "entries": [
    {
      "address": "10.0.0.1",
      "description": "text"
    }
  ],
  "page": 1,
  "total": 1,
  "totalPages": 1
}