IP Restrictions
Create IP Restriction
Create a new IP restriction
Request
POST /ip_restrictions
Example Request
Loading…
Parameters
| Name | Type | Description |
|---|---|---|
description | string | human-readable description of this IP restriction. optional, max 255 bytes. |
metadata | string | arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes. |
enforced | boolean | true if the IP restriction will be enforced. if false, only warnings will be issued |
type | string | the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: dashboard, api, agent, and endpoints |
ip_policy_ids | List<string> | the set of IP policy identifiers that are used to enforce the restriction |
Response
Returns a 201 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
id | string | unique identifier for this IP restriction |
uri | string | URI of the IP restriction API resource |
created_at | string | timestamp when the IP restriction was created, RFC 3339 format |
description | string | human-readable description of this IP restriction. optional, max 255 bytes. |
metadata | string | arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes. |
enforced | boolean | true if the IP restriction will be enforced. if false, only warnings will be issued |
type | string | the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: dashboard, api, agent, and endpoints |
ip_policies | Ref | the set of IP policies that are used to enforce the restriction |
Ref fields
| Name | Type | Description |
|---|---|---|
id | string | a resource identifier |
uri | string | a uri for locating a resource |
Delete IP Restriction
Delete an IP restriction
Request
DELETE /ip_restrictions/{id}
Example Request
Loading…
Response
Returns a 204 response with no body on success
Get IP Restriction
Get detailed information about an IP restriction
Request
GET /ip_restrictions/{id}
Example Request
Loading…
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
id | string | unique identifier for this IP restriction |
uri | string | URI of the IP restriction API resource |
created_at | string | timestamp when the IP restriction was created, RFC 3339 format |
description | string | human-readable description of this IP restriction. optional, max 255 bytes. |
metadata | string | arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes. |
enforced | boolean | true if the IP restriction will be enforced. if false, only warnings will be issued |
type | string | the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: dashboard, api, agent, and endpoints |
ip_policies | Ref | the set of IP policies that are used to enforce the restriction |
Ref fields
| Name | Type | Description |
|---|---|---|
id | string | a resource identifier |
uri | string | a uri for locating a resource |
List IP Restrictions
List all IP restrictions on this account
Request
GET /ip_restrictions
Example Request
Loading…
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
ip_restrictions | IPRestriction | the list of all IP restrictions on this account |
uri | string | URI of the IP restrictions list API resource |
next_page_uri | string | URI of the next page, or null if there is no next page |
IPRestriction fields
| Name | Type | Description |
|---|---|---|
id | string | unique identifier for this IP restriction |
uri | string | URI of the IP restriction API resource |
created_at | string | timestamp when the IP restriction was created, RFC 3339 format |
description | string | human-readable description of this IP restriction. optional, max 255 bytes. |
metadata | string | arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes. |
enforced | boolean | true if the IP restriction will be enforced. if false, only warnings will be issued |
type | string | the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: dashboard, api, agent, and endpoints |
ip_policies | Ref | the set of IP policies that are used to enforce the restriction |
Ref fields
| Name | Type | Description |
|---|---|---|
id | string | a resource identifier |
uri | string | a uri for locating a resource |
Update IP Restriction
Update attributes of an IP restriction by ID
Request
PATCH /ip_restrictions/{id}
Example Request
Loading…
Parameters
| Name | Type | Description |
|---|---|---|
id | string | |
description | string | human-readable description of this IP restriction. optional, max 255 bytes. |
metadata | string | arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes. |
enforced | boolean | true if the IP restriction will be enforced. if false, only warnings will be issued |
ip_policy_ids | List<string> | the set of IP policy identifiers that are used to enforce the restriction |
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
id | string | unique identifier for this IP restriction |
uri | string | URI of the IP restriction API resource |
created_at | string | timestamp when the IP restriction was created, RFC 3339 format |
description | string | human-readable description of this IP restriction. optional, max 255 bytes. |
metadata | string | arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes. |
enforced | boolean | true if the IP restriction will be enforced. if false, only warnings will be issued |
type | string | the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: dashboard, api, agent, and endpoints |
ip_policies | Ref | the set of IP policies that are used to enforce the restriction |
Ref fields
| Name | Type | Description |
|---|---|---|
id | string | a resource identifier |
uri | string | a uri for locating a resource |