List the IP allow list for portal

Lists the IP allow list configuration for a portal.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[before]string

Request the next page of data, starting with the item before this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

page[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

The portal’s IP allow list configuration.

* Additional properties are NOT allowed.
metaobjectrequired
Show Child Parameters
dataarray[object]requiredunique-items

An entry representing a collection of allowed IP addresses or CIDR blocks.

<= 1000 items

Example:[{"id":"660e8400-e29b-41d4-a716-446655440000","allowed_ips":["192.168.1.1"]},{"id":"550e8400-e29b-41d4-a716-446655440000","allowed_ips":["192.168.1.0/22","192.168.1.52"]}]

* Additional properties are NOT allowed.
Show Child Parameters
get/portals/{portalId}/ip-allow-list
 
application/json

Replace an IP allow list for a portal

Replace an IP allow list for a portal.

put

Path Parameters

portalIdstring(uuid)required

ID of the portal.

idstring(uuid)required

ID of the allow list.

Body

application/json
* Additional properties are NOT allowed.
allowed_ipsarray[string]requiredunique-items

The list of allowed ips for the portal.

>= 1 items<= 25 items

Example:["192.168.1.1","192.168.1.0/22"]

Response

application/json

The portal’s IP allow list configuration.

IPEntry

An entry representing a collection of allowed IP addresses or CIDR blocks.

* Additional properties are NOT allowed.
idstring(uuid)required

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

allowed_ipsarray[string]requiredunique-items

The list of allowed ips for the portal.

>= 1 items<= 25 items

Example:["192.168.1.1","192.168.1.0/22"]

put/portals/{portalId}/ip-allow-list/{id}

Body

{ "allowed_ips": [ "192.168.1.1", "192.168.1.0/22" ] }
 
application/json

Update an IP allow list for a portal

Update an IP allow list for a portal.

patch

Path Parameters

portalIdstring(uuid)required

ID of the portal.

idstring(uuid)required

ID of the allow list.

Body

application/json
* Additional properties are NOT allowed.
allowed_ipsarray[string]unique-items

The list of allowed ips for the portal.

>= 1 items<= 25 items

Example:["192.168.1.1","192.168.1.0/22"]

Response

application/json

The portal’s IP allow list configuration.

IPEntry

An entry representing a collection of allowed IP addresses or CIDR blocks.

* Additional properties are NOT allowed.
idstring(uuid)required

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

allowed_ipsarray[string]requiredunique-items

The list of allowed ips for the portal.

>= 1 items<= 25 items

Example:["192.168.1.1","192.168.1.0/22"]

patch/portals/{portalId}/ip-allow-list/{id}

Body

{ "allowed_ips": [ "192.168.1.1", "192.168.1.0/22" ] }
 
application/json

Delete an IP allow list from a portal

Delete the IP allow list for a portal.

delete

Path Parameters

portalIdstring(uuid)required

ID of the portal.

idstring(uuid)required

ID of the allow list.

Response

No Content

delete/portals/{portalId}/ip-allow-list/{id}
 

Update Portal Audit Log Replay Job

Updates a job to re-send audit logs to an portal’s webhook.

put

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

The request schema to replace a portal audit log replay job.

start_atstring(date-time)required

The start of a date-time range in RFC3339 format e.g. 2017-07-21T17:32:28Z.
Must be within the last 7 days.

end_atstring(date-time)required

The end of a date-time range in RFC3339 format e.g. 2017-07-21T17:32:28Z.
Must be within the last 7 days.

Response

application/json

Response from fetching or updating an portal audit log replay job

start_atstring(date-time)

The start of a date-time range. Initial value is 0001-01-01T00:00:0Z.

Example:2017-07-21T17:32:28Z

end_atstring(date-time)

The end of a date-time range. Initial value is 0001-01-01T00:00:0Z.

Example:2017-07-21T17:32:28Z

statusstringread-only

Allowed values:unconfiguredacceptedpendingrunningcompletedfailed

updated_atstring(date-time)read-only

Timestamp when this job was last updated. Initial value is 0001-01-01T00:00:0Z.

put/portals/{portalId}/audit-log-replay-job

Body

{ "start_at": "start_at", "end_at": "end_at" }
 
application/json