Get IP allowlist settings

Request

Retrieve the current IP allowlist configuration for the workspace.

Security

bearerAuth

Intercom-Versionstring(intercom_version)

Intercom API version.
If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:Preview

library(httr)

url = "https://api.intercom.io/ip_allowlist"

data_req <- GET(
  url,
  add_headers("Intercom-Version" = "Preview", "Authorization" = "Bearer <YOUR_TOKEN_HERE>"),
  verbose()
)

content(data_req)

Responses

Successful response

Bodyapplication/json

typestring

String representing the object's type. Always has the value ip_allowlist.

Example:"ip_allowlist"

enabledboolean

Whether the IP allowlist is enabled for the workspace.

Example:true

ip_allowlistArray of strings

List of allowed IP addresses and/or IP ranges in CIDR notation. Examples:

Single IP: 192.168.0.1
IP range: 192.168.0.1/24 (allows 192.168.0.0 - 192.168.0.255)

Example:

[
  "192.168.1.0/24",
  "10.0.0.1"
]

Response

{
  "type": "ip_allowlist",
  "enabled": true,
  "ip_allowlist": [
    "192.168.1.0/24",
    "10.0.0.1"
  ]
}