REST APIs : Available operations and endpoints : OMS endpoints
  
OMS endpoints
 
Page Contents
/about
/assetGroups
/assetPolicies
/assets
/backupfiles
/bayeux
/certificates
/failover
/hsm
/licenses
/logs
/permissions
/protocols
/relationships
/session
/settings/autoUpgrade
/settings/authentication
/settings/backuprestore
/settings/failover
/settings/hsm
/settings/logs
/settings/notifications
/settings/omslicense
/settings/security
/sharedFilters
/softwareserver
/softwareupgrade
/upgradepolicies
/userGroups
/users
This list shows the methods and endpoints available for OMS. Using them you can accomplish nearly any task you can imagine to control or configure OMS.
Base URI: https://hostname/oms/api/
Note: A secure HTTP session is required. Therefore, all requests must be sent to https://. Sending a request to http:// will fail.
For example, if you want to retrieve a list of users from OMS you would use an HTTP GET method. The GET request would be sent to https://hostname/oms/api/users/.
REST sometimes is referred to as using QCRUD, where each letter stands for a different action that can be taken: Query, Create, Read, Update, Delete. The REST API is comprised of these HTTP actions:
GET: used to query for or read data from the server, like user IDs or dashboard results. GET is considered a “safe” method because no changes on the server are made.
POST: used to create new objects, like users, users, or dashboards. For a POST method, the HTTP response contains the URI path and {ID} of the newly created resource in the “Location” HTTP header. For example, when a new user is created, the “Location” HTTP header will contain: "/users/9D24469A-976E-11E4-B88F-002590365523".
PUT: used to update an existing object. All PUT methods must always take the full resource definition, not just fields being modified. A PUT request is considered Idempotent or “unsafe” because it can change an existing object. This is not to imply that PUT actions should not be done. Not at all. Instead, it means simply that you must ensure that the definition you send has exactly the values you want it to have before issuing the PUT.
DELETE: used to delete an object. A DELETE is also considered Idempotent. After an object has been deleted with the DELETE method, it cannot be restored. There is no confirmation requested like there is in the web interface. Use with care!
All time values are specified in UTC using the ISO8601 time format: "2015-10-24T04:06:16Z". The Z at the end of the format indicates that there is no time offset from UTC. UTC does not observe summer time (daylight savings time). It is also possible that UTC may be several hours different from your local time. The web UI client uses its local browser time, but all API requests use UTC.
{ID} denote a variable ID value in the endpoint where ID is a UUID of the form "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX". For example, /users/9D24469A-976E-11E4-B88F-002590365523.
If the word optional is not listed for a parameter, the parameter is required. Some strings are enumerated lists, and the string must be one of the listed items.
/about
 
GET /about About OMS
Result Model
about
productShort ( string  [Max length: 64] )
productLong ( string  [Max length: 128] )
version ( VersionObject )
major ( integer [signed 32-bit] )
minor ( integer [signed 32-bit] )
build ( integer [signed 32-bit] )
patch ( integer [signed 32-bit] )
architecture ( string  [Max length: 16] )
copyright ( string  [Max length: 128] )
license ( string  [Max length: 128] )
serverTimeZoneMinutesOffsetFromUTC ( integer [signed 32-bit] ) : Offset, in minutes, that the server time zone is from UTC. E.g., for CST (-06:00), this value is -360
buildDesc ( string  [Max length: 128] )
 
/assetGroups
Created: 2016-03-24   Revised: 2018-03-27
 
GET /assetGroups Retrieve all asset groups
Result Model
assetgroups
id ( uuid )
flags ( flagsObject )
protected (true|false).
disabled (true|false).
name ( string )
description ( string )
assetbyassetgroup ( assetbyassetgroupObject  [Max: 512] )
relationshipId ( uuid )
assetId ( uuid )
assetGroupId ( uuid )
assetgroupbyusergroup ( assetgroupbyusergroupObject  [Max: 512] )
relationshipId ( uuid )
assetGroupId ( uuid )
userGroupId ( uuid )
etag ( etag )
POST /assetGroups Create a new asset group
Parameters Model
assetgroup
id ( uuid )
flags ( flagsObject )
protected (true|false).
disabled (true|false).
name ( string )
description ( string )
assetbyassetgroup ( assetbyassetgroupObject  [Max: 512] )
relationshipId ( uuid )
assetId ( uuid )
assetGroupId ( uuid )
assetgroupbyusergroup ( assetgroupbyusergroupObject  [Max: 512] )
relationshipId ( uuid )
assetGroupId ( uuid )
userGroupId ( uuid )
etag ( etag )
GET /assetGroups/{assetGroupID} Retrieve a specific asset group by ID
Result Model
assetgroup
id ( uuid )
flags ( flagsObject )
protected (true|false).
disabled (true|false).
name ( string )
description ( string )
assetbyassetgroup ( assetbyassetgroupObject  [Max: 512] )
relationshipId ( uuid )
assetId ( uuid )
assetGroupId ( uuid )
assetgroupbyusergroup ( assetgroupbyusergroupObject  [Max: 512] )
relationshipId ( uuid )
assetGroupId ( uuid )
userGroupId ( uuid )
etag ( etag )
PUT /assetGroups/{assetGroupID} Update a specific asset group by ID
Parameters Model
assetgroup
id ( uuid )
flags ( flagsObject )
protected (true|false).
disabled (true|false).
name ( string )
description ( string )
assetbyassetgroup ( assetbyassetgroupObject  [Max: 512] )
relationshipId ( uuid )
assetId ( uuid )
assetGroupId ( uuid )
assetgroupbyusergroup ( assetgroupbyusergroupObject  [Max: 512] )
relationshipId ( uuid )
assetGroupId ( uuid )
userGroupId ( uuid )
etag ( etag )
DELETE /assetGroups/{assetGroupID} Delete a specific asset group by ID
 
/assetPolicies
Created: 2016-03-24   Revised: 2018-03-27
 
GET /assetPolicies Retrieve all asset policies
Result Model
assetpolicies
id ( uuid )
flags ( flagsObject )
disabled (true|false).
global (true|false).
probelist (true|false).
sharedfilters (true|false).
protocols (true|false).
users (true|false).
licenses (true|false).
requirelogin (true|false).
autoaddasset (true|false).
autoaddlegacyasset (true|false).
logincache (true|false).
minimizedstatelogin (true|false).
name ( string )
description ( string )
cacheHours ( integer [unsigned 16-bit] )
defaultAssetGroup ( uuid )
minTlsVersion ( string )
TLS 1.0 (Default) : Allows TLS 1.0 or newer for application communications.
TLS 1.1 : Allows TLS 1.1 or newer for application communications.
TLS 1.2 : Allows only TLS 1.2 for application communications.
etag ( etag )
POST /assetPolicies Create a new asset policy
Parameters Model
assetpolicy
id ( uuid )
flags ( flagsObject )
disabled (true|false).
global (true|false).
probelist (true|false).
sharedfilters (true|false).
protocols (true|false).
users (true|false).
licenses (true|false).
requirelogin (true|false).
autoaddasset (true|false).
autoaddlegacyasset (true|false).
logincache (true|false).
minimizedstatelogin (true|false).
name ( string )
description ( string )
cacheHours ( integer [unsigned 16-bit] )
defaultAssetGroup ( uuid )
minTlsVersion ( string )
TLS 1.0 (Default) : Allows TLS 1.0 or newer for application communications.
TLS 1.1 : Allows TLS 1.1 or newer for application communications.
TLS 1.2 : Allows only TLS 1.2 for application communications.
etag ( etag )
GET /assetPolicies/{assetPolicyID} Retrieve a specific asset policy by ID
Result Model
assetpolicy
id ( uuid )
flags ( flagsObject )
disabled (true|false).
global (true|false).
probelist (true|false).
sharedfilters (true|false).
protocols (true|false).
users (true|false).
licenses (true|false).
requirelogin (true|false).
autoaddasset (true|false).
autoaddlegacyasset (true|false).
logincache (true|false).
minimizedstatelogin (true|false).
name ( string )
description ( string )
cacheHours ( integer [unsigned 16-bit] )
defaultAssetGroup ( uuid )
minTlsVersion ( string )
TLS 1.0 (Default) : Allows TLS 1.0 or newer for application communications.
TLS 1.1 : Allows TLS 1.1 or newer for application communications.
TLS 1.2 : Allows only TLS 1.2 for application communications.
etag ( etag )
PUT /assetPolicies/{assetPolicyID} Update a specific asset policy by ID
Parameters Model
assetpolicy
id ( uuid )
flags ( flagsObject )
disabled (true|false).
global (true|false).
probelist (true|false).
sharedfilters (true|false).
protocols (true|false).
users (true|false).
licenses (true|false).
requirelogin (true|false).
autoaddasset (true|false).
autoaddlegacyasset (true|false).
logincache (true|false).
minimizedstatelogin (true|false).
name ( string )
description ( string )
cacheHours ( integer [unsigned 16-bit] )
defaultAssetGroup ( uuid )
minTlsVersion ( string )
TLS 1.0 (Default) : Allows TLS 1.0 or newer for application communications.
TLS 1.1 : Allows TLS 1.1 or newer for application communications.
TLS 1.2 : Allows only TLS 1.2 for application communications.
etag ( etag )
DELETE /assetPolicies/{assetPolicyID} Delete a specific asset policy by ID
 
/assets
Created: 2016-03-24   Revised: 2018-03-27
 
