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

Query parameters

pageSizeinteger · int32 · default: 250required

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

pageinteger · int32 · default: 0required

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

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/ip-allowlist?pageSize=1&page=1' \
  --header 'Authorization: Bearer JWT'

200

429

200

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

Successfully retrieved IP allowlist

Validates allowlist of IP addresses & ranges

post

Authorizations

Body

entriesobject[]required

Allowlist entries

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/ip-allowlist/validate' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "entries": [
      {
        "address": "10.0.0.1",
        "description": "text"
      }
    ]
  }'

200

429

200

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

Successfully validated allowlist

Replace existing allowlist with provided list of IP addresses & ranges

put

Authorizations

Query parameters

forcebooleanoptional

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

Body

entriesobject[]required

Allowlist entries

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.getcortexapp.com/api/v1/ip-allowlist' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "entries": [
      {
        "address": "10.0.0.1",
        "description": "text"
      }
    ]
  }'

200

400

429

200

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

Successfully replaced allowlist