Add an IP to Allowlist

POST 
/partner/auth/ip_addresses

Add a specified IP address to the allowlist. Both IPv4 and IPv6 are supported.

Request

Responses

200

200Success

Response 200

{
  "message": {
    "key": "RES000000",
    "value": "success"
  },
  "data": {
    "ip_addresses": [
      "203.0.113.50"
    ],
    "count": 2
  }
}

Schema Details

Field	Type	Description
message	object
data	object

400

400Bad Request

Response 400

{
  "message": {
    "key": "RES000002",
    "value": "Bad Request"
  }
}

Schema Details

Field	Type	Description
message	object

401

401Unauthorized

Response 401

{
  "message": {
    "key": "RES000033",
    "value": "Unauthorized"
  }
}

Schema Details

Field	Type	Description
message	object

409

409Conflict

Response 409

{
  "message": {
    "key": "RES000204",
    "value": "IP address already registered."
  },
  "data": {}
}

Schema Details

Field	Type	Description
message	object
data	object

422

422Unprocessable Entity

Response 422

{
  "message": {
    "key": "RES000205",
    "value": "Maximum 20 IP addresses allowed."
  },
  "data": {}
}

Schema Details

Field	Type	Description
message	object
data	object

500

500Internal server error

Response 500

{
  "message": {
    "key": "RES000029",
    "value": "An internal server error has occurred."
  }
}

Schema Details

Field	Type	Description
message	object