GET /assets Retrieve all assets
Result Model
assets
probeid ( integer [unsigned 32-bit] )
id ( uuid )
parentid ( uuid )
element ( integer [unsigned 32-bit] )
type ( integer [unsigned 32-bit] )
flags ( flagsObject )
protected (true|false).
disabled (true|false).
autoupgrade (true|false).
delete (true|false).
namechanged (true|false).
name ( string  [Max length: 64] )
description ( string )
ipaddr ( string )
versionInfo ( versionInfoObject )
version ( integer [unsigned 8-bit] )
licenseid ( uuid )
osinfo ( string )
cpuinfo ( string )
memoryinfo ( string )
serialno ( string )
assetbyassetgroup ( assetbyassetgroupObject  [Max: 512] )
relationshipId ( uuid )
assetId ( uuid )
assetGroupId ( uuid )
assetelementbyasset ( assetelementbyassetObject  [Max: 512] )
assetId ( uuid )
assetelementscollection ( assetelementscollectionObject  [Max: 512] )
id ( uuid )
element ( integer [unsigned 32-bit] )
flags ( flagsObject )
protected (true|false).
disabled (true|false).
autoupgrade (true|false).
delete (true|false).
namechanged (true|false).
name ( string  [Max length: 64] )
assetbyassetgroup ( assetbyassetgroupObject  [Max: 512] )
relationshipId ( uuid )
assetId ( uuid )
assetGroupId ( uuid )
etag ( etag )
etag ( etag )
POST /assets Create a new asset
Parameters Model
asset
probeid ( integer [unsigned 32-bit] )
id ( uuid )
parentid ( uuid )
element ( integer [unsigned 32-bit] )
type ( integer [unsigned 32-bit] )
flags ( flagsObject )
protected (true|false).
disabled (true|false).
autoupgrade (true|false).
delete (true|false).
namechanged (true|false).
name ( string  [Max length: 64] )
description ( string )
ipaddr ( string )
versionInfo ( versionInfoObject )
version ( integer [unsigned 8-bit] )
licenseid ( uuid )
osinfo ( string )
cpuinfo ( string )
memoryinfo ( string )
serialno ( string )
assetbyassetgroup ( assetbyassetgroupObject  [Max: 512] )
relationshipId ( uuid )
assetId ( uuid )
assetGroupId ( uuid )
assetelementbyasset ( assetelementbyassetObject  [Max: 512] )
assetId ( uuid )
assetelementscollection ( assetelementscollectionObject  [Max: 512] )
id ( uuid )
element ( integer [unsigned 32-bit] )
flags ( flagsObject )
protected (true|false).
disabled (true|false).
autoupgrade (true|false).
delete (true|false).
namechanged (true|false).
name ( string  [Max length: 64] )
assetbyassetgroup ( assetbyassetgroupObject  [Max: 512] )
relationshipId ( uuid )
assetId ( uuid )
assetGroupId ( uuid )
etag ( etag )
etag ( etag )
POST /assets/update Fetch the asset information from an asset
Parameters Model
asset
probeid ( integer [unsigned 32-bit] )
id ( uuid )
parentid ( uuid )
element ( integer [unsigned 32-bit] )
type ( integer [unsigned 32-bit] )
flags ( flagsObject )
protected (true|false).
disabled (true|false).
autoupgrade (true|false).
delete (true|false).
namechanged (true|false).
name ( string  [Max length: 64] )
description ( string )
ipaddr ( string )
versionInfo ( versionInfoObject )
version ( integer [unsigned 8-bit] )
licenseid ( uuid )
osinfo ( string )
cpuinfo ( string )
memoryinfo ( string )
serialno ( string )
assetbyassetgroup ( assetbyassetgroupObject  [Max: 512] )
relationshipId ( uuid )
assetId ( uuid )
assetGroupId ( uuid )
assetelementbyasset ( assetelementbyassetObject  [Max: 512] )
assetId ( uuid )
assetelementscollection ( assetelementscollectionObject  [Max: 512] )
id ( uuid )
element ( integer [unsigned 32-bit] )
flags ( flagsObject )
protected (true|false).
disabled (true|false).
autoupgrade (true|false).
delete (true|false).
namechanged (true|false).
name ( string  [Max length: 64] )
assetbyassetgroup ( assetbyassetgroupObject  [Max: 512] )
relationshipId ( uuid )
assetId ( uuid )
assetGroupId ( uuid )
etag ( etag )
etag ( etag )
Result Model
asset
probeid ( integer [unsigned 32-bit] )
id ( uuid )
parentid ( uuid )
element ( integer [unsigned 32-bit] )
type ( integer [unsigned 32-bit] )
flags ( flagsObject )
protected (true|false).
disabled (true|false).
autoupgrade (true|false).
delete (true|false).
namechanged (true|false).
name ( string  [Max length: 64] )
description ( string )
ipaddr ( string )
versionInfo ( versionInfoObject )
version ( integer [unsigned 8-bit] )
licenseid ( uuid )
osinfo ( string )
cpuinfo ( string )
memoryinfo ( string )
serialno ( string )
assetbyassetgroup ( assetbyassetgroupObject  [Max: 512] )
relationshipId ( uuid )
assetId ( uuid )
assetGroupId ( uuid )
assetelementbyasset ( assetelementbyassetObject  [Max: 512] )
assetId ( uuid )
assetelementscollection ( assetelementscollectionObject  [Max: 512] )
id ( uuid )
element ( integer [unsigned 32-bit] )
flags ( flagsObject )
protected (true|false).
disabled (true|false).
autoupgrade (true|false).
delete (true|false).
namechanged (true|false).
name ( string  [Max length: 64] )
assetbyassetgroup ( assetbyassetgroupObject  [Max: 512] )
relationshipId ( uuid )
assetId ( uuid )
assetGroupId ( uuid )
etag ( etag )
etag ( etag )
GET /assets/{assetID} Retrieve a specific asset by ID
Result Model
asset
probeid ( integer [unsigned 32-bit] )
id ( uuid )
parentid ( uuid )
element ( integer [unsigned 32-bit] )
type ( integer [unsigned 32-bit] )
flags ( flagsObject )
protected (true|false).
disabled (true|false).
autoupgrade (true|false).
delete (true|false).
namechanged (true|false).
name ( string  [Max length: 64] )
description ( string )
ipaddr ( string )
versionInfo ( versionInfoObject )
version ( integer [unsigned 8-bit] )
licenseid ( uuid )
osinfo ( string )
cpuinfo ( string )
memoryinfo ( string )
serialno ( string )
assetbyassetgroup ( assetbyassetgroupObject  [Max: 512] )
relationshipId ( uuid )
assetId ( uuid )
assetGroupId ( uuid )
assetelementbyasset ( assetelementbyassetObject  [Max: 512] )
assetId ( uuid )
assetelementscollection ( assetelementscollectionObject  [Max: 512] )
id ( uuid )
element ( integer [unsigned 32-bit] )
flags ( flagsObject )
protected (true|false).
disabled (true|false).
autoupgrade (true|false).
delete (true|false).
namechanged (true|false).
name ( string  [Max length: 64] )
assetbyassetgroup ( assetbyassetgroupObject  [Max: 512] )
relationshipId ( uuid )
assetId ( uuid )
assetGroupId ( uuid )
etag ( etag )
etag ( etag )
PUT /assets/{assetID} Update a specific asset by ID
Parameters Model
asset
probeid ( integer [unsigned 32-bit] )
id ( uuid )
parentid ( uuid )
element ( integer [unsigned 32-bit] )
type ( integer [unsigned 32-bit] )
flags ( flagsObject )
protected (true|false).
disabled (true|false).
autoupgrade (true|false).
delete (true|false).
namechanged (true|false).
name ( string  [Max length: 64] )
description ( string )
ipaddr ( string )
versionInfo ( versionInfoObject )
version ( integer [unsigned 8-bit] )
licenseid ( uuid )
osinfo ( string )
cpuinfo ( string )
memoryinfo ( string )
serialno ( string )
assetbyassetgroup ( assetbyassetgroupObject  [Max: 512] )
relationshipId ( uuid )
assetId ( uuid )
assetGroupId ( uuid )
assetelementbyasset ( assetelementbyassetObject  [Max: 512] )
assetId ( uuid )
assetelementscollection ( assetelementscollectionObject  [Max: 512] )
id ( uuid )
element ( integer [unsigned 32-bit] )
flags ( flagsObject )
protected (true|false).
disabled (true|false).
autoupgrade (true|false).
delete (true|false).
namechanged (true|false).
name ( string  [Max length: 64] )
assetbyassetgroup ( assetbyassetgroupObject  [Max: 512] )
relationshipId ( uuid )
assetId ( uuid )
assetGroupId ( uuid )
etag ( etag )
etag ( etag )
DELETE /assets/{assetID} Delete a specific asset by ID
 
/backupfiles
Created: 2016-03-24   Revised: 2018-03-27
 
GET /backupfiles Retrieve all backup files
Result Model
files
id ( uuid )
probeId ( integer [unsigned 32-bit] )
backupTime ( timestamp )
flags ( flagsObject )
backup_command (true|false).
restore_command (true|false).
system_files (true|false).
report_files (true|false).
log_files (true|false).
protocol_files (true|false).
etag ( etag )
POST /backupfiles Create a new backup file
Parameters Model
backup
id ( uuid )
probeId ( integer [unsigned 32-bit] )
backupTime ( timestamp )
flags ( flagsObject )
backup_command (true|false).
restore_command (true|false).
system_files (true|false).
report_files (true|false).
log_files (true|false).
protocol_files (true|false).
etag ( etag )
GET /backupfiles/{fileID} Retrieve a specific backup file by ID
Result Model
backup
id ( uuid )
probeId ( integer [unsigned 32-bit] )
backupTime ( timestamp )
flags ( flagsObject )
backup_command (true|false).
restore_command (true|false).
system_files (true|false).
report_files (true|false).
log_files (true|false).
protocol_files (true|false).
etag ( etag )
PUT /backupfiles/{fileID} Update a specific backup file by ID
Parameters Model
backup
id ( uuid )
probeId ( integer [unsigned 32-bit] )
backupTime ( timestamp )
flags ( flagsObject )
backup_command (true|false).
restore_command (true|false).
system_files (true|false).
report_files (true|false).
log_files (true|false).
protocol_files (true|false).
etag ( etag )
DELETE /backupfiles/{fileID} Delete a specific backup file by ID
 
/bayeux
Created: 2016-03-24   Revised: 2018-03-27
 
POST /bayeux Implements the Bayeux Protocol
Parameters Model
messages
 
/certificates
Created: 2016-03-24   Revised: 2018-03-27
 
GET /certificates Retrieve all certificates in the Observer Platform certificate store
Result Model
certificates
id ( uuid )
assetType ( string  [Max length: 32] )
assetId ( string  [Max length: 16] )
state ( string  [Max length: 32] )
version ( integer [signed 32-bit] )
serialNumber ( integer [signed 32-bit] )
issuer ( string  [Max length: 64] )
subject ( string  [Max length: 64] )
issuingTime ( string  [Max length: 32] )
expirationTime ( string  [Max length: 32] )
signatureAlgorithm ( string  [Max length: 64] )
sha1Fingerprint ( string  [Max length: 64] )
md5Fingerprint ( string  [Max length: 64] )
assetName ( string  [Max length: 64] )
lastSeenIP ( ip address )
lastSeenTime ( string  [Max length: 32] )
GET /certificates/local Retrieve the local certificate used by current Observer Platform application
Result Model
certificate
id ( uuid )
assetType ( string  [Max length: 32] )
assetId ( string  [Max length: 16] )
state ( string  [Max length: 32] )
version ( integer [signed 32-bit] )
serialNumber ( integer [signed 32-bit] )
issuer ( string  [Max length: 64] )
subject ( string  [Max length: 64] )
issuingTime ( string  [Max length: 32] )
expirationTime ( string  [Max length: 32] )
signatureAlgorithm ( string  [Max length: 64] )
sha1Fingerprint ( string  [Max length: 64] )
md5Fingerprint ( string  [Max length: 64] )
assetName ( string  [Max length: 64] )
lastSeenIP ( ip address )
lastSeenTime ( string  [Max length: 32] )
GET /certificates/{certificateID} Retrieve a specific certificate from the Observer Platform certificate store by ID
Result Model
certificate
id ( uuid )
assetType ( string  [Max length: 32] )
assetId ( string  [Max length: 16] )
state ( string  [Max length: 32] )
version ( integer [signed 32-bit] )
serialNumber ( integer [signed 32-bit] )
issuer ( string  [Max length: 64] )
subject ( string  [Max length: 64] )
issuingTime ( string  [Max length: 32] )
expirationTime ( string  [Max length: 32] )
signatureAlgorithm ( string  [Max length: 64] )
sha1Fingerprint ( string  [Max length: 64] )
md5Fingerprint ( string  [Max length: 64] )
assetName ( string  [Max length: 64] )
lastSeenIP ( ip address )
lastSeenTime ( string  [Max length: 32] )
PUT /certificates/{certificateID} Update a specific certificate in the Observer Platform certificate store by ID
Parameters Model
certificate
id ( uuid )
assetType ( string  [Max length: 32] )
assetId ( string  [Max length: 16] )
state ( string  [Max length: 32] )
version ( integer [signed 32-bit] )
serialNumber ( integer [signed 32-bit] )
issuer ( string  [Max length: 64] )
subject ( string  [Max length: 64] )
issuingTime ( string  [Max length: 32] )
expirationTime ( string  [Max length: 32] )
signatureAlgorithm ( string  [Max length: 64] )
sha1Fingerprint ( string  [Max length: 64] )
md5Fingerprint ( string  [Max length: 64] )
assetName ( string  [Max length: 64] )
lastSeenIP ( ip address )
lastSeenTime ( string  [Max length: 32] )
DELETE /certificates/{certificateID} Delete a specific certificate by ID
 
