IP Address / Whitelist

What can you do with IPAddressWhitelist?


Properties

Property Details
id
"id": 969
Type: Number
This is the unique numeric identifier for the IPAddressWhitelist
userId
"userId": 391
Type: Number
Unique identifier for the associated User object.
sourceIPAddress
"sourceIPAddress": "Hello World"
Type: String


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • userId
  • sourceIPAddress

DataFlow PATCH objects:


End Points

DELETEapi/v1/IPAddress/Whitelist/{id:int}
Delete an instance of the IPAddressWhitelist object.
GETapi/v1/IPAddress/Whitelist
Retrieve all of the IPAddressWhitelist objects.
GETapi/v1/IPAddress/Whitelist/Metadata
Retrieve all of the meta data details of the IPAddressWhitelist object.
GETapi/v1/IPAddress/Whitelist/Metadata/{option}
Retrieve all the meta data details of the IPAddressWhitelist object based on provided options.
{option}Metadata options for the IPAddressWhitelist object.
GETapi/v1/IPAddress/Whitelist/Paged
Retreive all of the IPAddressWhitelist objects in a paged fashion.
GETapi/v1/IPAddress/Whitelist/{id:int}
Retrieve an instance of the IPAddressWhitelist object by it's ID.
{id:int}Unique identifier for the IPAddressWhitelist object.
POSTapi/v1/IPAddress/Whitelist
Create a new instance of the IPAddressWhitelist object.
PUTapi/v1/IPAddress/Whitelist/{id:int}
Update an existing instance of the IPAddressWhitelist object.