List all Access IP Addresses

GET 
/access_ip_address

List all Access IP Addresses

Request

Query Parameters

filter[ip_source] string
filter[ip_address] string
filter[created_at][gt] date-time
filter[created_at][lt] date-time
page[number] integer

Default value: 1

page[size] integer

Possible values: <= 250

Default value: 20

Responses

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

data

object[]

required

Array [

id Id (string)required

ip_address Ip Address (string)required

source Source (string)required

status CloudflareSyncStatus (string)required

Possible values: [pending, added]

An enumeration.

description Description (string)

user_id User Id (string)required

created_at date-time

updated_at date-time

]

meta

object

required

page_number integerrequired

page_size integerrequired

total_pages integerrequired

total_results integerrequired

{
  "data": [
    {
      "id": "string",
      "ip_address": "string",
      "source": "string",
      "status": "pending",
      "description": "string",
      "user_id": "string",
      "created_at": "2024-04-26T12:28:37.231Z",
      "updated_at": "2024-04-26T12:28:37.231Z"
    }
  ],
  "meta": {
    "page_number": 0,
    "page_size": 0,
    "total_pages": 0,
    "total_results": 0
  }
}

422: Validation Error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code intrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Loading...