/failover
Created: 2016-03-24   Revised: 2018-03-27
 
GET /failover/status Get the failover status information from a server (OMS/Apex)
Result Model
failover
ip ( string )
isPrimary ( boolean [true|false] )
available ( boolean [true|false] )
lastError ( integer [unsigned 32-bit] )
maxDaysToReplicate ( integer [unsigned 32-bit] )
enabled ( boolean [true|false] )
suspended ( boolean [true|false] )
etag ( etag )
GET /failover/testCertificates Run the failover certificate store synchronization tests and return the result (OMS/Apex)
Result Model
testResult
result ( string )
Success : The test completed successfully.
Failure : The test failed.
message ( string  [Max length: 512] )
GET /failover/testConfiguration Run the failover configuration synchronization tests and return the result (OMS/Apex)
Result Model
testResult
result ( string )
Success : The test completed successfully.
Failure : The test failed.
message ( string  [Max length: 512] )
 
/hsm
Created: 2016-03-24   Revised: 2018-03-27
 
DELETE /hsm/configuration Removes all configured tokens and keys.
GET /hsm/token Get collection of tokens
Result Model
tokens
number ( integer [signed 32-bit] )
label ( string )
description ( string )
POST /hsm/token Configure a token with given label and PIN
Parameters Model
tokenOperation
label ( string )
pin ( string )
GET /hsm/token/{tokenLabel} Read details for a specific token
Result Model
token
number ( integer [signed 32-bit] )
label ( string )
description ( string )
PUT /hsm/token/{tokenLabel} Update PIN for a specific token
Parameters Model
tokenOperation
label ( string )
pin ( string )
DELETE /hsm/token/{tokenLabel} Deletes a specific token by given label
GET /hsm/key Get collection of configured keys
Result Model
keys
name ( string )
token ( string )
privatekey ( string )
POST /hsm/key Add a new key to the configuration
Parameters Model
key
name ( string )
token ( string )
privatekey ( string )
allowedgroups ( allowedgroupsObject )
userGroupId ( uuid )
GET /hsm/key/{keyName} Read details for a specific key
Result Model
key
name ( string )
token ( string )
privatekey ( string )
allowedgroups ( allowedgroupsObject )
userGroupId ( uuid )
PUT /hsm/key/{keyName} Update details for a specific key
Parameters Model
key
name ( string )
token ( string )
privatekey ( string )
allowedgroups ( allowedgroupsObject )
userGroupId ( uuid )
DELETE /hsm/key/{keyName} Deletes a specific key by given name
GET /hsm/privatekey Get collection of private key names
Result Model
privatekeys
privatekey ( string )
 
/licenses
Created: 2016-03-24   Revised: 2018-03-27
 
GET /licenses Retrieve all licenses
Result Model
licenses
id ( uuid )
type ( integer [signed 32-bit] )
version ( integer [signed 32-bit] )
license ( string  [Max length: 64] )
flags ( flagsObject )
protected (true|false).
disabled (true|false).
identification ( integer [signed 32-bit] )
name ( string )
company ( string )
etag ( etag )
POST /licenses Create a new license
Parameters Model
license
id ( uuid )
type ( integer [signed 32-bit] )
version ( integer [signed 32-bit] )
license ( string  [Max length: 64] )
flags ( flagsObject )
protected (true|false).
disabled (true|false).
identification ( integer [signed 32-bit] )
name ( string )
company ( string )
etag ( etag )
GET /licenses/{licenseID} Retrieve a specific license by ID
Result Model
license
id ( uuid )
type ( integer [signed 32-bit] )
version ( integer [signed 32-bit] )
license ( string  [Max length: 64] )
flags ( flagsObject )
protected (true|false).
disabled (true|false).
identification ( integer [signed 32-bit] )
name ( string )
company ( string )
etag ( etag )
PUT /licenses/{licenseID} Update a specific license by ID
Parameters Model
license
id ( uuid )
type ( integer [signed 32-bit] )
version ( integer [signed 32-bit] )
license ( string  [Max length: 64] )
flags ( flagsObject )
protected (true|false).
disabled (true|false).
identification ( integer [signed 32-bit] )
name ( string )
company ( string )
etag ( etag )
DELETE /licenses/{licenseID} Delete a specific license by ID
 
/logs
Created: 2016-03-24   Revised: 2018-03-27
 
GET /logs Query for log entries
Result Model
logResults
truncated ( boolean [true|false] )
returnedEntryCount ( integer [signed 32-bit] )
totalEntryCount ( integer [signed 32-bit] )
entries ( entriesObject  [Max: 30000] )
time ( timestamp (ms) )
version ( integer [unsigned 32-bit] )
user ( string  [Max length: 64] )
eventType ( string )
DEBUG : Used only in Debug mode to provide programmer specified feedback.
DIAGNOSTIC : When enabled, used to provide diagnostic type information for high level troubleshooting.
System (Default) : Used for log messages generated because of internal system calls.
Authorization : Used for log messages related to Authorization.
Protocol Synchronization : Used for log messages related to OMS protocol synchronization.
Filter Synchronization : Used for log messages related to OMS filter synchronization.
License Synchronization : Used for log messages related to OMS license synchronization.
Observer Log : Used for log messages related to OMS Observer log synchronization.
HSM : Used for log messages related to OMS HSM functionality.
Observer Infrastructure Log : Used for log messages related to OMS OI log synchronization.
Asset : Used for log messages related to OMS Asset management.
Asset Group : Used for log messages related to OMS Asset Group management.
Asset Policy : Used for log messages related to OMS Asset Policy management.
User : Used for log messages related to OMS User management.
User Group : Used for log messages related to OMS User Group management.
License : Used for log messages related to OMS License management.
Upgrade Policy : Used for log messages related to OMS Upgrade Policy management.
Auto-upgrade : Used for log messages related to Auto-Upgrade.
Authentication Modes : Used for log messages related to OMS Authentication Mode settings.
Dashboard Execution : Used for log messages related to running an Apex Dashboard.
Shared Filter Settings : Used for log messages related to Shared Filter settings.
OMS License Settings : Used for log messages related to OMS License settings.
User Login : Used for log messages related to user login.
User Logout : Used for log messages related to user logout.
Data Source : Used for log messages realted to Apex Data Sources.
Business Group : Used for log messages realted to Business Groups.
Threshold : Used for log messages realted to Apex Thresholds.
Failover : Used for log messages related to failover functions.
Baseline Schedule : Used for log messages related to baseline schedule settings.
Apex Settings : Used for log messages related to Apex settings.
GigaStor Configuration : Used for log messages related to GigaStor Configuration.
Asset Upgrade : Used for log messages related to asset software upgrades.
Primary Failover Server : Used for log messages related to primary failover server events.
Secondary Failover Server : Used for log messages related to secondary failover server events.
Email Log : Used for log messages events raised during sending emails.
Widget : Used for log messages related to Apex Widget modification.
Dashboard : Used for log messages related to Apex Dashboard modification.
ADM : Used for log messages related to Apex ADM modification.
Alarm : Used for log messaged related to Alarms.
Scheduled Report : Used for log messages related to Scheduled Reports.
Session : Used for log messages related to the user session.
Sites/Subnets : Used for log messages related to the site/subnet configurations.
severity ( string )
Informational (Default) : Used to indicate normal operation.
Warning : Used to indicate a more severe event may be pending if action is not taken.
Critical : Used to indicate a condition that should be corrected immediately.
sourceName ( string  [Max length: 128] )
sourceIP ( ip address )
destinationName ( string  [Max length: 128] )
port ( integer [unsigned 16-bit] )
description ( string  [Max length: 256] )
POST /logs Create a new log entry
Parameters Model
log
time ( timestamp (ms) )
version ( integer [unsigned 32-bit] )
user ( string  [Max length: 64] )
eventType ( string )
DEBUG : Used only in Debug mode to provide programmer specified feedback.
DIAGNOSTIC : When enabled, used to provide diagnostic type information for high level troubleshooting.
System (Default) : Used for log messages generated because of internal system calls.
Authorization : Used for log messages related to Authorization.
Protocol Synchronization : Used for log messages related to OMS protocol synchronization.
Filter Synchronization : Used for log messages related to OMS filter synchronization.
License Synchronization : Used for log messages related to OMS license synchronization.
Observer Log : Used for log messages related to OMS Observer log synchronization.
HSM : Used for log messages related to OMS HSM functionality.
Observer Infrastructure Log : Used for log messages related to OMS OI log synchronization.
Asset : Used for log messages related to OMS Asset management.
Asset Group : Used for log messages related to OMS Asset Group management.
Asset Policy : Used for log messages related to OMS Asset Policy management.
User : Used for log messages related to OMS User management.
User Group : Used for log messages related to OMS User Group management.
License : Used for log messages related to OMS License management.
Upgrade Policy : Used for log messages related to OMS Upgrade Policy management.
Auto-upgrade : Used for log messages related to Auto-Upgrade.
Authentication Modes : Used for log messages related to OMS Authentication Mode settings.
Dashboard Execution : Used for log messages related to running an Apex Dashboard.
Shared Filter Settings : Used for log messages related to Shared Filter settings.
OMS License Settings : Used for log messages related to OMS License settings.
User Login : Used for log messages related to user login.
User Logout : Used for log messages related to user logout.
Data Source : Used for log messages realted to Apex Data Sources.
Business Group : Used for log messages realted to Business Groups.
Threshold : Used for log messages realted to Apex Thresholds.
Failover : Used for log messages related to failover functions.
Baseline Schedule : Used for log messages related to baseline schedule settings.
Apex Settings : Used for log messages related to Apex settings.
GigaStor Configuration : Used for log messages related to GigaStor Configuration.
Asset Upgrade : Used for log messages related to asset software upgrades.
Primary Failover Server : Used for log messages related to primary failover server events.
Secondary Failover Server : Used for log messages related to secondary failover server events.
Email Log : Used for log messages events raised during sending emails.
Widget : Used for log messages related to Apex Widget modification.
Dashboard : Used for log messages related to Apex Dashboard modification.
ADM : Used for log messages related to Apex ADM modification.
Alarm : Used for log messaged related to Alarms.
Scheduled Report : Used for log messages related to Scheduled Reports.
Session : Used for log messages related to the user session.
Sites/Subnets : Used for log messages related to the site/subnet configurations.
severity ( string )
Informational (Default) : Used to indicate normal operation.
Warning : Used to indicate a more severe event may be pending if action is not taken.
Critical : Used to indicate a condition that should be corrected immediately.
sourceName ( string  [Max length: 128] )
sourceIP ( ip address )
destinationName ( string  [Max length: 128] )
port ( integer [unsigned 16-bit] )
description ( string  [Max length: 256] )
 
/permissions
Created: 2016-03-24   Revised: 2018-03-27
 
