Retrieve an IP ACL

This API is used to retrieve a single IP ACL by unique Id.

Request#

Retrieve an IP ACL by Id

GET/api/ip-acl/{ipAccessControlListId}

OpenAPI Spec

Request Parameters#

ipAccessControlListIdUUIDrequired

The unique Id of the IP ACL to retrieve.

Response#

Response Codes

Code	Description
200	The request was successful. The response will contain a JSON body.
400	The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401	You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404	The object you requested doesn't exist. The response will be empty.
500	There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body#

ipAccessControlListsArray

The list of all IP ACLs

ipAccessControlList.entriesArray

A list of IP ranges and the action to apply for each. One and only one entry will have a startIPAddress of * to indicate the default action of the IP ACL.

ipAccessControlList.entries[x].actionString

The action to take for this IP Range.

ipAccessControlList.entries[x].endIPAddressString

The ending IP (IPv4) for this range.

ipAccessControlList.entries[x].startIPAddressString

The starting IP (IPv4) for this range.

ipAccessControlList.nameString

The unique name of this IP ACL.

Example IP ACL response JSON

{
  "ipAccessControlList": {
    "name": "Block two specific ranges",
    "entries": [
      {
        "action": "Allow",
        "startIPAddress": "*"
      },
      {
        "action": "Block",
        "startIPAddress": "76.104.0.0",
        "endIPAddress": "76.104.255.255"
      },
      {
        "action": "Block",
        "startIPAddress": "71.205.0.0",
        "endIPAddress": "71.205.255.255"
      }
    ],
    "id": "2d9f1c45-725a-4718-b631-b40b7180dbf5",
    "insertInstant": 1628887035851,
    "lastUpdateInstant": 1628887035851
  }
}