IPWhitelists

Create IPWhitelist

Creates a new IPWhitelist

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
ipWhitelist_Key
required
integer <int32>

Identity key for the record. Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

description
required
string [ 1 .. 1024 ] characters

User-defined description for the record to help identify the reason for usage.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

iP_Address
required
string [ 1 .. 39 ] characters

IP Address that will be whitelisted for accessing the APIs. This field supports both single IPv4 addresses and CIDR blocks for specifying IP ranges.

  • Single IP Address: Provide a specific IPv4 address (e.g., "192.168.1.1") to whitelist that single address.
  • CIDR Block: Provide a CIDR block (e.g., "192.168.1.0/24") to whitelist a range of addresses.

Notes:

  • The value must be unique within the whitelist.
  • The maximum length of this field is 39 characters to accommodate IPv4 addresses and CIDR notation.
  • Ensure that the provided IP address or CIDR block is correctly formatted to avoid validation errors.
update_Date
string <date-time>

Date when the record was last updated in the system.

update_User
string or null <= 20 characters

User that last updated the record in the system.

Responses
200

Success

401

Unauthorized

post/ipwhitelists
Request samples
{
  • "ipWhitelist_Key": 0,
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "iP_Address": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List IPWhitelist

Lists all IPWhitelist

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/ipwhitelists
Request samples 
Response samples 
No sample
Get IPWhitelist
Gets IPWhitelist


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
ipWhitelist_Key
required
integer <int32> 
IPWhitelist Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/ipwhitelists/{ipWhitelist_Key}
Request samples 
Response samples 
No sample
Update IPWhitelist
Updates a specific IPWhitelist.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
ipWhitelist_Key
required
integer <int32> 
IPWhitelist Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
ipWhitelist_Key
required
integer <int32> 
Identity key for the record.  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
description
required
string  [ 1 .. 1024 ] characters 
User-defined description for the record to help identify the reason for usage.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
iP_Address
required
string  [ 1 .. 39 ] characters 
IP Address that will be whitelisted for accessing the APIs. This field supports both single IPv4 addresses and CIDR blocks for specifying IP ranges. 


    

  • Single IP Address: Provide a specific IPv4 address (e.g., "192.168.1.1") to whitelist that single address.
    • 

  • CIDR Block: Provide a CIDR block (e.g., "192.168.1.0/24") to whitelist a range of addresses.
    • 



Notes:


    

  • The value must be unique within the whitelist.
    • 

  • The maximum length of this field is 39 characters to accommodate IPv4 addresses and CIDR notation.
    • 

  • Ensure that the provided IP address or CIDR block is correctly formatted to avoid validation errors.
    • 



 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
Responses 
200
Success


401
Unauthorized


put/ipwhitelists/{ipWhitelist_Key}
Request samples 
{
  • "ipWhitelist_Key": 0,
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "iP_Address": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete IPWhitelist
Deletes an IPWhitelist


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
ipWhitelist_Key
required
integer <int32> 
IPWhitelist Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/ipwhitelists/{ipWhitelist_Key}
Request samples 
Create or Update Batch IPWhitelist
Create or Update multiple IPWhitelist at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
ipWhitelist_Key
required
integer <int32> 
Identity key for the record.  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
description
required
string  [ 1 .. 1024 ] characters 
User-defined description for the record to help identify the reason for usage.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
iP_Address
required
string  [ 1 .. 39 ] characters 
IP Address that will be whitelisted for accessing the APIs. This field supports both single IPv4 addresses and CIDR blocks for specifying IP ranges. 


    

  • Single IP Address: Provide a specific IPv4 address (e.g., "192.168.1.1") to whitelist that single address.
    • 

  • CIDR Block: Provide a CIDR block (e.g., "192.168.1.0/24") to whitelist a range of addresses.
    • 



Notes:


    

  • The value must be unique within the whitelist.
    • 

  • The maximum length of this field is 39 characters to accommodate IPv4 addresses and CIDR notation.
    • 

  • Ensure that the provided IP address or CIDR block is correctly formatted to avoid validation errors.
    • 



 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
Responses 
207
Success


401
Unauthorized


put/ipwhitelists-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}