GET /permissions Retrieve all permission policies
Result Model
permissions
id ( uuid )
flags ( flagsObject )
protected (true|false).
disabled (true|false).
default (true|false).
name ( string )
description ( string )
permissionrightscollection ( permissionrightscollectionObject  [Max: 512] )
permissions ( integer [unsigned 32-bit] )
permissionid ( integer [unsigned 16-bit] )
flags ( flagsObject )
collapse (true|false).
folder (true|false).
definition (true|false).
assettype ( integer [unsigned 8-bit] )
etag ( etag )
POST /permissions Create a new permission policy
Parameters Model
permissionpolicy
id ( uuid )
flags ( flagsObject )
protected (true|false).
disabled (true|false).
default (true|false).
name ( string )
description ( string )
permissionrightscollection ( permissionrightscollectionObject  [Max: 512] )
permissions ( integer [unsigned 32-bit] )
permissionid ( integer [unsigned 16-bit] )
flags ( flagsObject )
collapse (true|false).
folder (true|false).
definition (true|false).
assettype ( integer [unsigned 8-bit] )
etag ( etag )
GET /permissions/display Retrieve the display data by ID
Result Model
permissiondisplay
permissionelementscollection ( permissionelementscollectionObject  [Max: 1000] )
name ( string )
permissions ( integer [unsigned 32-bit] )
controlFlags ( controlFlagsObject )
enableNoAccess (true|false).
enableUser (true|false).
enableSystem (true|false).
enableAdmin (true|false).
flags ( flagsObject )
collapse (true|false).
folder (true|false).
definition (true|false).
level ( integer [unsigned 8-bit] )
assettype ( integer [unsigned 8-bit] )
permissionid ( integer [unsigned 16-bit] )
GET /permissions/{permissionID} Retrieve a specific permission policy by ID
Result Model
permissionpolicy
id ( uuid )
flags ( flagsObject )
protected (true|false).
disabled (true|false).
default (true|false).
name ( string )
description ( string )
permissionrightscollection ( permissionrightscollectionObject  [Max: 512] )
permissions ( integer [unsigned 32-bit] )
permissionid ( integer [unsigned 16-bit] )
flags ( flagsObject )
collapse (true|false).
folder (true|false).
definition (true|false).
assettype ( integer [unsigned 8-bit] )
etag ( etag )
PUT /permissions/{permissionID} Update a specific permission policy by ID
Parameters Model
permissionpolicy
id ( uuid )
flags ( flagsObject )
protected (true|false).
disabled (true|false).
default (true|false).
name ( string )
description ( string )
permissionrightscollection ( permissionrightscollectionObject  [Max: 512] )
permissions ( integer [unsigned 32-bit] )
permissionid ( integer [unsigned 16-bit] )
flags ( flagsObject )
collapse (true|false).
folder (true|false).
definition (true|false).
assettype ( integer [unsigned 8-bit] )
etag ( etag )
DELETE /permissions/{permissionID} Delete a specific permission policy by ID
 
/protocols
Created: 2016-03-24   Revised: 2018-03-27
 
GET /protocols/tcp Retrieve all tcp protocols
Result Model
protocols
id ( uuid )
name ( string )
ports ( string  [Max length: 256] )
derived ( string )
flags ( flagsObject )
tcp (true|false).
udp (true|false).
sctp (true|false).
derived (true|false).
custom (true|false).
dynamic (true|false).
POST /protocols/tcp Create a new tcp protocol
Parameters Model
protocol
id ( uuid )
name ( string )
ports ( string  [Max length: 256] )
derived ( string )
flags ( flagsObject )
tcp (true|false).
udp (true|false).
sctp (true|false).
derived (true|false).
custom (true|false).
dynamic (true|false).
GET /protocols/tcp/{protocolID} Retrieve a specific tcp protocol by ID
Result Model
protocol
id ( uuid )
name ( string )
ports ( string  [Max length: 256] )
derived ( string )
flags ( flagsObject )
tcp (true|false).
udp (true|false).
sctp (true|false).
derived (true|false).
custom (true|false).
dynamic (true|false).
PUT /protocols/tcp/{protocolID} Update a specific protocol by ID
Parameters Model
protocol
id ( uuid )
name ( string )
ports ( string  [Max length: 256] )
derived ( string )
flags ( flagsObject )
tcp (true|false).
udp (true|false).
sctp (true|false).
derived (true|false).
custom (true|false).
dynamic (true|false).
DELETE /protocols/tcp/{protocolID} Delete a specific protocol by ID
GET /protocols/udp Retrieve all udp protocols
Result Model
protocols
id ( uuid )
name ( string )
ports ( string  [Max length: 256] )
derived ( string )
flags ( flagsObject )
tcp (true|false).
udp (true|false).
sctp (true|false).
derived (true|false).
custom (true|false).
dynamic (true|false).
POST /protocols/udp Create a new udp protocol
Parameters Model
protocol
id ( uuid )
name ( string )
ports ( string  [Max length: 256] )
derived ( string )
flags ( flagsObject )
tcp (true|false).
udp (true|false).
sctp (true|false).
derived (true|false).
custom (true|false).
dynamic (true|false).
GET /protocols/udp/{protocolID} Retrieve a specific udp protocol by ID
Result Model
protocol
id ( uuid )
name ( string )
ports ( string  [Max length: 256] )
derived ( string )
flags ( flagsObject )
tcp (true|false).
udp (true|false).
sctp (true|false).
derived (true|false).
custom (true|false).
dynamic (true|false).
PUT /protocols/udp/{protocolID} Update a specific udp protocol by ID
Parameters Model
protocol
id ( uuid )
name ( string )
ports ( string  [Max length: 256] )
derived ( string )
flags ( flagsObject )
tcp (true|false).
udp (true|false).
sctp (true|false).
derived (true|false).
custom (true|false).
dynamic (true|false).
DELETE /protocols/udp/{protocolID} Delete a specific protocol by ID
GET /protocols/sctp Retrieve all sctp protocols
Result Model
protocols
id ( uuid )
name ( string )
ports ( string  [Max length: 256] )
derived ( string )
flags ( flagsObject )
tcp (true|false).
udp (true|false).
sctp (true|false).
derived (true|false).
custom (true|false).
dynamic (true|false).
POST /protocols/sctp Create a new sctp protocol
Parameters Model
protocol
id ( uuid )
name ( string )
ports ( string  [Max length: 256] )
derived ( string )
flags ( flagsObject )
tcp (true|false).
udp (true|false).
sctp (true|false).
derived (true|false).
custom (true|false).
dynamic (true|false).
GET /protocols/sctp/{protocolID} Retrieve a specific sctp protocol by ID
Result Model
protocol
id ( uuid )
name ( string )
ports ( string  [Max length: 256] )
derived ( string )
flags ( flagsObject )
tcp (true|false).
udp (true|false).
sctp (true|false).
derived (true|false).
custom (true|false).
dynamic (true|false).
PUT /protocols/sctp/{protocolID} Update a specific sctp protocol by ID
Parameters Model
protocol
id ( uuid )
name ( string )
ports ( string  [Max length: 256] )
derived ( string )
flags ( flagsObject )
tcp (true|false).
udp (true|false).
sctp (true|false).
derived (true|false).
custom (true|false).
dynamic (true|false).
DELETE /protocols/sctp/{protocolID} Delete a specific protocol by ID
 
/relationships
Created: 2016-03-24   Revised: 2018-03-27
 
GET /relationships Retrieve all relationships. Optional query parameter specifies an object to center the query around.
Result Model
relationships
usersToUserGroups ( usersToUserGroupsObject  [Max: 512] )
relationshipId ( uuid )
userId ( uuid )
userGroupId ( uuid )
assetGroupsToUserGroups ( assetGroupsToUserGroupsObject  [Max: 512] )
relationshipId ( uuid )
assetGroupId ( uuid )
userGroupId ( uuid )
assetsToUserGroups ( assetsToUserGroupsObject  [Max: 512] )
relationshipId ( uuid )
assetId ( uuid )
userGroupId ( uuid )
assetsToAssetGroups ( assetsToAssetGroupsObject  [Max: 512] )
relationshipId ( uuid )
assetId ( uuid )
assetGroupId ( uuid )
upgradePoliciesToAssets ( upgradePoliciesToAssetsObject  [Max: 512] )
relationshipId ( uuid )
upgradePolicyId ( uuid )
assetId ( uuid )
upgradePoliciesToAssetGroups ( upgradePoliciesToAssetGroupsObject  [Max: 512] )
relationshipId ( uuid )
upgradePolicyId ( uuid )
assetGroupId ( uuid )
permissionPoliciesToUserGroups ( permissionPoliciesToUserGroupsObject  [Max: 512] )
relationshipId ( uuid )
permissionPolicyId ( uuid )
userGroupId ( uuid )
POST /relationships/batch Perform a batch creation of multiple relationships
Parameters Model
relationships
usersToUserGroups ( usersToUserGroupsObject  [Max: 512] )
relationshipId ( uuid )
userId ( uuid )
userGroupId ( uuid )
assetGroupsToUserGroups ( assetGroupsToUserGroupsObject  [Max: 512] )
relationshipId ( uuid )
assetGroupId ( uuid )
userGroupId ( uuid )
assetsToUserGroups ( assetsToUserGroupsObject  [Max: 512] )
relationshipId ( uuid )
assetId ( uuid )
userGroupId ( uuid )
assetsToAssetGroups ( assetsToAssetGroupsObject  [Max: 512] )
relationshipId ( uuid )
assetId ( uuid )
assetGroupId ( uuid )
upgradePoliciesToAssets ( upgradePoliciesToAssetsObject  [Max: 512] )
relationshipId ( uuid )
upgradePolicyId ( uuid )
assetId ( uuid )
upgradePoliciesToAssetGroups ( upgradePoliciesToAssetGroupsObject  [Max: 512] )
relationshipId ( uuid )
upgradePolicyId ( uuid )
assetGroupId ( uuid )
permissionPoliciesToUserGroups ( permissionPoliciesToUserGroupsObject  [Max: 512] )
relationshipId ( uuid )
permissionPolicyId ( uuid )
userGroupId ( uuid )
DELETE /relationships/batch Perform a batch delete of multiple relationships
POST /relationships/userstousergroups Create a new User to User Group relationship
Parameters Model
userToUserGroup
relationshipId ( uuid )
userId ( uuid )
userGroupId ( uuid )
DELETE /relationships/userstousergroups/{relationshipId} Delete the specific User to User Group relationship by ID
POST /relationships/assetstousergroups Create a new Asset to User Group relationship
Parameters Model
assetToUserGroup
relationshipId ( uuid )
assetId ( uuid )
userGroupId ( uuid )
DELETE /relationships/assetstousergroups/{relationshipId} Delete the specific Asset to User Group relationship by ID
POST /relationships/assetgroupstousergroups Create a new Asset Group to User Group relationship
Parameters Model
assetGroupToUserGroup
relationshipId ( uuid )
assetGroupId ( uuid )
userGroupId ( uuid )
DELETE /relationships/assetgroupstousergroups/{relationshipId} Delete the specific Asset Group to User Group relationship by ID
POST /relationships/assetstoassetgroups Create a new Asset to Asset Group relationship
Parameters Model
assetToAssetGroup
relationshipId ( uuid )
assetId ( uuid )
assetGroupId ( uuid )
DELETE /relationships/assetstoassetgroups/{relationshipId} Delete the specific Asset to Asset Group relationship by ID
POST /relationships/upgradepoliciestoassets Create a new UpgradePolicy to Asset relationship
Parameters Model
upgradePolicyToAsset
relationshipId ( uuid )
upgradePolicyId ( uuid )
assetId ( uuid )
DELETE /relationships/upgradepoliciestoassets/{relationshipId} Delete the specific UpgradePolicy to Asset relationship by ID
POST /relationships/upgradepoliciestoassetgroups Create a new UpgradePolicy to AssetGroup relationship
Parameters Model
upgradePolicyToAssetGroup
relationshipId ( uuid )
upgradePolicyId ( uuid )
assetGroupId ( uuid )
DELETE /relationships/upgradepoliciestoassetgroups/{relationshipId} Delete the specific UpgradePolicy to AssetGroup relationship by ID
POST /relationships/permissionpoliciestousergroups Create a new PermissionPolicy to UserGroup relationship
Parameters Model
permissionPolicyToUserGroup
relationshipId ( uuid )
permissionPolicyId ( uuid )
userGroupId ( uuid )
DELETE /relationships/permissionpoliciestousergroups/{relationshipId} Delete the specific PermissionPolicy to UserGroup relationship by ID
 
