Skip to main content
POST
Create an IP address

Authorizations

Authorization
string
header
required

Body

application/json

Body

ip
string
required

The IP address.

Maximum string length: 50
Pattern: ^(\b25[0-5]|\b2[0-4][0-9]|\b[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}(\/([0-9]|[1-2][0-9]|3[0-2]))?$
Example:

"8.8.8.8"

description
string
required

A description of the IP address.

Maximum string length: 256
Example:

"John Smith's home IP"

personId
string<uuid> | null

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

Maximum string length: 36

Response

201 - application/json

Created

id
string<uuid>
required

The ID of the IP address.

Maximum string length: 36
Example:

"2327f0d0-2cb5-4f31-8de2-b9d04036fdd9"

ip
string
required

The IP address.

Maximum string length: 50
Pattern: ^(\b25[0-5]|\b2[0-4][0-9]|\b[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}(\/([0-9]|[1-2][0-9]|3[0-2]))?$
Example:

"8.8.8.8"

description
string
required

A description of the IP address.

Maximum string length: 256
Example:

"John Smith's home IP"

createdAt
string<date-time>
required

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

updatedAt
string<date-time>
required

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

ipaddressableId
string<uuid>
ipaddressableType
string
Maximum string length: 36