Replace existing allowlist with provided list of IP addresses & ranges

PUT 
/api/v1/ip-allowlist

Replace existing allowlist with provided list of IP addresses & ranges

Request

Query Parameters

force boolean

When true, entries will be updated even if the list doesn't contain the requestor's IP address

application/json

Body

required

entries

object[]

required

Allowlist entries

Array [

address stringrequired

IP address or range

description string

Description of an entry

]

Responses

200

Successfully replaced allowlist

application/json

Schema

Schema

entries

object[]

required

Allowlist entries

Array [

address stringrequired

IP address or range

description string

Description of an entry

]

Example (from schema)

{
  "entries": [
    {
      "address": "10.0.0.1",
      "description": "string"
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

details string
gatewayHttpStatus int32
httpStatus int32
message stringrequired
requestId string
type stringrequired

Possible values: [INTEGRATION_MISSING, INTEGRATION_UNREGISTERED, INTEGRATION_UNSUPPORTED, INTEGRATION_GRAPHQL_ERROR, INTEGRATION_BAD_REQUEST, INTEGRATION_UNAUTHORIZED, INTEGRATION_FORBIDDEN, INTEGRATION_NOT_FOUND, INTEGRATION_UNPROCESSABLE_CONTENT, INTEGRATION_RATE_LIMITED, INTEGRATION_INTERNAL_ERROR, INTEGRATION_NOT_IMPLEMENTED, INTEGRATION_BAD_GATEWAY, INTEGRATION_UNAVAILABLE, INTEGRATION_GATEWAY_TIMEOUT, INTEGRATION_TIMED_OUT, INTEGRATION_CACHE_ERROR, INTEGRATION_UNHANDLED_HTTP_ERROR, INTEGRATION_UNHANDLED_EXCEPTION, INTEGRATION_UNEXPECTED_ERROR, ILLEGAL_ARGUMENT_ERROR, BAD_REQUEST, FORBIDDEN, NOT_FOUND, REQUEST_TIMEOUT, CONFLICT, UNHANDLED_EXCEPTION, UNCATEGORIZED, SERVICE_CREATOR, UNKNOWN_HOST]

Example (from schema)

{
  "details": "string",
  "gatewayHttpStatus": 0,
  "httpStatus": 0,
  "message": "string",
  "requestId": "string",
  "type": "INTEGRATION_MISSING"
}

Loading...