/session
Created: 2016-03-24   Revised: 2018-03-27
 
GET /session Retrieve the current session
Result Model
LoginSession
session ( boolean [true|false] )
user ( SessionApiObject )
username ( string  [Max length: 64] )
id ( uuid )
permissionrights ( permissionrightsObject  [Max: 32] )
permissions ( permissionsObject )
allowCreate (true|false).
allowDelete (true|false).
allowUpdate (true|false).
allowRead (true|false).
allowQuery (true|false).
grouppermissionrights ( grouppermissionrightsObject  [Max: 128] )
id ( uuid )
permissions ( permissionsObject )
allowCreate (true|false).
allowDelete (true|false).
allowUpdate (true|false).
allowRead (true|false).
allowQuery (true|false).
POST /session Create a new session (login)
Parameters Model
session
username ( string  [Max length: 72] )
password ( string  [Max length: 72] )
DELETE /session Delete the current session (logout)
PUT /session/settings Update the session settings
Parameters Model
sessionSettings
autoRefresh ( boolean [true|false] )
 
/settings/autoUpgrade
Created: 2016-03-24   Revised: 2018-03-27
 
GET /settings/autoUpgrade Retrieve the auto-upgrade settings
Result Model
autoupgradesetting
flags ( flagsObject )
protected (true|false).
concurrUpgrades ( integer [unsigned 32-bit] )
upgradePolicyId ( uuid )
etag ( etag )
PUT /settings/autoUpgrade Update the AutoUpgradeSettings
Parameters Model
autoupgradesetting
flags ( flagsObject )
protected (true|false).
concurrUpgrades ( integer [unsigned 32-bit] )
upgradePolicyId ( uuid )
etag ( etag )
 
/settings/authentication
Created: 2016-03-24   Revised: 2018-03-27
 
GET /settings/authentication Returns the auth settings.
Result Model
authentication
defaultUserGroup ( uuid )
flags ( flagsObject )
enableSessionTimeout (true|false).
authSchemeLocal (true|false).
authSchemeLDAP (true|false).
authSchemeActiveDir (true|false).
authSchemeRadius (true|false).
authSchemeTacacs (true|false).
enableGroupSync (true|false).
enableManualSync (true|false).
sessionTimeoutMinutes ( integer [unsigned 32-bit] )
authTimeoutMinutes ( integer [unsigned 32-bit] )
tacacs.sharedSecret ( string )
tacacs.authType ( string )
tacacs.host1 ( string )
tacacs.host2 ( string )
tacacs.port1 ( integer [unsigned 16-bit] )
tacacs.port2 ( integer [unsigned 16-bit] )
tacacs.timeout ( integer [unsigned 32-bit] )
radius.sharedSecret ( string )
radius.authType ( string )
radius.host1 ( string )
radius.host2 ( string )
radius.port1 ( integer [unsigned 16-bit] )
radius.port2 ( integer [unsigned 16-bit] )
radius.timeout ( integer [unsigned 32-bit] )
radius.retryCount ( integer [unsigned 32-bit] )
ldapAD.host ( string )
ldapAD.domain ( string )
ldapAD.baseDn ( string )
ldapAD.port ( integer [unsigned 16-bit] )
ldapAD.flags ( ldapAD.flagsObject )
useTLS (true|false).
useSSL (true|false).
referrals (true|false).
ldapAD.timeout ( integer [unsigned 32-bit] )
ldapAD.version ( integer [unsigned 32-bit] )
ldapAD.bindDn ( string )
ldapAD.bindPwd ( string )
ldap.host ( string )
ldap.port ( integer [unsigned 16-bit] )
ldap.version ( integer [unsigned 32-bit] )
ldap.timeout ( integer [unsigned 32-bit] )
ldap.flags ( ldap.flagsObject )
useTLS (true|false).
useSSL (true|false).
referrals (true|false).
ldap.baseDn ( string )
ldap.userDn ( string )
ldap.bindDn ( string )
ldap.bindPwd ( string )
ldap.userFilter ( string )
ldap.userNameAttribute ( string )
ldap.userIdAttribute ( string )
ldap.userDescAttribute ( string )
ldap.groupNameAttribute ( string )
ldap.groupIdAttribute ( string )
ldap.groupDescAttribute ( string )
ldap.groupFilter ( string )
ldap.groupDn ( string )
ldap.groupSyncRate ( integer [unsigned 16-bit] )
etag ( etag )
PUT /settings/authentication Update the auth settings
Parameters Model
authentication
defaultUserGroup ( uuid )
flags ( flagsObject )
enableSessionTimeout (true|false).
authSchemeLocal (true|false).
authSchemeLDAP (true|false).
authSchemeActiveDir (true|false).
authSchemeRadius (true|false).
authSchemeTacacs (true|false).
enableGroupSync (true|false).
enableManualSync (true|false).
sessionTimeoutMinutes ( integer [unsigned 32-bit] )
authTimeoutMinutes ( integer [unsigned 32-bit] )
tacacs.sharedSecret ( string )
tacacs.authType ( string )
tacacs.host1 ( string )
tacacs.host2 ( string )
tacacs.port1 ( integer [unsigned 16-bit] )
tacacs.port2 ( integer [unsigned 16-bit] )
tacacs.timeout ( integer [unsigned 32-bit] )
radius.sharedSecret ( string )
radius.authType ( string )
radius.host1 ( string )
radius.host2 ( string )
radius.port1 ( integer [unsigned 16-bit] )
radius.port2 ( integer [unsigned 16-bit] )
radius.timeout ( integer [unsigned 32-bit] )
radius.retryCount ( integer [unsigned 32-bit] )
ldapAD.host ( string )
ldapAD.domain ( string )
ldapAD.baseDn ( string )
ldapAD.port ( integer [unsigned 16-bit] )
ldapAD.flags ( ldapAD.flagsObject )
useTLS (true|false).
useSSL (true|false).
referrals (true|false).
ldapAD.timeout ( integer [unsigned 32-bit] )
ldapAD.version ( integer [unsigned 32-bit] )
ldapAD.bindDn ( string )
ldapAD.bindPwd ( string )
ldap.host ( string )
ldap.port ( integer [unsigned 16-bit] )
ldap.version ( integer [unsigned 32-bit] )
ldap.timeout ( integer [unsigned 32-bit] )
ldap.flags ( ldap.flagsObject )
useTLS (true|false).
useSSL (true|false).
referrals (true|false).
ldap.baseDn ( string )
ldap.userDn ( string )
ldap.bindDn ( string )
ldap.bindPwd ( string )
ldap.userFilter ( string )
ldap.userNameAttribute ( string )
ldap.userIdAttribute ( string )
ldap.userDescAttribute ( string )
ldap.groupNameAttribute ( string )
ldap.groupIdAttribute ( string )
ldap.groupDescAttribute ( string )
ldap.groupFilter ( string )
ldap.groupDn ( string )
ldap.groupSyncRate ( integer [unsigned 16-bit] )
etag ( etag )
PUT /settings/authentication/syncNow Contact LDAP server to start LDAP sync process
Parameters Model
authentication
defaultUserGroup ( uuid )
flags ( flagsObject )
enableSessionTimeout (true|false).
authSchemeLocal (true|false).
authSchemeLDAP (true|false).
authSchemeActiveDir (true|false).
authSchemeRadius (true|false).
authSchemeTacacs (true|false).
enableGroupSync (true|false).
enableManualSync (true|false).
sessionTimeoutMinutes ( integer [unsigned 32-bit] )
authTimeoutMinutes ( integer [unsigned 32-bit] )
tacacs.sharedSecret ( string )
tacacs.authType ( string )
tacacs.host1 ( string )
tacacs.host2 ( string )
tacacs.port1 ( integer [unsigned 16-bit] )
tacacs.port2 ( integer [unsigned 16-bit] )
tacacs.timeout ( integer [unsigned 32-bit] )
radius.sharedSecret ( string )
radius.authType ( string )
radius.host1 ( string )
radius.host2 ( string )
radius.port1 ( integer [unsigned 16-bit] )
radius.port2 ( integer [unsigned 16-bit] )
radius.timeout ( integer [unsigned 32-bit] )
radius.retryCount ( integer [unsigned 32-bit] )
ldapAD.host ( string )
ldapAD.domain ( string )
ldapAD.baseDn ( string )
ldapAD.port ( integer [unsigned 16-bit] )
ldapAD.flags ( ldapAD.flagsObject )
useTLS (true|false).
useSSL (true|false).
referrals (true|false).
ldapAD.timeout ( integer [unsigned 32-bit] )
ldapAD.version ( integer [unsigned 32-bit] )
ldapAD.bindDn ( string )
ldapAD.bindPwd ( string )
ldap.host ( string )
ldap.port ( integer [unsigned 16-bit] )
ldap.version ( integer [unsigned 32-bit] )
ldap.timeout ( integer [unsigned 32-bit] )
ldap.flags ( ldap.flagsObject )
useTLS (true|false).
useSSL (true|false).
referrals (true|false).
ldap.baseDn ( string )
ldap.userDn ( string )
ldap.bindDn ( string )
ldap.bindPwd ( string )
ldap.userFilter ( string )
ldap.userNameAttribute ( string )
ldap.userIdAttribute ( string )
ldap.userDescAttribute ( string )
ldap.groupNameAttribute ( string )
ldap.groupIdAttribute ( string )
ldap.groupDescAttribute ( string )
ldap.groupFilter ( string )
ldap.groupDn ( string )
ldap.groupSyncRate ( integer [unsigned 16-bit] )
etag ( etag )
 
/settings/backuprestore
Created: 2016-03-24   Revised: 2018-03-27
 
