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
When true, entries will be updated even if the list doesn't contain the requestor's IP address
- application/json
Body
required
Array [
]
entries
object[]
required
Allowlist entries
IP address or range
Description of an entry
Responses
- 200
- 400
- 429
Successfully replaced allowlist
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
entries
object[]
required
Allowlist entries
IP address or range
Description of an entry
Current page number, 0-indexed
Total number of results
Total number of pages
{
"entries": [
{
"address": "10.0.0.1",
"description": "string"
}
],
"page": 0,
"total": 0,
"totalPages": 0
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
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
]
{
"details": "string",
"gatewayHttpStatus": 0,
"httpStatus": 0,
"message": "string",
"requestId": "string",
"type": "INTEGRATION_MISSING"
}
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
Response Headers
Retry-After
integer
The number of seconds until the rate limiting resets.
- application/problem+json
- Schema
- Example (from schema)
Schema
The number of seconds until the rate limiting resets.
Possible values: >= 100
and <= 599
, [429
]
{
"detail": "string",
"instance": "string",
"retryAfter": 0,
"status": 429,
"title": "string",
"type": "string"
}