Skip to main content
POST
/
ipaddresses
Create an IP address
curl --request POST \
  --url https://api.equalsmoney.com/v2/ipaddresses \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "ip": "8.8.8.8",
  "description": "John Smith's home IP",
  "personId": "f3e5ff26-28ff-4cd6-9b1b-e303a185a13a"
}
EOF
{
  "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"
}

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