GET /settings/backuprestore Load the main settings (from the settings file)
Result Model
settings
id ( uuid )
path ( string ) : The path for backups
maxItemsToBackup ( integer [unsigned 32-bit] ) : Number of backups to keep
backupSchedule ( ScheduleBackupStructObject )
mode ( integer [unsigned 16-bit] )
weekdays ( integer [unsigned 16-bit] )
day ( dayObject )
intervals ( intervalsObject )
timebegin ( integer [unsigned 16-bit] )
timeend ( integer [unsigned 16-bit] )
flags ( flagsObject )
interval_valid (true|false).
flags ( flagsObject )
backup_command (true|false).
restore_command (true|false).
system_files (true|false).
report_files (true|false).
log_files (true|false).
protocol_files (true|false).
etag ( etag )
PUT /settings/backuprestore Update the main settings (to the settings file)
Parameters Model
settings
id ( uuid )
path ( string ) : The path for backups
maxItemsToBackup ( integer [unsigned 32-bit] ) : Number of backups to keep
backupSchedule ( ScheduleBackupStructObject )
mode ( integer [unsigned 16-bit] )
weekdays ( integer [unsigned 16-bit] )
day ( dayObject )
intervals ( intervalsObject )
timebegin ( integer [unsigned 16-bit] )
timeend ( integer [unsigned 16-bit] )
flags ( flagsObject )
interval_valid (true|false).
flags ( flagsObject )
backup_command (true|false).
restore_command (true|false).
system_files (true|false).
report_files (true|false).
log_files (true|false).
protocol_files (true|false).
etag ( etag )
 
/settings/failover
Created: 2016-03-24   Revised: 2018-03-27
 
GET /settings/failover Load the failover settings (from the settings file)
Result Model
failover
ip ( string )
isPrimary ( boolean [true|false] )
available ( boolean [true|false] )
lastError ( integer [unsigned 32-bit] )
maxDaysToReplicate ( integer [unsigned 32-bit] )
enabled ( boolean [true|false] )
suspended ( boolean [true|false] )
etag ( etag )
PUT /settings/failover Update the failover settings (to the settings file)
Parameters Model
failover
ip ( string )
isPrimary ( boolean [true|false] )
available ( boolean [true|false] )
lastError ( integer [unsigned 32-bit] )
maxDaysToReplicate ( integer [unsigned 32-bit] )
enabled ( boolean [true|false] )
suspended ( boolean [true|false] )
etag ( etag )
 
/settings/hsm
Created: 2016-03-24   Revised: 2018-03-27
 
GET /settings/hsm/manager Returns the current manager type (ie. none/registry/hsm) and token name if applicable.
Result Model
manager
type ( string )
token ( string )
pin ( string )
PUT /settings/hsm/manager Sets the current manager type
Parameters Model
manager
type ( string )
token ( string )
pin ( string )
GET /settings/hsm/cryptoki Returns Cryptoki DLL path and info
Result Model
cryptokiInfo
path ( string )
cryptokiVersion ( string )
manufacturer ( string )
description ( string )
libraryVersion ( string )
PUT /settings/hsm/cryptoki Sets Cryptoki DLL path
Parameters Model
cryptokiPath
path ( string )
 
/settings/logs
Created: 2016-03-24   Revised: 2018-03-27
 
GET /settings/logs Read log settings
Result Model
logSettings
version ( integer [unsigned 32-bit] )
enableDiagnostics ( boolean [true|false] )
saveIntervalType ( string )
none : Indicates that there is no save interval selected.
immediately (Default) : Indicates each log message will be saved to file immediately.
everyXMinutes : Indicates that log messages will be saved to file every X minutes as indicated by the saveIntervalMinutes field.
endOfDay : Indicates that log messages will be saved to file at the end of each day.
deleteIntervalType ( string )
none (Default) : Indicates that there is no delete interval selected.
everyXDays : Indicates that log files will be deleted from the system every X days as indicated by the deleteIntervalDays field.
saveIntervalMinutes ( integer [unsigned 32-bit] )
deleteIntervalDays ( integer [unsigned 32-bit] )
enableSyslog ( boolean [true|false] )
enableSnmpTrap ( boolean [true|false] )
enableEmailLog ( boolean [true|false] )
syslog ( LogSyslogSettingsObject )
severity ( string )
Informational (Default) : Used to indicate normal operation.
Warning : Used to indicate a more severe event may be pending if action is not taken.
Critical : Used to indicate a condition that should be corrected immediately.
snmpTrap ( LogSnmpTrapSettingsObject )
severity ( string )
Informational (Default) : Used to indicate normal operation.
Warning : Used to indicate a more severe event may be pending if action is not taken.
Critical : Used to indicate a condition that should be corrected immediately.
emailSettings ( LogEmailSettingsObject )
recipients ( string )
severity ( string )
Informational (Default) : Used to indicate normal operation.
Warning : Used to indicate a more severe event may be pending if action is not taken.
Critical : Used to indicate a condition that should be corrected immediately.
PUT /settings/logs Update log settings
Parameters Model
logSettings
version ( integer [unsigned 32-bit] )
enableDiagnostics ( boolean [true|false] )
saveIntervalType ( string )
none : Indicates that there is no save interval selected.
immediately (Default) : Indicates each log message will be saved to file immediately.
everyXMinutes : Indicates that log messages will be saved to file every X minutes as indicated by the saveIntervalMinutes field.
endOfDay : Indicates that log messages will be saved to file at the end of each day.
deleteIntervalType ( string )
none (Default) : Indicates that there is no delete interval selected.
everyXDays : Indicates that log files will be deleted from the system every X days as indicated by the deleteIntervalDays field.
saveIntervalMinutes ( integer [unsigned 32-bit] )
deleteIntervalDays ( integer [unsigned 32-bit] )
enableSyslog ( boolean [true|false] )
enableSnmpTrap ( boolean [true|false] )
enableEmailLog ( boolean [true|false] )
syslog ( LogSyslogSettingsObject )
severity ( string )
Informational (Default) : Used to indicate normal operation.
Warning : Used to indicate a more severe event may be pending if action is not taken.
Critical : Used to indicate a condition that should be corrected immediately.
snmpTrap ( LogSnmpTrapSettingsObject )
severity ( string )
Informational (Default) : Used to indicate normal operation.
Warning : Used to indicate a more severe event may be pending if action is not taken.
Critical : Used to indicate a condition that should be corrected immediately.
emailSettings ( LogEmailSettingsObject )
recipients ( string )
severity ( string )
Informational (Default) : Used to indicate normal operation.
Warning : Used to indicate a more severe event may be pending if action is not taken.
Critical : Used to indicate a condition that should be corrected immediately.
 
/settings/notifications
Created: 2016-03-24   Revised: 2018-03-27
 
GET /settings/notifications Read notification settings
Result Model
notificationSettings
enableSyslog ( boolean [true|false] )
enableSnmpTrap ( boolean [true|false] )
enableEmail ( boolean [true|false] )
syslog ( SyslogSettingsObject )
version ( string )
rfc3164 : Indicates Syslog messages will be sent in RFC 3164 format.
rfc5424 (Default) : Indicates Syslog messages will be sent in RFC 5424 format.
sendPort ( integer [unsigned 16-bit] )
serverIPs ( serverIPsObject  [Max: 10] )
ip ( ip address )
snmpTrap ( SnmpTrapSettingsObject )
version ( integer [signed 32-bit] )
port ( integer [unsigned 32-bit] )
community ( string  [Max length: 128] )
destinationIPs ( destinationIPsObject  [Max: 10] )
ip ( ip address )
emailSettings ( EmailSettingsObject )
smtpServer ( string  [Max length: 64] )
port ( integer [unsigned 32-bit] )
connectType ( integer [unsigned 32-bit] )
username ( string )
password ( string )
senderAddress ( string )
senderName ( string )
authType ( integer [unsigned 32-bit] )
PUT /settings/notifications Update notification settings
Parameters Model
notificationSettings
enableSyslog ( boolean [true|false] )
enableSnmpTrap ( boolean [true|false] )
enableEmail ( boolean [true|false] )
syslog ( SyslogSettingsObject )
version ( string )
rfc3164 : Indicates Syslog messages will be sent in RFC 3164 format.
rfc5424 (Default) : Indicates Syslog messages will be sent in RFC 5424 format.
sendPort ( integer [unsigned 16-bit] )
serverIPs ( serverIPsObject  [Max: 10] )
ip ( ip address )
snmpTrap ( SnmpTrapSettingsObject )
version ( integer [signed 32-bit] )
port ( integer [unsigned 32-bit] )
community ( string  [Max length: 128] )
destinationIPs ( destinationIPsObject  [Max: 10] )
ip ( ip address )
emailSettings ( EmailSettingsObject )
smtpServer ( string  [Max length: 64] )
port ( integer [unsigned 32-bit] )
connectType ( integer [unsigned 32-bit] )
username ( string )
password ( string )
senderAddress ( string )
senderName ( string )
authType ( integer [unsigned 32-bit] )
 
/settings/omslicense
Created: 2016-03-24   Revised: 2018-03-27
 
GET /settings/omslicense Returns the OMS license settings.
Result Model
omsLicense
id ( integer [unsigned 32-bit] )
license ( integer [unsigned 32-bit] )
limit ( integer [unsigned 32-bit] )
trialexp ( timestamp )
etag ( etag )
PUT /settings/omslicense Update the OMS license settings
Parameters Model
omsLicense
id ( integer [unsigned 32-bit] )
license ( integer [unsigned 32-bit] )
limit ( integer [unsigned 32-bit] )
trialexp ( timestamp )
etag ( etag )
 
/settings/security
Created: 2016-03-24   Revised: 2018-03-27
 
GET /settings/security Returns the security settings.
Result Model
security
alarmThreshold ( integer [unsigned 32-bit] )
blockThreshold ( integer [unsigned 32-bit] )
etag ( etag )
PUT /settings/security Update the security settings
Parameters Model
security
alarmThreshold ( integer [unsigned 32-bit] )
blockThreshold ( integer [unsigned 32-bit] )
etag ( etag )
 
/sharedFilters
Created: 2016-03-24   Revised: 2018-03-27
 
GET /sharedFilters Retrieve all shared filters
Result Model
sharedfilters
id ( uuid )
flags ( flagsObject )
deleted (true|false).
name ( string )
folder ( string )
description ( string )
version ( integer [unsigned 32-bit] )
color ( integer [unsigned 32-bit] )
etag ( etag )
POST /sharedFilters Create a new shared filter
Parameters Model
sharedfilter
id ( uuid )
flags ( flagsObject )
deleted (true|false).
name ( string )
folder ( string )
description ( string )
version ( integer [unsigned 32-bit] )
color ( integer [unsigned 32-bit] )
etag ( etag )
GET /sharedFilters/{sharedFilterID} Retrieve a specific shared filter by ID
Result Model
sharedfilter
id ( uuid )
flags ( flagsObject )
deleted (true|false).
name ( string )
folder ( string )
description ( string )
version ( integer [unsigned 32-bit] )
color ( integer [unsigned 32-bit] )
etag ( etag )
PUT /sharedFilters/{sharedFilterID} Update a specific shared filter by ID
Parameters Model
sharedfilter
id ( uuid )
flags ( flagsObject )
deleted (true|false).
name ( string )
folder ( string )
description ( string )
version ( integer [unsigned 32-bit] )
color ( integer [unsigned 32-bit] )
etag ( etag )
DELETE /sharedFilters/{sharedFilterID} Delete a specific shared filter by ID
 
/softwareserver
Created: 2016-03-24   Revised: 2018-03-27
 
