Ips

Read Ip

get

Path parameters

uidintegerRequired

Responses

200

Successful Response

application/json

idintegerRequired

ip_addressstringRequired

liststring · enumRequiredPossible values:

descriptionstring · nullableRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get/api/v2/ips/{uid}

GET /api/v2/ips/{uid} HTTP/1.1
Accept: */*

{
  "id": 1,
  "ip_address": "text",
  "list": "allow",
  "description": "text",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Delete Ip

delete

Path parameters

uidintegerRequired

Responses

204

Successful Response

No content

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

delete/api/v2/ips/{uid}

DELETE /api/v2/ips/{uid} HTTP/1.1
Accept: */*

No content

Read Ips

get

Query parameters

ip_liststring · enumOptionalPossible values:

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get/api/v2/ips

GET /api/v2/ips HTTP/1.1
Accept: */*

{
  "records": [
    {
      "id": 1,
      "ip_address": "text",
      "list": "allow",
      "description": "text",
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Create Ip

post

Body

ip_addressstringRequired

descriptionstring · nullableOptional

liststring · enumRequiredPossible values:

Responses

201

Successful Response

application/json

idintegerRequired

ip_addressstringRequired

liststring · enumRequiredPossible values:

descriptionstring · nullableRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post/api/v2/ips

POST /api/v2/ips HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "ip_address": "text",
  "description": "text",
  "list": "allow"
}

{
  "id": 1,
  "ip_address": "text",
  "list": "allow",
  "description": "text",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}