KOkong
Portals IP Allow List

Create an IP allow list for a portal

Changed on

Create an IP allow list for a portal.

post/v3/portals/{portalId}/ip-allow-list

Request

Request body

allowed_ipsstring[] required

The list of allowed ips for the portal.

Example request

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

Response

The portal's IP allow list configuration.

idstring uuid required

Contains a unique identifier used for this resource.

allowed_ipsstring[] required

The list of allowed ips for the portal.

Example response

{
  "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "allowed_ips": [
    "192.168.1.1",
    "192.168.1.0/22"
  ]
}

Changes

  • 30af8b28f6efRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • f530bf400198Revision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status