GET /softwareserver Query for software upgrade entries
Result Model
softwareUpgrades
itemId ( uuid )
active ( boolean [true|false] )
app ( integer [unsigned 16-bit] )
version ( string )
timestamp ( timestamp )
notes ( notesObject )
desc ( string )
files ( integer [unsigned 32-bit] )
size ( integer [unsigned 32-bit] )
itemEtag ( etag )
GET /softwareserver/{itemId} Reads details for a given patch GUID
Result Model
softwareUpgrade
itemId ( uuid )
active ( boolean [true|false] )
app ( integer [unsigned 16-bit] )
version ( string )
timestamp ( timestamp )
notes ( notesObject )
desc ( string )
files ( integer [unsigned 32-bit] )
size ( integer [unsigned 32-bit] )
itemEtag ( etag )
PUT /softwareserver/{itemId} Changes the active flag for a given patch GUID
Parameters Model
softwareUpgrade
itemId ( uuid )
active ( boolean [true|false] )
app ( integer [unsigned 16-bit] )
version ( string )
timestamp ( timestamp )
notes ( notesObject )
desc ( string )
files ( integer [unsigned 32-bit] )
size ( integer [unsigned 32-bit] )
itemEtag ( etag )
DELETE /softwareserver/{itemId} Dummy define for subscription
GET /softwareserver/operations Query for software upgrade operations
Result Model
pendingOperations
operationId ( uuid )
download ( DownloadOperationObject )
itemId ( uuid )
apply ( boolean [true|false] )
app ( integer [unsigned 16-bit] )
state ( string )
inProgress
canceled
complete
noFiles
error
scheduleEnd
currentFile ( integer [unsigned 32-bit] )
totalFiles ( integer [unsigned 32-bit] )
progress ( integer [unsigned 32-bit] )
progressMax ( integer [unsigned 32-bit] )
transferSpeed ( integer [unsigned 32-bit] )
install ( InstallOperationObject )
state ( string )
aborted
pending
started
message ( string )
refresh ( RefreshOperationObject )
checkUpgrades ( boolean [true|false] )
operationEtag ( etag )
POST /softwareserver/operations Starts an operation
Parameters Model
operation
operationId ( uuid )
download ( DownloadOperationObject )
itemId ( uuid )
apply ( boolean [true|false] )
app ( integer [unsigned 16-bit] )
state ( string )
inProgress
canceled
complete
noFiles
error
scheduleEnd
currentFile ( integer [unsigned 32-bit] )
totalFiles ( integer [unsigned 32-bit] )
progress ( integer [unsigned 32-bit] )
progressMax ( integer [unsigned 32-bit] )
transferSpeed ( integer [unsigned 32-bit] )
install ( InstallOperationObject )
state ( string )
aborted
pending
started
message ( string )
refresh ( RefreshOperationObject )
checkUpgrades ( boolean [true|false] )
operationEtag ( etag )
GET /softwareserver/operations/{operationId} Gets current state of an operation
Result Model
pendingOperation
operationId ( uuid )
download ( DownloadOperationObject )
itemId ( uuid )
apply ( boolean [true|false] )
app ( integer [unsigned 16-bit] )
state ( string )
inProgress
canceled
complete
noFiles
error
scheduleEnd
currentFile ( integer [unsigned 32-bit] )
totalFiles ( integer [unsigned 32-bit] )
progress ( integer [unsigned 32-bit] )
progressMax ( integer [unsigned 32-bit] )
transferSpeed ( integer [unsigned 32-bit] )
install ( InstallOperationObject )
state ( string )
aborted
pending
started
message ( string )
refresh ( RefreshOperationObject )
checkUpgrades ( boolean [true|false] )
operationEtag ( etag )
DELETE /softwareserver/operations/{operationId} Cancels a current operation
GET /softwareserver/settings Gets current settings
Result Model
settings
checkUpgrades ( boolean [true|false] )
matchClient ( boolean [true|false] )
downloadSpeed ( integer [unsigned 32-bit] )
transferSchedule ( ScheduleUpgradeStructObject )
mode ( integer [unsigned 16-bit] )
weekdays ( integer [unsigned 16-bit] )
day ( dayObject )
intervals ( intervalsObject )
timebegin ( integer [unsigned 16-bit] )
timeend ( integer [unsigned 16-bit] )
port ( integer [unsigned 16-bit] )
disableOa ( boolean [true|false] )
disableObs ( boolean [true|false] )
disableEco ( boolean [true|false] )
proxyServer ( string )
proxyPort ( integer [unsigned 32-bit] )
proxyType ( string )
HTTP/1.0
HTTP/1.1 (Default)
SOCKS4
SOCKS4A
SOCKS5
proxyUser ( string )
proxyPass ( string )
etag ( etag )
PUT /softwareserver/settings Updates current settings
Parameters Model
settings
checkUpgrades ( boolean [true|false] )
matchClient ( boolean [true|false] )
downloadSpeed ( integer [unsigned 32-bit] )
transferSchedule ( ScheduleUpgradeStructObject )
mode ( integer [unsigned 16-bit] )
weekdays ( integer [unsigned 16-bit] )
day ( dayObject )
intervals ( intervalsObject )
timebegin ( integer [unsigned 16-bit] )
timeend ( integer [unsigned 16-bit] )
port ( integer [unsigned 16-bit] )
disableOa ( boolean [true|false] )
disableObs ( boolean [true|false] )
disableEco ( boolean [true|false] )
proxyServer ( string )
proxyPort ( integer [unsigned 32-bit] )
proxyType ( string )
HTTP/1.0
HTTP/1.1 (Default)
SOCKS4
SOCKS4A
SOCKS5
proxyUser ( string )
proxyPass ( string )
etag ( etag )
 
/softwareupgrade
Created: 2016-03-24   Revised: 2018-03-27
 
GET /softwareupgrade Query for software upgrade entries
Result Model
softwareUpgrades
itemId ( uuid )
active ( boolean [true|false] )
app ( integer [unsigned 16-bit] )
version ( string )
timestamp ( timestamp )
notes ( notesObject )
desc ( string )
files ( integer [unsigned 32-bit] )
size ( integer [unsigned 32-bit] )
itemEtag ( etag )
GET /softwareupgrade/{itemId} Reads details for a given patch GUID
Result Model
softwareUpgrade
itemId ( uuid )
active ( boolean [true|false] )
app ( integer [unsigned 16-bit] )
version ( string )
timestamp ( timestamp )
notes ( notesObject )
desc ( string )
files ( integer [unsigned 32-bit] )
size ( integer [unsigned 32-bit] )
itemEtag ( etag )
DELETE /softwareupgrade/{itemId} Dummy define for subscription
GET /softwareupgrade/operations Query for software upgrade operations
Result Model
pendingOperations
operationId ( uuid )
download ( DownloadOperationObject )
itemId ( uuid )
apply ( boolean [true|false] )
app ( integer [unsigned 16-bit] )
state ( string )
inProgress
canceled
complete
noFiles
error
scheduleEnd
currentFile ( integer [unsigned 32-bit] )
totalFiles ( integer [unsigned 32-bit] )
progress ( integer [unsigned 32-bit] )
progressMax ( integer [unsigned 32-bit] )
transferSpeed ( integer [unsigned 32-bit] )
install ( InstallOperationObject )
state ( string )
aborted
pending
started
message ( string )
refresh ( RefreshOperationObject )
checkUpgrades ( boolean [true|false] )
operationEtag ( etag )
POST /softwareupgrade/operations Starts an operation
Parameters Model
operation
operationId ( uuid )
download ( DownloadOperationObject )
itemId ( uuid )
apply ( boolean [true|false] )
app ( integer [unsigned 16-bit] )
state ( string )
inProgress
canceled
complete
noFiles
error
scheduleEnd
currentFile ( integer [unsigned 32-bit] )
totalFiles ( integer [unsigned 32-bit] )
progress ( integer [unsigned 32-bit] )
progressMax ( integer [unsigned 32-bit] )
transferSpeed ( integer [unsigned 32-bit] )
install ( InstallOperationObject )
state ( string )
aborted
pending
started
message ( string )
refresh ( RefreshOperationObject )
checkUpgrades ( boolean [true|false] )
operationEtag ( etag )
GET /softwareupgrade/operations/{operationId} Gets current state of an operation
Result Model
pendingOperation
operationId ( uuid )
download ( DownloadOperationObject )
itemId ( uuid )
apply ( boolean [true|false] )
app ( integer [unsigned 16-bit] )
state ( string )
inProgress
canceled
complete
noFiles
error
scheduleEnd
currentFile ( integer [unsigned 32-bit] )
totalFiles ( integer [unsigned 32-bit] )
progress ( integer [unsigned 32-bit] )
progressMax ( integer [unsigned 32-bit] )
transferSpeed ( integer [unsigned 32-bit] )
install ( InstallOperationObject )
state ( string )
aborted
pending
started
message ( string )
refresh ( RefreshOperationObject )
checkUpgrades ( boolean [true|false] )
operationEtag ( etag )
DELETE /softwareupgrade/operations/{operationId} Cancels a current operation
GET /softwareupgrade/settings Gets current settings
Result Model
settings
checkUpgrades ( boolean [true|false] )
showDowngrades ( boolean [true|false] )
downloadSpeed ( integer [unsigned 32-bit] )
transferSchedule ( ScheduleUpgradeStructObject )
mode ( integer [unsigned 16-bit] )
weekdays ( integer [unsigned 16-bit] )
day ( dayObject )
intervals ( intervalsObject )
timebegin ( integer [unsigned 16-bit] )
timeend ( integer [unsigned 16-bit] )
installSchedule ( ScheduleUpgradeStructObject )
mode ( integer [unsigned 16-bit] )
weekdays ( integer [unsigned 16-bit] )
day ( dayObject )
intervals ( intervalsObject )
timebegin ( integer [unsigned 16-bit] )
timeend ( integer [unsigned 16-bit] )
proxyServer ( string )
proxyPort ( integer [unsigned 32-bit] )
proxyType ( string )
HTTP/1.0
HTTP/1.1 (Default)
SOCKS4
SOCKS4A
SOCKS5
proxyUser ( string )
proxyPass ( string )
failoverUpgrade ( string )
Not applicable
Primary (Default)
Secondary
Either
etag ( etag )
PUT /softwareupgrade/settings Updates current settings
Parameters Model
settings
checkUpgrades ( boolean [true|false] )
showDowngrades ( boolean [true|false] )
downloadSpeed ( integer [unsigned 32-bit] )
transferSchedule ( ScheduleUpgradeStructObject )
mode ( integer [unsigned 16-bit] )
weekdays ( integer [unsigned 16-bit] )
day ( dayObject )
intervals ( intervalsObject )
timebegin ( integer [unsigned 16-bit] )
timeend ( integer [unsigned 16-bit] )
installSchedule ( ScheduleUpgradeStructObject )
mode ( integer [unsigned 16-bit] )
weekdays ( integer [unsigned 16-bit] )
day ( dayObject )
intervals ( intervalsObject )
timebegin ( integer [unsigned 16-bit] )
timeend ( integer [unsigned 16-bit] )
proxyServer ( string )
proxyPort ( integer [unsigned 32-bit] )
proxyType ( string )
HTTP/1.0
HTTP/1.1 (Default)
SOCKS4
SOCKS4A
SOCKS5
proxyUser ( string )
proxyPass ( string )
failoverUpgrade ( string )
Not applicable
Primary (Default)
Secondary
Either
etag ( etag )
 
/upgradepolicies
Created: 2016-03-24   Revised: 2018-03-27
 
