Create an IP address

Creates an IP address.

SecurityCommonAuth
Request
Request Body schema: application/json

Body

ip
required
string <= 50 characters ^(\b25[0-5]|\b2[0-4][0-9]|\b[01]?[0-9][0-9]?)...

The IP address.

description
required
string <= 256 characters

A description of the IP address.

personId
string or null <uuid> <= 36 characters

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

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

post/ipaddresses
Request samples
application/json
{
  • "ip": "8.8.8.8",
  • "description": "John Smith's home IP",
  • "personId": "f3e5ff26-28ff-4cd6-9b1b-e303a185a13a"
}
Response samples
application/json
{
  • "id": "2327f0d0-2cb5-4f31-8de2-b9d04036fdd9",
  • "ip": "8.8.8.8",
  • "description": "John Smith's home IP",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}