v1

latestOpenAPI 3.1.0UNLICENSED2026-07-2613101.1 MB

IP addresses

Create an IP address

Creates an IP address.

post/ipaddresses

Request body

ipstring required

The IP address.

descriptionstring required

A description of the IP address.

personIdstring uuid nullable

ID of the person to work with. If not set, defaults to caller’s ID

Example request

{
  "ip": "8.8.8.8",
  "description": "John Smith's home IP",
  "personId": "f3e5ff26-28ff-4cd6-9b1b-e303a185a13a"
}

Response

Created

idstring uuid required

The ID of the IP address.

ipaddressableIdstring uuid

ipstring required

The IP address.

descriptionstring required

A description of the IP address.

ipaddressableTypestring

createdAtstring date-time required

The date the Resource was initially created. ISO 8601 format without milliseconds.

updatedAtstring date-time required

The date the Resource was last modified. ISO 8601 format without milliseconds.

Example response

{
  "id": "2327f0d0-2cb5-4f31-8de2-b9d04036fdd9",
  "ipaddressableId": "8365191f-08b8-4dc5-88fd-73fcd7fd41a1",
  "ip": "8.8.8.8",
  "description": "John Smith's home IP",
  "ipaddressableType": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}