GET /upgradepolicies Retrieve all UpgradePolicies
Result Model
upgradepolicies
id ( uuid )
flags ( flagsObject )
protected (true|false).
name ( string )
desc ( string )
isAllowUpgrade ( boolean [true|false] )
isAllowDowngrade ( boolean [true|false] )
transferRateLimit ( integer [unsigned 32-bit] )
transferSchedule ( ScheduleExStructObject )
mode ( integer [unsigned 16-bit] )
weekdays ( integer [unsigned 16-bit] )
day ( dayObject )
intervals ( intervalsObject )
timebegin ( integer [unsigned 16-bit] )
timeend ( integer [unsigned 16-bit] )
installSchedule ( ScheduleExStructObject )
mode ( integer [unsigned 16-bit] )
weekdays ( integer [unsigned 16-bit] )
day ( dayObject )
intervals ( intervalsObject )
timebegin ( integer [unsigned 16-bit] )
timeend ( integer [unsigned 16-bit] )
etag ( etag )
POST /upgradepolicies Create a new UpgradePolicy
Parameters Model
upgradepolicy
id ( uuid )
flags ( flagsObject )
protected (true|false).
name ( string )
desc ( string )
isAllowUpgrade ( boolean [true|false] )
isAllowDowngrade ( boolean [true|false] )
transferRateLimit ( integer [unsigned 32-bit] )
transferSchedule ( ScheduleExStructObject )
mode ( integer [unsigned 16-bit] )
weekdays ( integer [unsigned 16-bit] )
day ( dayObject )
intervals ( intervalsObject )
timebegin ( integer [unsigned 16-bit] )
timeend ( integer [unsigned 16-bit] )
installSchedule ( ScheduleExStructObject )
mode ( integer [unsigned 16-bit] )
weekdays ( integer [unsigned 16-bit] )
day ( dayObject )
intervals ( intervalsObject )
timebegin ( integer [unsigned 16-bit] )
timeend ( integer [unsigned 16-bit] )
etag ( etag )
GET /upgradepolicies/{upgradePolicyID} Retrieve a specific upgradepolicy by ID
Result Model
upgradepolicy
id ( uuid )
flags ( flagsObject )
protected (true|false).
name ( string )
desc ( string )
isAllowUpgrade ( boolean [true|false] )
isAllowDowngrade ( boolean [true|false] )
transferRateLimit ( integer [unsigned 32-bit] )
transferSchedule ( ScheduleExStructObject )
mode ( integer [unsigned 16-bit] )
weekdays ( integer [unsigned 16-bit] )
day ( dayObject )
intervals ( intervalsObject )
timebegin ( integer [unsigned 16-bit] )
timeend ( integer [unsigned 16-bit] )
installSchedule ( ScheduleExStructObject )
mode ( integer [unsigned 16-bit] )
weekdays ( integer [unsigned 16-bit] )
day ( dayObject )
intervals ( intervalsObject )
timebegin ( integer [unsigned 16-bit] )
timeend ( integer [unsigned 16-bit] )
etag ( etag )
PUT /upgradepolicies/{upgradePolicyID} Update a specific UpgradePolicy by ID
Parameters Model
upgradepolicy
id ( uuid )
flags ( flagsObject )
protected (true|false).
name ( string )
desc ( string )
isAllowUpgrade ( boolean [true|false] )
isAllowDowngrade ( boolean [true|false] )
transferRateLimit ( integer [unsigned 32-bit] )
transferSchedule ( ScheduleExStructObject )
mode ( integer [unsigned 16-bit] )
weekdays ( integer [unsigned 16-bit] )
day ( dayObject )
intervals ( intervalsObject )
timebegin ( integer [unsigned 16-bit] )
timeend ( integer [unsigned 16-bit] )
installSchedule ( ScheduleExStructObject )
mode ( integer [unsigned 16-bit] )
weekdays ( integer [unsigned 16-bit] )
day ( dayObject )
intervals ( intervalsObject )
timebegin ( integer [unsigned 16-bit] )
timeend ( integer [unsigned 16-bit] )
etag ( etag )
DELETE /upgradepolicies/{upgradePolicyID} Delete a specific UpgradePolicy by ID
 
/userGroups
Created: 2016-03-24   Revised: 2018-03-27
 
GET /userGroups Retrieve all user groups
Result Model
usergroups
id ( uuid )
flags ( flagsObject )
remoteGroup (true|false).
protected (true|false).
disabled (true|false).
recv_auth_warning (true|false).
name ( string )
description ( string )
permissionbyusergroup ( permissionbyusergroupObject  [Max: 512] )
relationshipId ( uuid )
permissionPolicyId ( uuid )
userGroupId ( uuid )
userbyusergroup ( userbyusergroupObject  [Max: 512] )
relationshipId ( uuid )
userId ( uuid )
userGroupId ( uuid )
assetgroupbyusergroup ( assetgroupbyusergroupObject  [Max: 512] )
relationshipId ( uuid )
assetGroupId ( uuid )
userGroupId ( uuid )
assetbyusergroup ( assetbyusergroupObject  [Max: 512] )
relationshipId ( uuid )
assetId ( uuid )
userGroupId ( uuid )
etag ( etag )
POST /userGroups Create a new user group
Parameters Model
usergroup
id ( uuid )
flags ( flagsObject )
remoteGroup (true|false).
protected (true|false).
disabled (true|false).
recv_auth_warning (true|false).
name ( string )
description ( string )
permissionbyusergroup ( permissionbyusergroupObject  [Max: 512] )
relationshipId ( uuid )
permissionPolicyId ( uuid )
userGroupId ( uuid )
userbyusergroup ( userbyusergroupObject  [Max: 512] )
relationshipId ( uuid )
userId ( uuid )
userGroupId ( uuid )
assetgroupbyusergroup ( assetgroupbyusergroupObject  [Max: 512] )
relationshipId ( uuid )
assetGroupId ( uuid )
userGroupId ( uuid )
assetbyusergroup ( assetbyusergroupObject  [Max: 512] )
relationshipId ( uuid )
assetId ( uuid )
userGroupId ( uuid )
etag ( etag )
GET /userGroups/{userGroupID} Retrieve a specific user group by ID
Result Model
usergroup
id ( uuid )
flags ( flagsObject )
remoteGroup (true|false).
protected (true|false).
disabled (true|false).
recv_auth_warning (true|false).
name ( string )
description ( string )
permissionbyusergroup ( permissionbyusergroupObject  [Max: 512] )
relationshipId ( uuid )
permissionPolicyId ( uuid )
userGroupId ( uuid )
userbyusergroup ( userbyusergroupObject  [Max: 512] )
relationshipId ( uuid )
userId ( uuid )
userGroupId ( uuid )
assetgroupbyusergroup ( assetgroupbyusergroupObject  [Max: 512] )
relationshipId ( uuid )
assetGroupId ( uuid )
userGroupId ( uuid )
assetbyusergroup ( assetbyusergroupObject  [Max: 512] )
relationshipId ( uuid )
assetId ( uuid )
userGroupId ( uuid )
etag ( etag )
PUT /userGroups/{userGroupID} Update a specific user group by ID
Parameters Model
usergroup
id ( uuid )
flags ( flagsObject )
remoteGroup (true|false).
protected (true|false).
disabled (true|false).
recv_auth_warning (true|false).
name ( string )
description ( string )
permissionbyusergroup ( permissionbyusergroupObject  [Max: 512] )
relationshipId ( uuid )
permissionPolicyId ( uuid )
userGroupId ( uuid )
userbyusergroup ( userbyusergroupObject  [Max: 512] )
relationshipId ( uuid )
userId ( uuid )
userGroupId ( uuid )
assetgroupbyusergroup ( assetgroupbyusergroupObject  [Max: 512] )
relationshipId ( uuid )
assetGroupId ( uuid )
userGroupId ( uuid )
assetbyusergroup ( assetbyusergroupObject  [Max: 512] )
relationshipId ( uuid )
assetId ( uuid )
userGroupId ( uuid )
etag ( etag )
DELETE /userGroups/{userGroupID} Delete a specific user group by ID
GET /userGroups/import Retrieve remote groups for import
Result Model
usergroups
id ( uuid )
flags ( flagsObject )
remoteGroup (true|false).
protected (true|false).
disabled (true|false).
recv_auth_warning (true|false).
name ( string )
description ( string )
permissionbyusergroup ( permissionbyusergroupObject  [Max: 512] )
relationshipId ( uuid )
permissionPolicyId ( uuid )
userGroupId ( uuid )
userbyusergroup ( userbyusergroupObject  [Max: 512] )
relationshipId ( uuid )
userId ( uuid )
userGroupId ( uuid )
assetgroupbyusergroup ( assetgroupbyusergroupObject  [Max: 512] )
relationshipId ( uuid )
assetGroupId ( uuid )
userGroupId ( uuid )
assetbyusergroup ( assetbyusergroupObject  [Max: 512] )
relationshipId ( uuid )
assetId ( uuid )
userGroupId ( uuid )
etag ( etag )
POST /userGroups/import Import user groups from remote sources
Parameters Model
usergroups
 
/users
Created: 2016-03-24   Revised: 2018-03-27
 
GET /users Retrieve all users
Result Model
users
id ( uuid )
flags ( flagsObject )
remote_managed (true|false).
protected (true|false).
remote_auth (true|false).
disabled (true|false).
recv_auth_warning (true|false).
username ( string )
password ( string )
description ( string )
email ( string )
usergroupbyuser ( usergroupbyuserObject  [Max: 512] )
relationshipId ( uuid )
userId ( uuid )
userGroupId ( uuid )
etag ( etag )
POST /users Create a new user
Parameters Model
user
id ( uuid )
flags ( flagsObject )
remote_managed (true|false).
protected (true|false).
remote_auth (true|false).
disabled (true|false).
recv_auth_warning (true|false).
username ( string )
password ( string )
description ( string )
email ( string )
usergroupbyuser ( usergroupbyuserObject  [Max: 512] )
relationshipId ( uuid )
userId ( uuid )
userGroupId ( uuid )
etag ( etag )
GET /users/{userID} Retrieve a specific user by ID
Result Model
user
id ( uuid )
flags ( flagsObject )
remote_managed (true|false).
protected (true|false).
remote_auth (true|false).
disabled (true|false).
recv_auth_warning (true|false).
username ( string )
password ( string )
description ( string )
email ( string )
usergroupbyuser ( usergroupbyuserObject  [Max: 512] )
relationshipId ( uuid )
userId ( uuid )
userGroupId ( uuid )
etag ( etag )
PUT /users/{userID} Update a specific user by ID
Parameters Model
user
id ( uuid )
flags ( flagsObject )
remote_managed (true|false).
protected (true|false).
remote_auth (true|false).
disabled (true|false).
recv_auth_warning (true|false).
username ( string )
password ( string )
description ( string )
email ( string )
usergroupbyuser ( usergroupbyuserObject  [Max: 512] )
relationshipId ( uuid )
userId ( uuid )
userGroupId ( uuid )
etag ( etag )
DELETE /users/{userID} Delete a specific user by ID
GET /users/import Retrieve remote users for import
Result Model
users
id ( uuid )
flags ( flagsObject )
remote_managed (true|false).
protected (true|false).
remote_auth (true|false).
disabled (true|false).
recv_auth_warning (true|false).
username ( string )
password ( string )
description ( string )
email ( string )
usergroupbyuser ( usergroupbyuserObject  [Max: 512] )
relationshipId ( uuid )
userId ( uuid )
userGroupId ( uuid )
etag ( etag )
POST /users/import Import users from remote sources
Parameters Model
users