API Reference
Methods
ADCollector
get /api/v{version}/collectors/activedirectory/collectorsdelete /api/v{version}/collectors/activedirectory/collectors/{id}get /api/v{version}/collectors/activedirectory/collectors/{id}post /api/v{version}/collectors/activedirectory/collectorsput /api/v{version}/collectors/activedirectory/collectorspost /api/v{version}/collectors/activedirectory/collectors/search/domaincontrollers
AttributeSearch
get /api/v{version}/collectors/activedirectory/attributes/search/displaynamesget /api/v{version}/collectors/activedirectory/attributes/searchget /api/v{version}/collectors/activedirectory/attributes/search/names
AuditorService
get /api/v{version}/system/config/service/all/statusget /api/v{version}/system/config/servicepost /api/v{version}/system/config/service/{id}/restartpost /api/v{version}/system/config/service/{id}/startget /api/v{version}/system/config/service/{id}/statuspost /api/v{version}/system/config/service/{id}/stoppost /api/v{version}/system/config/serviceput /api/v{version}/system/config/service
Authorization
post /api/v{version}/auth/loginpost /api/v{version}/auth/login/refreshget /api/v{version}/auth/logout
Azure
delete /api/v{version}/collectors/azure/globalRateLimitingput /api/v{version}/collectors/azure/globalRateLimitingget /api/v{version}/collectors/azure/targetsdelete /api/v{version}/collectors/azure/targets/{id}get /api/v{version}/collectors/azure/targets/{id}put /api/v{version}/collectors/azure/targets/{id}post /api/v{version}/collectors/azure/targets
AzureBackup
get /api/v{version}/collectors/azure/snapshotsget /api/v{version}/collectors/azure/snapshots/{snapshotId}
AzureObjects
Backup
get /api/v{version}/collectors/activedirectory/backups/{backupId}get /api/v{version}/collectors/activedirectory/backups/{backupId}/snapshotsget /api/v{version}/collectors/activedirectory/backups/{backupId}/snapshots/{snapshotId}get /api/v{version}/collectors/activedirectory/backupsget /api/v{version}/collectors/activedirectory/backups/snapshotsget /api/v{version}/collectors/activedirectory/backups/snapshots/gpodiffget /api/v{version}/collectors/activedirectory/backups/snapshots/objects/timeget /api/v{version}/collectors/activedirectory/backups/snapshots/{snapshotId}
Charts
CollectorStatusCheckConfiguration
get /api/v{version}/system/config/collectorStatusCheckput /api/v{version}/system/config/collectorStatusCheck
ConfigurationString
DataPurge
get /api/v{version}/datapurge/defaultdelete /api/v{version}/datapurgeget /api/v{version}/datapurgepost /api/v{version}/datapurgeput /api/v{version}/datapurge
Database
post /api/v{version}/setup/database/catalogput /api/v{version}/setup/database/catalogget /api/v{version}/setup/database/connectionpost /api/v{version}/setup/database/connectionpost /api/v{version}/setup/database/connection/testpost /api/v{version}/setup/database/search/catalogsget /api/v{version}/setup/database/search/serverspost /api/v{version}/setup/database/version
DatabaseConnector
post /api/v{version}/database/connectors/catalogsget /api/v{version}/database/connectorsdelete /api/v{version}/database/connectors/{id}get /api/v{version}/database/connectors/{id}put /api/v{version}/database/connectors/{id}post /api/v{version}/database/connectors/migratepost /api/v{version}/database/connectorspost /api/v{version}/database/connectors/validate
DelegatedResource
get /api/v{version}/delegatedresourcesdelete /api/v{version}/delegatedresources/{id}get /api/v{version}/delegatedresources/{id}put /api/v{version}/delegatedresources/{id}post /api/v{version}/delegatedresources
DirectoryObject
get /api/v{version}/collectors/activedirectory/objects/attributesget /api/v{version}/collectors/activedirectory/objects/browseget /api/v{version}/collectors/activedirectory/objectsget /api/v{version}/collectors/activedirectory/objects/membersget /api/v{version}/collectors/activedirectory/objects/membershipget /api/v{version}/collectors/activedirectory/objects/{objectId}get /api/v{version}/collectors/activedirectory/objects/searchget /api/v{version}/collectors/activedirectory/objects/securityget /api/v{version}/collectors/activedirectory/search
Domains
post /api/v{version}/collectors/activedirectory/domains/configuration/export/{domainId}post /api/v{version}/collectors/activedirectory/domains/controllers/searchget /api/v{version}/collectors/activedirectory/domainsdelete /api/v{version}/collectors/activedirectory/domains/{id}/controllers/alldelete /api/v{version}/collectors/activedirectory/domains/{id}/controllers/{dcid}post /api/v{version}/collectors/activedirectory/domains/{id}/controllers/{dcid}/restartpost /api/v{version}/collectors/activedirectory/domains/{id}/controllers/{dcid}/startpost /api/v{version}/collectors/activedirectory/domains/{id}/controllers/{dcid}/stopdelete /api/v{version}/collectors/activedirectory/domains/{id}/controllersget /api/v{version}/collectors/activedirectory/domains/{id}/controllerspost /api/v{version}/collectors/activedirectory/domains/{id}/controllersput /api/v{version}/collectors/activedirectory/domains/{id}/controllersdelete /api/v{version}/collectors/activedirectory/domains/{id}get /api/v{version}/collectors/activedirectory/domains/{id}put /api/v{version}/collectors/activedirectory/domains/{id}post /api/v{version}/collectors/activedirectory/domainspost /api/v{version}/collectors/activedirectory/domains/search
Event
FileSystem
put /api/v{version}/collectors/filesystem/delete/allput /api/v{version}/collectors/filesystem/deleteget /api/v{version}/collectors/filesystemget /api/v{version}/collectors/filesystem/{id}post /api/v{version}/collectors/filesystemput /api/v{version}/collectors/filesystemput /api/v{version}/collectors/filesystem/restartpost /api/v{version}/collectors/filesystem/searchput /api/v{version}/collectors/filesystem/startput /api/v{version}/collectors/filesystem/stop
Filter
get /api/v{version}/collectors/filesystem/filtersdelete /api/v{version}/collectors/filesystem/filters/{id}get /api/v{version}/collectors/filesystem/filters/{id}put /api/v{version}/collectors/filesystem/filters/{id}post /api/v{version}/collectors/filesystem/filterspost /api/v{version}/collectors/filesystem/filters/shares
HealthCheck
post /api/v{version}/healthcheck/allpost /api/v{version}/healthcheck/{id}post /api/v{version}/healthcheck/ping
IIS
get /api/v{version}/setup/iis/applicationpools/currentput /api/v{version}/setup/iis/applicationpools/current/identitypost /api/v{version}/setup/iis/applicationpools/currentput /api/v{version}/setup/iis/applicationpools/currentpost /api/v{version}/setup/iis/applicationpools/current/recycleget /api/v{version}/setup/iis/applicationpools
Identity
delete /api/v{version}/identity/allget /api/v{version}/identitydelete /api/v{version}/identity/{id}get /api/v{version}/identity/{id}put /api/v{version}/identity/{id}delete /api/v{version}/identity/{identity}/accounts/{id}post /api/v{version}/identity
License
delete /api/v{version}/system/config/licenseget /api/v{version}/system/config/licensepost /api/v{version}/system/config/licenseget /api/v{version}/system/config/license/statuspost /api/v{version}/system/config/license/verify
Log
Logging
delete /api/v{version}/system/config/loggingget /api/v{version}/system/config/loggingpost /api/v{version}/system/config/loggingput /api/v{version}/system/config/logging
Office365
put /api/v{version}/collectors/o365/refreshLicenseget /api/v{version}/collectors/o365/teams/channelsget /api/v{version}/collectors/o365/teams/{searchString}/channelsget /api/v{version}/collectors/o365/tenantsdelete /api/v{version}/collectors/o365/tenants/{id}get /api/v{version}/collectors/o365/tenants/{id}put /api/v{version}/collectors/o365/tenants/{id}post /api/v{version}/collectors/o365/tenantsget /api/v{version}/collectors/o365/tenants/precursorget /api/v{version}/collectors/o365/verify
Permission
Profile
Protection
delete /api/v{version}/protector/domain/{domainId}/policiesget /api/v{version}/protector/domain/{domainId}/policiespost /api/v{version}/protector/domain/policies/export/{domainId}get /api/v{version}/protector/domain/policiesdelete /api/v{version}/protector/domain/policies/{policyId}get /api/v{version}/protector/domain/policies/{policyId}post /api/v{version}/protector/domain/policiesput /api/v{version}/protector/policiesget /api/v{version}/protector/rulespost /api/v{version}/protector/rulesput /api/v{version}/protector/rulesdelete /api/v{version}/protector/rules/{ruleId}get /api/v{version}/protector/rules/{ruleId}
Proxy
post /api/v{version}/system/config/proxy/deleteget /api/v{version}/system/config/proxypost /api/v{version}/system/config/proxyput /api/v{version}/system/config/proxyget /api/v{version}/system/config/proxy/statuspost /api/v{version}/system/config/proxy/testpost /api/v{version}/system/config/proxy/verify
Recovery
get /api/v{version}/collectors/activedirectory/recoverypost /api/v{version}/collectors/activedirectory/recovery/passwordpost /api/v{version}/collectors/activedirectory/recovery
RemoteLoggerConfiguration
delete /api/v{version}/system/config/remoteloggerget /api/v{version}/system/config/remoteloggerpost /api/v{version}/system/config/remoteloggerput /api/v{version}/system/config/remotelogger
Report
get /api/v{version}/reports/EventColumnsAlphaget /api/v{version}/reports/EventColumnspost /api/v{version}/reports/exportget /api/v{version}/reportsdelete /api/v{version}/reports/{id}get /api/v{version}/reports/{id}put /api/v{version}/reports/{id}post /api/v{version}/reports/{id}/tagspost /api/v{version}/reports
ReportStyling
Role
get /api/v{version}/delegation/roles/accountsget /api/v{version}/delegation/rolesget /api/v{version}/delegation/roles/{id}/accounts/{accountId}put /api/v{version}/delegation/roles/{id}/accounts/{accountId}get /api/v{version}/delegation/roles/{id}/accountspost /api/v{version}/delegation/roles/{id}/accountsdelete /api/v{version}/delegation/roles/{id}get /api/v{version}/delegation/roles/{id}post /api/v{version}/delegation/rolesput /api/v{version}/delegation/rolesdelete /api/v{version}/delegation/roles/{roleId}/accounts/{accountId}
ScheduledJob
get /api/v{version}/scheduledjobsdelete /api/v{version}/scheduledjobs/{id}get /api/v{version}/scheduledjobs/{id}put /api/v{version}/scheduledjobs/{id}post /api/v{version}/scheduledjobs
Scheduler
Search
ServiceCommand
Setup
Smtp
delete /api/v{version}/system/config/smtpget /api/v{version}/system/config/smtppost /api/v{version}/system/config/smtpput /api/v{version}/system/config/smtpget /api/v{version}/system/config/smtp/statuspost /api/v{version}/system/config/smtp/test
System
SystemConfiguration
delete /api/v{version}/system/config/{id}get /api/v{version}/system/config/{id}post /api/v{version}/system/configput /api/v{version}/system/configget /api/v{version}/system/config/statuspost /api/v{version}/system/config/testpost /api/v{version}/system/config/validate
Tag
post /api/v{version}/tags/context/{context}get /api/v{version}/tags/contextualget /api/v{version}/tagsdelete /api/v{version}/tags/{id}get /api/v{version}/tags/{id}put /api/v{version}/tags/{id}post /api/v{version}/tags
User
get /api/v{version}/delegation/usersdelete /api/v{version}/delegation/users/{id}get /api/v{version}/delegation/users/{id}/permissionsput /api/v{version}/delegation/users/{id}get /api/v{version}/delegation/users/{id}/rolespost /api/v{version}/delegation/userspost /api/v{version}/user/credentials/verifyget /api/v{version}/user/search/activedirectoryget /api/v{version}/user/search
UserConfiguration
delete /api/v{version}/user/configpost /api/v{version}/user/config/deleteget /api/v{version}/user/configpost /api/v{version}/user/configput /api/v{version}/user/config
VMWare
get /api/v{version}/collectors/vmware/serversdelete /api/v{version}/collectors/vmware/servers/{id}get /api/v{version}/collectors/vmware/servers/{id}put /api/v{version}/collectors/vmware/servers/{id}post /api/v{version}/collectors/vmware/servers
ADCollector
Up
get /api/v{version}/collectors/activedirectory/collectors (apiVversionCollectorsActivedirectoryCollectorsGet)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"domainController" : "domainController",
"backupPassword" : "backupPassword",
"backupCollectionInterval" : 6,
"description" : "description",
"dnsName" : "dnsName",
"namingContext" : 1,
"backupCredentials" : {
"password" : "password",
"username" : "username"
},
"backupAccountName" : "backupAccountName",
"enabled" : true,
"scope" : 5,
"name" : "name",
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"customDN" : "customDN",
"id" : 0,
"fullBackup" : true
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ADBackupConfigurationUp
delete /api/v{version}/collectors/activedirectory/collectors/{id} (apiVversionCollectorsActivedirectoryCollectorsIdDelete)
Path parameters
id (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
get /api/v{version}/collectors/activedirectory/collectors/{id} (apiVversionCollectorsActivedirectoryCollectorsIdGet)
Path parameters
id (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Responses
200
SuccessUp
post /api/v{version}/collectors/activedirectory/collectors (apiVversionCollectorsActivedirectoryCollectorsPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body ADBackupConfiguration (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
put /api/v{version}/collectors/activedirectory/collectors (apiVversionCollectorsActivedirectoryCollectorsPut)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body ADBackupConfiguration (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
post /api/v{version}/collectors/activedirectory/collectors/search/domaincontrollers (apiVversionCollectorsActivedirectoryCollectorsSearchDomaincontrollersPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body DomainControllerSearch (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"lastActive" : "2000-01-23T04:56:07.000+00:00",
"statusMessage" : "statusMessage",
"enabled" : true,
"sid" : "sid",
"netBiosName" : "netBiosName",
"hasAgent" : true,
"osVersion" : "osVersion",
"domain" : "domain",
"name" : "name",
"agentVersion" : "agentVersion",
"id" : 6,
"upgradeRequired" : true,
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DomainControllerAttributeSearch
Up
get /api/v{version}/collectors/activedirectory/attributes/search/displaynames (apiVversionCollectorsActivedirectoryAttributesSearchDisplaynamesGet)
Path parameters
version (required)
Path Parameter —
Query parameters
limit (optional)
Query Parameter — default: 0 format: int32
displayname (optional)
Query Parameter —
Return type
array[String]
Example data
Content-Type: application/json
[ "", "" ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
get /api/v{version}/collectors/activedirectory/attributes/search (apiVversionCollectorsActivedirectoryAttributesSearchGet)
Path parameters
version (required)
Path Parameter —
Query parameters
limit (optional)
Query Parameter — format: int32
name (optional)
Query Parameter —
displayname (optional)
Query Parameter —
isClass (optional)
Query Parameter — default: false
Return type
array[ActiveDirectoryAttribute]
Example data
Content-Type: application/json
[ {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
}, {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
get /api/v{version}/collectors/activedirectory/attributes/search/names (apiVversionCollectorsActivedirectoryAttributesSearchNamesGet)
Path parameters
version (required)
Path Parameter —
Query parameters
limit (optional)
Query Parameter — default: 0 format: int32
name (optional)
Query Parameter —
Return type
array[String]
Example data
Content-Type: application/json
[ "", "" ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessAuditorService
Up
get /api/v{version}/system/config/service/all/status (apiVversionSystemConfigServiceAllStatusGet)
Path parameters
version (required)
Path Parameter —
Return type
array[CygnaAuditorService]
Example data
Content-Type: application/json
[ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"serviceDisplayName" : "serviceDisplayName",
"serviceName" : "serviceName",
"status" : 0
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"serviceDisplayName" : "serviceDisplayName",
"serviceName" : "serviceName",
"status" : 0
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
get /api/v{version}/system/config/service (apiVversionSystemConfigServiceGet)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"serviceSocket" : {
"encrypted" : true,
"port" : 6,
"serverAddress" : "serverAddress",
"type" : 0
},
"userCredentials" : {
"password" : "password",
"username" : "username"
},
"isRunAsLocalSystem" : true
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ServiceConfigurationWebUp
post /api/v{version}/system/config/service/{id}/restart (apiVversionSystemConfigServiceIdRestartPost)
Path parameters
id (required)
Path Parameter — format: uuid
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"serviceDisplayName" : "serviceDisplayName",
"serviceName" : "serviceName",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygnaAuditorServiceUp
post /api/v{version}/system/config/service/{id}/start (apiVversionSystemConfigServiceIdStartPost)
Path parameters
id (required)
Path Parameter — format: uuid
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"serviceDisplayName" : "serviceDisplayName",
"serviceName" : "serviceName",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygnaAuditorServiceUp
get /api/v{version}/system/config/service/{id}/status (apiVversionSystemConfigServiceIdStatusGet)
Path parameters
id (required)
Path Parameter — format: uuid
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"serviceDisplayName" : "serviceDisplayName",
"serviceName" : "serviceName",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygnaAuditorServiceUp
post /api/v{version}/system/config/service/{id}/stop (apiVversionSystemConfigServiceIdStopPost)
Path parameters
id (required)
Path Parameter — format: uuid
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"serviceDisplayName" : "serviceDisplayName",
"serviceName" : "serviceName",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygnaAuditorServiceUp
post /api/v{version}/system/config/service (apiVversionSystemConfigServicePost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body ServiceConfigurationWeb (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"serviceSocket" : {
"encrypted" : true,
"port" : 6,
"serverAddress" : "serverAddress",
"type" : 0
},
"userCredentials" : {
"password" : "password",
"username" : "username"
},
"isRunAsLocalSystem" : true
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ServiceConfigurationWebUp
put /api/v{version}/system/config/service (apiVversionSystemConfigServicePut)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body ServiceConfigurationWeb (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"serviceSocket" : {
"encrypted" : true,
"port" : 6,
"serverAddress" : "serverAddress",
"type" : 0
},
"userCredentials" : {
"password" : "password",
"username" : "username"
},
"isRunAsLocalSystem" : true
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ServiceConfigurationWebAuthorization
Up
post /api/v{version}/auth/login (apiVversionAuthLoginPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body UserProfile (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"password" : "password",
"displayName" : "displayName",
"userAccount" : "userAccount",
"userSid" : "userSid",
"userCid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"handle" : 3,
"userDomain" : "userDomain",
"userGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"user" : "user",
"config" : {
"applicationTheme" : "applicationTheme",
"consoleOptions" : "consoleOptions",
"applicationSettings" : {
"enableAutoSearch" : true,
"reportEventLimit" : 9,
"enableAuditPaging" : true,
"rollbackLayout" : [ null, null ],
"auditEventLimit" : 7,
"auditingLayout" : [ {
"isIntersecting" : true,
"hover" : {
"addAction" : 5,
"removeAction" : 2,
"field" : "field",
"position" : "position"
},
"visible" : true,
"sources" : [ 0, 0 ],
"isMetaEventColumn" : true,
"name" : "name",
"width" : {
"default" : 1,
"value" : 6,
"minimum" : 5
},
"header" : "header",
"position" : "position",
"type" : "type"
}, {
"isIntersecting" : true,
"hover" : {
"addAction" : 5,
"removeAction" : 2,
"field" : "field",
"position" : "position"
},
"visible" : true,
"sources" : [ 0, 0 ],
"isMetaEventColumn" : true,
"name" : "name",
"width" : {
"default" : 1,
"value" : 6,
"minimum" : 5
},
"header" : "header",
"position" : "position",
"type" : "type"
} ],
"isSideMenuExpanded" : true
}
},
"groupSids" : [ "groupSids", "groupSids" ],
"token" : "token"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success UserProfileUp
post /api/v{version}/auth/login/refresh (apiVversionAuthLoginRefreshPost)
Path parameters
version (required)
Path Parameter —
Return type
String
Example data
Content-Type: application/json
""Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success StringUp
get /api/v{version}/auth/logout (apiVversionAuthLogoutGet)
Path parameters
version (required)
Path Parameter —
Return type
Boolean
Example data
Content-Type: application/json
trueProduces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success BooleanAzure
Up
delete /api/v{version}/collectors/azure/globalRateLimiting (apiVversionCollectorsAzureGlobalRateLimitingDelete)
Path parameters
version (required)
Path Parameter —
Responses
200
SuccessUp
put /api/v{version}/collectors/azure/globalRateLimiting (apiVversionCollectorsAzureGlobalRateLimitingPut)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body RequestLock (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"maxLocks" : 0,
"enabled" : true
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success RequestLockUp
get /api/v{version}/collectors/azure/targets (apiVversionCollectorsAzureTargetsGet)
Path parameters
version (required)
Path Parameter —
Return type
array[Target]
Example data
Content-Type: application/json
[ {
"lastActive" : "2000-01-23T04:56:07.000+00:00",
"displayName" : "displayName",
"lastCollection" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"tenantCode" : "tenantCode",
"config" : {
"parallelResourceResolutionRequests" : 2,
"subscriptions" : [ "subscriptions", "subscriptions" ],
"subscriptionResourceTypes" : [ "subscriptionResourceTypes", "subscriptionResourceTypes" ],
"dataCollectionTimeout" : 1,
"collectResourceData" : true,
"collectAllSubscriptions" : true,
"tenantActivityCollection" : true,
"initialCollectionOffset" : 7,
"activityLogCollectionSkew" : 5,
"activityLogCollectionTimeout" : 5,
"tenantResourceTypes" : [ "tenantResourceTypes", "tenantResourceTypes" ],
"ignoredItems" : [ "ignoredItems", "ignoredItems" ],
"ignoredOperations" : [ "ignoredOperations", "ignoredOperations" ],
"ignoredStatuses" : [ "ignoredStatuses", "ignoredStatuses" ],
"resolveConfigurationObjects" : true
},
"collectionInterval" : 9,
"enabled" : true,
"status" : 6
}, {
"lastActive" : "2000-01-23T04:56:07.000+00:00",
"displayName" : "displayName",
"lastCollection" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"tenantCode" : "tenantCode",
"config" : {
"parallelResourceResolutionRequests" : 2,
"subscriptions" : [ "subscriptions", "subscriptions" ],
"subscriptionResourceTypes" : [ "subscriptionResourceTypes", "subscriptionResourceTypes" ],
"dataCollectionTimeout" : 1,
"collectResourceData" : true,
"collectAllSubscriptions" : true,
"tenantActivityCollection" : true,
"initialCollectionOffset" : 7,
"activityLogCollectionSkew" : 5,
"activityLogCollectionTimeout" : 5,
"tenantResourceTypes" : [ "tenantResourceTypes", "tenantResourceTypes" ],
"ignoredItems" : [ "ignoredItems", "ignoredItems" ],
"ignoredOperations" : [ "ignoredOperations", "ignoredOperations" ],
"ignoredStatuses" : [ "ignoredStatuses", "ignoredStatuses" ],
"resolveConfigurationObjects" : true
},
"collectionInterval" : 9,
"enabled" : true,
"status" : 6
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
delete /api/v{version}/collectors/azure/targets/{id} (apiVversionCollectorsAzureTargetsIdDelete)
Path parameters
id (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
get /api/v{version}/collectors/azure/targets/{id} (apiVversionCollectorsAzureTargetsIdGet)
Path parameters
id (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"lastActive" : "2000-01-23T04:56:07.000+00:00",
"displayName" : "displayName",
"lastCollection" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"tenantCode" : "tenantCode",
"config" : {
"parallelResourceResolutionRequests" : 2,
"subscriptions" : [ "subscriptions", "subscriptions" ],
"subscriptionResourceTypes" : [ "subscriptionResourceTypes", "subscriptionResourceTypes" ],
"dataCollectionTimeout" : 1,
"collectResourceData" : true,
"collectAllSubscriptions" : true,
"tenantActivityCollection" : true,
"initialCollectionOffset" : 7,
"activityLogCollectionSkew" : 5,
"activityLogCollectionTimeout" : 5,
"tenantResourceTypes" : [ "tenantResourceTypes", "tenantResourceTypes" ],
"ignoredItems" : [ "ignoredItems", "ignoredItems" ],
"ignoredOperations" : [ "ignoredOperations", "ignoredOperations" ],
"ignoredStatuses" : [ "ignoredStatuses", "ignoredStatuses" ],
"resolveConfigurationObjects" : true
},
"collectionInterval" : 9,
"enabled" : true,
"status" : 6
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success TargetUp
put /api/v{version}/collectors/azure/targets/{id} (apiVversionCollectorsAzureTargetsIdPut)
Path parameters
id (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body Target (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"lastActive" : "2000-01-23T04:56:07.000+00:00",
"displayName" : "displayName",
"lastCollection" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"tenantCode" : "tenantCode",
"config" : {
"parallelResourceResolutionRequests" : 2,
"subscriptions" : [ "subscriptions", "subscriptions" ],
"subscriptionResourceTypes" : [ "subscriptionResourceTypes", "subscriptionResourceTypes" ],
"dataCollectionTimeout" : 1,
"collectResourceData" : true,
"collectAllSubscriptions" : true,
"tenantActivityCollection" : true,
"initialCollectionOffset" : 7,
"activityLogCollectionSkew" : 5,
"activityLogCollectionTimeout" : 5,
"tenantResourceTypes" : [ "tenantResourceTypes", "tenantResourceTypes" ],
"ignoredItems" : [ "ignoredItems", "ignoredItems" ],
"ignoredOperations" : [ "ignoredOperations", "ignoredOperations" ],
"ignoredStatuses" : [ "ignoredStatuses", "ignoredStatuses" ],
"resolveConfigurationObjects" : true
},
"collectionInterval" : 9,
"enabled" : true,
"status" : 6
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success TargetUp
post /api/v{version}/collectors/azure/targets (apiVversionCollectorsAzureTargetsPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body CreateTarget (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"lastActive" : "2000-01-23T04:56:07.000+00:00",
"displayName" : "displayName",
"lastCollection" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"tenantCode" : "tenantCode",
"config" : {
"parallelResourceResolutionRequests" : 2,
"subscriptions" : [ "subscriptions", "subscriptions" ],
"subscriptionResourceTypes" : [ "subscriptionResourceTypes", "subscriptionResourceTypes" ],
"dataCollectionTimeout" : 1,
"collectResourceData" : true,
"collectAllSubscriptions" : true,
"tenantActivityCollection" : true,
"initialCollectionOffset" : 7,
"activityLogCollectionSkew" : 5,
"activityLogCollectionTimeout" : 5,
"tenantResourceTypes" : [ "tenantResourceTypes", "tenantResourceTypes" ],
"ignoredItems" : [ "ignoredItems", "ignoredItems" ],
"ignoredOperations" : [ "ignoredOperations", "ignoredOperations" ],
"ignoredStatuses" : [ "ignoredStatuses", "ignoredStatuses" ],
"resolveConfigurationObjects" : true
},
"collectionInterval" : 9,
"enabled" : true,
"status" : 6
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success TargetAzureBackup
Up
get /api/v{version}/collectors/azure/snapshotsRetrieve Azure Recovery object snapshots (apiVversionCollectorsAzureSnapshotsGet)
Path parameters
version (required)
Path Parameter —
Query parameters
guid (optional)
Query Parameter — Object GUID to use for filtering snapshots format: uuid
Return type
array[AzureSnapshot]
Example data
Content-Type: application/json
[ {
"snapshotBinary" : "",
"backupId" : 6,
"id" : 0,
"objectId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"snapshot" : "snapshot"
}, {
"snapshotBinary" : "",
"backupId" : 6,
"id" : 0,
"objectId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"snapshot" : "snapshot"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
A list of matching object snapshots410
No matching object snapshots were foundUp
get /api/v{version}/collectors/azure/snapshots/{snapshotId}Retrieve a single Azure Recovery object snapshot (apiVversionCollectorsAzureSnapshotsSnapshotIdGet)
Path parameters
snapshotId (required)
Path Parameter — Snapshot ID format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"snapshotBinary" : "",
"backupId" : 6,
"id" : 0,
"objectId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"snapshot" : "snapshot"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
A single Azure Recovery object snapshot AzureSnapshot410
Snapshot was not foundAzureObjects
Up
get /api/v{version}/collectors/azure/objects/{guid}Retrieve a single Azure Recovery object (apiVversionCollectorsAzureObjectsGuidGet)
Path parameters
guid (required)
Path Parameter — Azure object GUID format: uuid
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"deletedOn" : "2000-01-23T04:56:07.000+00:00",
"tenantId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type",
"createdOn" : "2000-01-23T04:56:07.000+00:00",
"userPrincipalName" : "userPrincipalName"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
A single Azure Recovery object Object410
Object was not foundBackup
Up
get /api/v{version}/collectors/activedirectory/backups/{backupId} (apiVversionCollectorsActivedirectoryBackupsBackupIdGet)
Path parameters
backupId (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"objectCount" : 6,
"id" : 0,
"source" : "source",
"when" : "2000-01-23T04:56:07.000+00:00"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CollectorBackupUp
get /api/v{version}/collectors/activedirectory/backups/{backupId}/snapshots (apiVversionCollectorsActivedirectoryBackupsBackupIdSnapshotsGet)
Path parameters
backupId (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Query parameters
objectGuid (optional)
Query Parameter — format: uuid
distinguishedName (optional)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"samType" : 1,
"encodedData" : "encodedData",
"adObject" : {
"displayName" : "displayName",
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"objectClass" : "objectClass",
"distinguishedName" : "distinguishedName",
"objectSid" : "objectSid",
"id" : 5
},
"domain" : "domain",
"encodedAttributeCount" : 6,
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"eventTime" : "2000-01-23T04:56:07.000+00:00",
"storageType" : 5,
"attributes" : [ {
"displayValue" : "displayValue",
"name" : "name",
"value" : ""
}, {
"displayValue" : "displayValue",
"name" : "name",
"value" : ""
} ],
"id" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ObjectSnapshotUp
get /api/v{version}/collectors/activedirectory/backups/{backupId}/snapshots/{snapshotId} (apiVversionCollectorsActivedirectoryBackupsBackupIdSnapshotsSnapshotIdGet)
Path parameters
backupId (required)
Path Parameter — format: int32
snapshotId (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"samType" : 1,
"encodedData" : "encodedData",
"adObject" : {
"displayName" : "displayName",
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"objectClass" : "objectClass",
"distinguishedName" : "distinguishedName",
"objectSid" : "objectSid",
"id" : 5
},
"domain" : "domain",
"encodedAttributeCount" : 6,
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"eventTime" : "2000-01-23T04:56:07.000+00:00",
"storageType" : 5,
"attributes" : [ {
"displayValue" : "displayValue",
"name" : "name",
"value" : ""
}, {
"displayValue" : "displayValue",
"name" : "name",
"value" : ""
} ],
"id" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ObjectSnapshotUp
get /api/v{version}/collectors/activedirectory/backups (apiVversionCollectorsActivedirectoryBackupsGet)
Path parameters
version (required)
Path Parameter —
Query parameters
objectGuid (optional)
Query Parameter — format: uuid
objectId (optional)
Query Parameter — format: int32
distinguishedName (optional)
Query Parameter —
limit (optional)
Query Parameter — default: 0 format: int32
maxDate (optional)
Query Parameter — format: date-time
Return type
array[CollectorBackup]
Example data
Content-Type: application/json
[ {
"objectCount" : 6,
"id" : 0,
"source" : "source",
"when" : "2000-01-23T04:56:07.000+00:00"
}, {
"objectCount" : 6,
"id" : 0,
"source" : "source",
"when" : "2000-01-23T04:56:07.000+00:00"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
get /api/v{version}/collectors/activedirectory/backups/snapshots (apiVversionCollectorsActivedirectoryBackupsSnapshotsGet)
Path parameters
version (required)
Path Parameter —
Query parameters
objectGuid (optional)
Query Parameter — format: uuid
objectId (optional)
Query Parameter — format: int32
limit (optional)
Query Parameter — default: 0 format: int32
maxDate (optional)
Query Parameter — format: date-time
includeObjectInfo (optional)
Query Parameter — default: false
Return type
array[ObjectSnapshot]
Example data
Content-Type: application/json
[ {
"samType" : 1,
"encodedData" : "encodedData",
"adObject" : {
"displayName" : "displayName",
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"objectClass" : "objectClass",
"distinguishedName" : "distinguishedName",
"objectSid" : "objectSid",
"id" : 5
},
"domain" : "domain",
"encodedAttributeCount" : 6,
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"eventTime" : "2000-01-23T04:56:07.000+00:00",
"storageType" : 5,
"attributes" : [ {
"displayValue" : "displayValue",
"name" : "name",
"value" : ""
}, {
"displayValue" : "displayValue",
"name" : "name",
"value" : ""
} ],
"id" : 0
}, {
"samType" : 1,
"encodedData" : "encodedData",
"adObject" : {
"displayName" : "displayName",
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"objectClass" : "objectClass",
"distinguishedName" : "distinguishedName",
"objectSid" : "objectSid",
"id" : 5
},
"domain" : "domain",
"encodedAttributeCount" : 6,
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"eventTime" : "2000-01-23T04:56:07.000+00:00",
"storageType" : 5,
"attributes" : [ {
"displayValue" : "displayValue",
"name" : "name",
"value" : ""
}, {
"displayValue" : "displayValue",
"name" : "name",
"value" : ""
} ],
"id" : 0
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
get /api/v{version}/collectors/activedirectory/backups/snapshots/gpodiff (apiVversionCollectorsActivedirectoryBackupsSnapshotsGpodiffGet)
Path parameters
version (required)
Path Parameter —
Query parameters
backupGuidLeft (optional)
Query Parameter — format: uuid
backupGuidRight (optional)
Query Parameter — format: uuid
Return type
array[GpoChange]
Example data
Content-Type: application/json
[ {
"explain" : "explain",
"newValue" : "newValue",
"name" : "name",
"attributeName" : "attributeName",
"state" : "state",
"oldValue" : "oldValue",
"category" : "category",
"supported" : "supported"
}, {
"explain" : "explain",
"newValue" : "newValue",
"name" : "name",
"attributeName" : "attributeName",
"state" : "state",
"oldValue" : "oldValue",
"category" : "category",
"supported" : "supported"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
get /api/v{version}/collectors/activedirectory/backups/snapshots/objects/time (apiVversionCollectorsActivedirectoryBackupsSnapshotsObjectsTimeGet)
Path parameters
version (required)
Path Parameter —
Query parameters
objectGuid (optional)
Query Parameter — format: uuid
time (optional)
Query Parameter — format: date-time
utc (optional)
Query Parameter — default: false
Return type
Example data
Content-Type: application/json
{
"samType" : 1,
"encodedData" : "encodedData",
"adObject" : {
"displayName" : "displayName",
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"objectClass" : "objectClass",
"distinguishedName" : "distinguishedName",
"objectSid" : "objectSid",
"id" : 5
},
"domain" : "domain",
"encodedAttributeCount" : 6,
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"eventTime" : "2000-01-23T04:56:07.000+00:00",
"storageType" : 5,
"attributes" : [ {
"displayValue" : "displayValue",
"name" : "name",
"value" : ""
}, {
"displayValue" : "displayValue",
"name" : "name",
"value" : ""
} ],
"id" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ObjectSnapshotUp
get /api/v{version}/collectors/activedirectory/backups/snapshots/{snapshotId} (apiVversionCollectorsActivedirectoryBackupsSnapshotsSnapshotIdGet)
Path parameters
snapshotId (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Query parameters
storageType (optional)
Query Parameter — 0 = Unknown, 1 = Active Directory, 2 = Group Policy Container, 3 = Max Value
Return type
Example data
Content-Type: application/json
{
"samType" : 1,
"encodedData" : "encodedData",
"adObject" : {
"displayName" : "displayName",
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"objectClass" : "objectClass",
"distinguishedName" : "distinguishedName",
"objectSid" : "objectSid",
"id" : 5
},
"domain" : "domain",
"encodedAttributeCount" : 6,
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"eventTime" : "2000-01-23T04:56:07.000+00:00",
"storageType" : 5,
"attributes" : [ {
"displayValue" : "displayValue",
"name" : "name",
"value" : ""
}, {
"displayValue" : "displayValue",
"name" : "name",
"value" : ""
} ],
"id" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ObjectSnapshotCharts
Up
get /api/v{version}/charts/builtin/{type} (apiVversionChartsBuiltinTypeGet)
Path parameters
type (required)
Path Parameter — 0 = Undefined, 1 = Events by Source, 2 = Top Users, 3 = Top Events, 4 = Events collected per day, 5 = Events per Minute, 6 = Top events per field
version (required)
Path Parameter —
Query parameters
offset (optional)
Query Parameter — format: int32
Return type
Example data
Content-Type: application/json
{
"instanceId" : 0,
"data" : "",
"subTitleFormat" : "subTitleFormat",
"name" : "name",
"chartType" : "chartType",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"parameters" : [ {
"hidden" : true,
"defaultValue" : "defaultValue",
"name" : "name",
"description" : "description",
"type" : "type",
"value" : "value"
}, {
"hidden" : true,
"defaultValue" : "defaultValue",
"name" : "name",
"description" : "description",
"type" : "type",
"value" : "value"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ChartCollectorStatusCheckConfiguration
Up
get /api/v{version}/system/config/collectorStatusCheck (apiVversionSystemConfigCollectorStatusCheckGet)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"excludedCollectors" : [ {
"configurationId" : 1,
"type" : "type"
}, {
"configurationId" : 1,
"type" : "type"
} ],
"interval" : 6,
"excludedStatuses" : [ "excludedStatuses", "excludedStatuses" ],
"state" : 5,
"version" : 5,
"directive" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CollectorStatusCheckConfigurationUp
put /api/v{version}/system/config/collectorStatusCheck (apiVversionSystemConfigCollectorStatusCheckPut)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body CollectorStatusCheckConfiguration (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"excludedCollectors" : [ {
"configurationId" : 1,
"type" : "type"
}, {
"configurationId" : 1,
"type" : "type"
} ],
"interval" : 6,
"excludedStatuses" : [ "excludedStatuses", "excludedStatuses" ],
"state" : 5,
"version" : 5,
"directive" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CollectorStatusCheckConfigurationConfigurationString
Up
post /api/v{version}/system/config/databases (apiVversionSystemConfigDatabasesPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body ConnectionString (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"databases" : [ "databases", "databases" ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DatabaseListDataPurge
Up
get /api/v{version}/datapurge/default (apiVversionDatapurgeDefaultGet)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"nextRunOn" : "2000-01-23T04:56:07.000+00:00",
"timingInfo" : {
"misfireRule" : 1,
"type" : 6,
"priority" : 5,
"effectiveDates" : {
"endAt" : "2000-01-23T04:56:07.000+00:00",
"startAt" : "2000-01-23T04:56:07.000+00:00"
}
},
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isEnabled" : true,
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"state" : 5,
"type" : 0,
"jobInfo" : { },
"lastRunOn" : "2000-01-23T04:56:07.000+00:00"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ScheduledJobWebUp
delete /api/v{version}/datapurge (apiVversionDatapurgeDelete)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
get /api/v{version}/datapurge (apiVversionDatapurgeGet)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"nextRunOn" : "2000-01-23T04:56:07.000+00:00",
"timingInfo" : {
"misfireRule" : 1,
"type" : 6,
"priority" : 5,
"effectiveDates" : {
"endAt" : "2000-01-23T04:56:07.000+00:00",
"startAt" : "2000-01-23T04:56:07.000+00:00"
}
},
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isEnabled" : true,
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"state" : 5,
"type" : 0,
"jobInfo" : { },
"lastRunOn" : "2000-01-23T04:56:07.000+00:00"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ScheduledJobWebUp
post /api/v{version}/datapurge (apiVversionDatapurgePost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body ScheduledJobWeb (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"nextRunOn" : "2000-01-23T04:56:07.000+00:00",
"timingInfo" : {
"misfireRule" : 1,
"type" : 6,
"priority" : 5,
"effectiveDates" : {
"endAt" : "2000-01-23T04:56:07.000+00:00",
"startAt" : "2000-01-23T04:56:07.000+00:00"
}
},
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isEnabled" : true,
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"state" : 5,
"type" : 0,
"jobInfo" : { },
"lastRunOn" : "2000-01-23T04:56:07.000+00:00"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ScheduledJobWebUp
put /api/v{version}/datapurge (apiVversionDatapurgePut)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body ScheduledJobWeb (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"nextRunOn" : "2000-01-23T04:56:07.000+00:00",
"timingInfo" : {
"misfireRule" : 1,
"type" : 6,
"priority" : 5,
"effectiveDates" : {
"endAt" : "2000-01-23T04:56:07.000+00:00",
"startAt" : "2000-01-23T04:56:07.000+00:00"
}
},
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isEnabled" : true,
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"state" : 5,
"type" : 0,
"jobInfo" : { },
"lastRunOn" : "2000-01-23T04:56:07.000+00:00"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ScheduledJobWebDatabase
Up
post /api/v{version}/setup/database/catalog (apiVversionSetupDatabaseCatalogPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body DatabaseSetup (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"connectionString" : {
"initialCatalog" : "initialCatalog",
"credentials" : {
"password" : "password",
"username" : "username"
},
"useWindowsAuth" : true,
"connectRetryCount" : 6,
"connectRetryInterval" : 1,
"dataSource" : "dataSource",
"connectionTimeout" : 0
},
"versionComparison" : {
"requiredVersion" : {
"appliedTime" : "2000-01-23T04:56:07.000+00:00",
"build" : "build",
"sqlSchema" : "sqlSchema"
}
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DatabaseInfoUp
put /api/v{version}/setup/database/catalog (apiVversionSetupDatabaseCatalogPut)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body DatabaseSetup (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"connectionString" : {
"initialCatalog" : "initialCatalog",
"credentials" : {
"password" : "password",
"username" : "username"
},
"useWindowsAuth" : true,
"connectRetryCount" : 6,
"connectRetryInterval" : 1,
"dataSource" : "dataSource",
"connectionTimeout" : 0
},
"versionComparison" : {
"requiredVersion" : {
"appliedTime" : "2000-01-23T04:56:07.000+00:00",
"build" : "build",
"sqlSchema" : "sqlSchema"
}
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DatabaseInfoUp
get /api/v{version}/setup/database/connection (apiVversionSetupDatabaseConnectionGet)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"initialCatalog" : "initialCatalog",
"credentials" : {
"password" : "password",
"username" : "username"
},
"useWindowsAuth" : true,
"connectRetryCount" : 6,
"connectRetryInterval" : 1,
"dataSource" : "dataSource",
"connectionTimeout" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ConnectionStringUp
post /api/v{version}/setup/database/connection (apiVversionSetupDatabaseConnectionPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body DatabaseSetup (optional)
Body Parameter —
Responses
200
SuccessUp
post /api/v{version}/setup/database/connection/test (apiVversionSetupDatabaseConnectionTestPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body DatabaseSetup (optional)
Body Parameter —
Responses
200
SuccessUp
post /api/v{version}/setup/database/search/catalogs (apiVversionSetupDatabaseSearchCatalogsPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body ConnectionString (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"databases" : [ "databases", "databases" ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DatabaseListUp
get /api/v{version}/setup/database/search/servers (apiVversionSetupDatabaseSearchServersGet)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"servers" : [ "servers", "servers" ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ServerListUp
post /api/v{version}/setup/database/version (apiVversionSetupDatabaseVersionPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body ConnectionString (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"requiredVersion" : {
"appliedTime" : "2000-01-23T04:56:07.000+00:00",
"build" : "build",
"sqlSchema" : "sqlSchema"
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DatabaseVersionCompareDatabaseConnector
Up
post /api/v{version}/database/connectors/catalogs (apiVversionDatabaseConnectorsCatalogsPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body DelegatedDatabaseConnector (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"databases" : [ "databases", "databases" ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DatabaseListUp
get /api/v{version}/database/connectors (apiVversionDatabaseConnectorsGet)
Path parameters
version (required)
Path Parameter —
Query parameters
isCoreConnectionToBeIncluded (optional)
Query Parameter — default: true
Return type
array[DelegatedDatabaseConnector]
Example data
Content-Type: application/json
[ {
"connectionString" : "connectionString",
"isReadOnly" : true,
"delegatedResources" : [ {
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
}, {
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
} ],
"configuration" : {
"initialCatalog" : "initialCatalog",
"credentials" : {
"password" : "password",
"username" : "username"
},
"useWindowsAuth" : true,
"connectRetryCount" : 6,
"connectRetryInterval" : 1,
"dataSource" : "dataSource",
"connectionTimeout" : 0
},
"isEnabled" : true,
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"designation" : 6,
"type" : 0
}, {
"connectionString" : "connectionString",
"isReadOnly" : true,
"delegatedResources" : [ {
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
}, {
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
} ],
"configuration" : {
"initialCatalog" : "initialCatalog",
"credentials" : {
"password" : "password",
"username" : "username"
},
"useWindowsAuth" : true,
"connectRetryCount" : 6,
"connectRetryInterval" : 1,
"dataSource" : "dataSource",
"connectionTimeout" : 0
},
"isEnabled" : true,
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"designation" : 6,
"type" : 0
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
delete /api/v{version}/database/connectors/{id} (apiVversionDatabaseConnectorsIdDelete)
Path parameters
id (required)
Path Parameter — format: uuid
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
get /api/v{version}/database/connectors/{id} (apiVversionDatabaseConnectorsIdGet)
Path parameters
id (required)
Path Parameter — format: uuid
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"connectionString" : "connectionString",
"isReadOnly" : true,
"delegatedResources" : [ {
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
}, {
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
} ],
"configuration" : {
"initialCatalog" : "initialCatalog",
"credentials" : {
"password" : "password",
"username" : "username"
},
"useWindowsAuth" : true,
"connectRetryCount" : 6,
"connectRetryInterval" : 1,
"dataSource" : "dataSource",
"connectionTimeout" : 0
},
"isEnabled" : true,
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"designation" : 6,
"type" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DelegatedDatabaseConnectorUp
put /api/v{version}/database/connectors/{id} (apiVversionDatabaseConnectorsIdPut)
Path parameters
id (required)
Path Parameter — format: uuid
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body DelegatedDatabaseConnector (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"connectionString" : "connectionString",
"isReadOnly" : true,
"delegatedResources" : [ {
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
}, {
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
} ],
"configuration" : {
"initialCatalog" : "initialCatalog",
"credentials" : {
"password" : "password",
"username" : "username"
},
"useWindowsAuth" : true,
"connectRetryCount" : 6,
"connectRetryInterval" : 1,
"dataSource" : "dataSource",
"connectionTimeout" : 0
},
"isEnabled" : true,
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"designation" : 6,
"type" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DelegatedDatabaseConnectorUp
post /api/v{version}/database/connectors/migrate (apiVversionDatabaseConnectorsMigratePost)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"connectionString" : "connectionString",
"isReadOnly" : true,
"delegatedResources" : [ {
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
}, {
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
} ],
"configuration" : {
"initialCatalog" : "initialCatalog",
"credentials" : {
"password" : "password",
"username" : "username"
},
"useWindowsAuth" : true,
"connectRetryCount" : 6,
"connectRetryInterval" : 1,
"dataSource" : "dataSource",
"connectionTimeout" : 0
},
"isEnabled" : true,
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"designation" : 6,
"type" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DelegatedDatabaseConnectorUp
post /api/v{version}/database/connectors (apiVversionDatabaseConnectorsPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body DelegatedDatabaseConnector (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"connectionString" : "connectionString",
"isReadOnly" : true,
"delegatedResources" : [ {
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
}, {
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
} ],
"configuration" : {
"initialCatalog" : "initialCatalog",
"credentials" : {
"password" : "password",
"username" : "username"
},
"useWindowsAuth" : true,
"connectRetryCount" : 6,
"connectRetryInterval" : 1,
"dataSource" : "dataSource",
"connectionTimeout" : 0
},
"isEnabled" : true,
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"designation" : 6,
"type" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DelegatedDatabaseConnectorUp
post /api/v{version}/database/connectors/validate (apiVversionDatabaseConnectorsValidatePost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body DelegatedDatabaseConnector (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseDelegatedResource
Up
get /api/v{version}/delegatedresources (apiVversionDelegatedresourcesGet)
Path parameters
version (required)
Path Parameter —
Query parameters
type (optional)
Query Parameter — 0 = Undefined, 1 = Report, 2 = Report Tag, 3 = Report Type, 4 = Scheduled Job, 5 = Scheduled Job Tag, 6 = Scheduled Job Type, 7 = Database Connector
resourceId (optional)
Query Parameter —
Return type
array[DelegatedResourceX]
Example data
Content-Type: application/json
[ {
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
}, {
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
delete /api/v{version}/delegatedresources/{id} (apiVversionDelegatedresourcesIdDelete)
Path parameters
id (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
get /api/v{version}/delegatedresources/{id} (apiVversionDelegatedresourcesIdGet)
Path parameters
id (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DelegatedResourceXUp
put /api/v{version}/delegatedresources/{id} (apiVversionDelegatedresourcesIdPut)
Path parameters
id (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body DelegatedResourceX (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DelegatedResourceXUp
post /api/v{version}/delegatedresources (apiVversionDelegatedresourcesPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body DelegatedResourceX (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DelegatedResourceXDirectoryObject
Up
get /api/v{version}/collectors/activedirectory/objects/attributes (apiVversionCollectorsActivedirectoryObjectsAttributesGet)
Path parameters
version (required)
Path Parameter —
Query parameters
domain (optional)
Query Parameter —
objectGuid (optional)
Query Parameter — format: uuid
Return type
Example data
Content-Type: application/json
{
"name" : "name",
"value" : ""
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ActiveDirectoryAttributeDataUp
get /api/v{version}/collectors/activedirectory/objects/browse (apiVversionCollectorsActivedirectoryObjectsBrowseGet)
Path parameters
version (required)
Path Parameter —
Query parameters
type (optional)
Query Parameter —
domain (optional)
Query Parameter — default: 1 format: int32
domainName (optional)
Query Parameter —
limit (optional)
Query Parameter — default: 0 format: int32
objectDN (optional)
Query Parameter — default: *
objectGuid (optional)
Query Parameter — format: uuid
namingContext (optional)
Query Parameter — 0 = Default, 1 = Configuration, 2 = Schema, 3 = RootDSE, 4 = Custom
advanced (optional)
Query Parameter — default: false
Return type
Example data
Content-Type: application/json
{
"msdsPrincipalName" : "msdsPrincipalName",
"presentationName" : "presentationName",
"displayName" : "displayName",
"accountExpires" : 1,
"objectClass" : "objectClass",
"samAccountName" : "samAccountName",
"dnsName" : "dnsName",
"description" : "description",
"dn" : "dn",
"cn" : "cn",
"ldapName" : "ldapName",
"managerEmail" : "managerEmail",
"rawValues" : {
"key" : [ "", "" ]
},
"domain" : "domain",
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"name" : "name",
"objectSid" : "objectSid",
"attributes" : [ {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
}, {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
} ],
"userPrincipalName" : "userPrincipalName",
"userAccountControl" : 0,
"pwdLastSet" : 6
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ActiveDirectoryObjectUp
get /api/v{version}/collectors/activedirectory/objects (apiVversionCollectorsActivedirectoryObjectsGet)
Path parameters
version (required)
Path Parameter —
Query parameters
search (optional)
Query Parameter —
limit (optional)
Query Parameter — default: 50 format: int32
objectClass (optional)
Query Parameter — default: *
objectGuid (optional)
Query Parameter — format: uuid
deletedFlag (optional)
Query Parameter — default: 0 format: int32
Return type
Example data
Content-Type: application/json
{
"msdsPrincipalName" : "msdsPrincipalName",
"presentationName" : "presentationName",
"displayName" : "displayName",
"accountExpires" : 1,
"objectClass" : "objectClass",
"samAccountName" : "samAccountName",
"dnsName" : "dnsName",
"description" : "description",
"dn" : "dn",
"cn" : "cn",
"ldapName" : "ldapName",
"managerEmail" : "managerEmail",
"rawValues" : {
"key" : [ "", "" ]
},
"domain" : "domain",
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"name" : "name",
"objectSid" : "objectSid",
"attributes" : [ {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
}, {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
} ],
"userPrincipalName" : "userPrincipalName",
"userAccountControl" : 0,
"pwdLastSet" : 6
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ActiveDirectoryObjectUp
get /api/v{version}/collectors/activedirectory/objects/members (apiVversionCollectorsActivedirectoryObjectsMembersGet)
Path parameters
version (required)
Path Parameter —
Query parameters
domain (optional)
Query Parameter —
objectGuid (optional)
Query Parameter — format: uuid
expanded (optional)
Query Parameter — default: false
Return type
Example data
Content-Type: application/json
{
"msdsPrincipalName" : "msdsPrincipalName",
"presentationName" : "presentationName",
"displayName" : "displayName",
"accountExpires" : 1,
"objectClass" : "objectClass",
"samAccountName" : "samAccountName",
"dnsName" : "dnsName",
"description" : "description",
"dn" : "dn",
"cn" : "cn",
"ldapName" : "ldapName",
"managerEmail" : "managerEmail",
"rawValues" : {
"key" : [ "", "" ]
},
"domain" : "domain",
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"name" : "name",
"objectSid" : "objectSid",
"attributes" : [ {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
}, {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
} ],
"userPrincipalName" : "userPrincipalName",
"userAccountControl" : 0,
"pwdLastSet" : 6
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ActiveDirectoryObjectUp
get /api/v{version}/collectors/activedirectory/objects/membership (apiVversionCollectorsActivedirectoryObjectsMembershipGet)
Path parameters
version (required)
Path Parameter —
Query parameters
domain (optional)
Query Parameter —
objectGuid (optional)
Query Parameter — format: uuid
expanded (optional)
Query Parameter — default: false
Return type
Example data
Content-Type: application/json
{
"msdsPrincipalName" : "msdsPrincipalName",
"presentationName" : "presentationName",
"displayName" : "displayName",
"accountExpires" : 1,
"objectClass" : "objectClass",
"samAccountName" : "samAccountName",
"dnsName" : "dnsName",
"description" : "description",
"dn" : "dn",
"cn" : "cn",
"ldapName" : "ldapName",
"managerEmail" : "managerEmail",
"rawValues" : {
"key" : [ "", "" ]
},
"domain" : "domain",
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"name" : "name",
"objectSid" : "objectSid",
"attributes" : [ {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
}, {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
} ],
"userPrincipalName" : "userPrincipalName",
"userAccountControl" : 0,
"pwdLastSet" : 6
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ActiveDirectoryObjectUp
get /api/v{version}/collectors/activedirectory/objects/{objectId} (apiVversionCollectorsActivedirectoryObjectsObjectIdGet)
Path parameters
objectId (required)
Path Parameter — format: uuid
version (required)
Path Parameter —
Query parameters
distinguishedName (optional)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"msdsPrincipalName" : "msdsPrincipalName",
"presentationName" : "presentationName",
"displayName" : "displayName",
"accountExpires" : 1,
"objectClass" : "objectClass",
"samAccountName" : "samAccountName",
"dnsName" : "dnsName",
"description" : "description",
"dn" : "dn",
"cn" : "cn",
"ldapName" : "ldapName",
"managerEmail" : "managerEmail",
"rawValues" : {
"key" : [ "", "" ]
},
"domain" : "domain",
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"name" : "name",
"objectSid" : "objectSid",
"attributes" : [ {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
}, {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
} ],
"userPrincipalName" : "userPrincipalName",
"userAccountControl" : 0,
"pwdLastSet" : 6
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ActiveDirectoryObjectUp
get /api/v{version}/collectors/activedirectory/objects/search (apiVversionCollectorsActivedirectoryObjectsSearchGet)
Path parameters
version (required)
Path Parameter —
Query parameters
search (optional)
Query Parameter —
limit (optional)
Query Parameter — default: 50 format: int32
objectClass (optional)
Query Parameter — default: *
objectGuid (optional)
Query Parameter — format: uuid
deletedFlag (optional)
Query Parameter — default: 0 format: int32
Return type
Example data
Content-Type: application/json
{
"msdsPrincipalName" : "msdsPrincipalName",
"presentationName" : "presentationName",
"displayName" : "displayName",
"accountExpires" : 1,
"objectClass" : "objectClass",
"samAccountName" : "samAccountName",
"dnsName" : "dnsName",
"description" : "description",
"dn" : "dn",
"cn" : "cn",
"ldapName" : "ldapName",
"managerEmail" : "managerEmail",
"rawValues" : {
"key" : [ "", "" ]
},
"domain" : "domain",
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"name" : "name",
"objectSid" : "objectSid",
"attributes" : [ {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
}, {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
} ],
"userPrincipalName" : "userPrincipalName",
"userAccountControl" : 0,
"pwdLastSet" : 6
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ActiveDirectoryObjectUp
get /api/v{version}/collectors/activedirectory/objects/security (apiVversionCollectorsActivedirectoryObjectsSecurityGet)
Path parameters
version (required)
Path Parameter —
Query parameters
domain (optional)
Query Parameter —
objectGuid (optional)
Query Parameter — format: uuid
Return type
Example data
Content-Type: application/json
{
"discretionaryAccessControlList" : [ {
"inheritedTypeGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"aceMask" : "aceMask",
"objectAce" : true,
"aceFlags" : "aceFlags",
"accessMask" : 6,
"objectTypeGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritedType" : "inheritedType",
"type" : "type",
"account" : "account",
"sid" : {
"binaryLength" : 0,
"value" : "value"
},
"objectType" : "objectType"
}, {
"inheritedTypeGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"aceMask" : "aceMask",
"objectAce" : true,
"aceFlags" : "aceFlags",
"accessMask" : 6,
"objectTypeGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritedType" : "inheritedType",
"type" : "type",
"account" : "account",
"sid" : {
"binaryLength" : 0,
"value" : "value"
},
"objectType" : "objectType"
} ],
"saclPresent" : true,
"daclPresent" : true,
"systemAccessControlList" : [ null, null ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ActiveDirectorySecurityDescriptorUp
get /api/v{version}/collectors/activedirectory/search (apiVversionCollectorsActivedirectorySearchGet)
Path parameters
version (required)
Path Parameter —
Query parameters
searchString (optional)
Query Parameter —
objectType (optional)
Query Parameter — 1 = Local Users, 2 = Local Groups, 4 = Domain Users, 8 = Domain Groups, 16 = Computers, 32 = Domain Controllers, 64 = Exchange Servers, 128 = Sql Servers, 256 = Containers, 512 = Organizational Units
domainId (optional)
Query Parameter — format: int32
limit (optional)
Query Parameter — default: 50 format: int32
Return type
array[ActiveDirectoryObject]
Example data
Content-Type: application/json
[ {
"msdsPrincipalName" : "msdsPrincipalName",
"presentationName" : "presentationName",
"displayName" : "displayName",
"accountExpires" : 1,
"objectClass" : "objectClass",
"samAccountName" : "samAccountName",
"dnsName" : "dnsName",
"description" : "description",
"dn" : "dn",
"cn" : "cn",
"ldapName" : "ldapName",
"managerEmail" : "managerEmail",
"rawValues" : {
"key" : [ "", "" ]
},
"domain" : "domain",
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"name" : "name",
"objectSid" : "objectSid",
"attributes" : [ {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
}, {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
} ],
"userPrincipalName" : "userPrincipalName",
"userAccountControl" : 0,
"pwdLastSet" : 6
}, {
"msdsPrincipalName" : "msdsPrincipalName",
"presentationName" : "presentationName",
"displayName" : "displayName",
"accountExpires" : 1,
"objectClass" : "objectClass",
"samAccountName" : "samAccountName",
"dnsName" : "dnsName",
"description" : "description",
"dn" : "dn",
"cn" : "cn",
"ldapName" : "ldapName",
"managerEmail" : "managerEmail",
"rawValues" : {
"key" : [ "", "" ]
},
"domain" : "domain",
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"name" : "name",
"objectSid" : "objectSid",
"attributes" : [ {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
}, {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
} ],
"userPrincipalName" : "userPrincipalName",
"userAccountControl" : 0,
"pwdLastSet" : 6
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessDomains
Up
post /api/v{version}/collectors/activedirectory/domains/configuration/export/{domainId} (apiVversionCollectorsActivedirectoryDomainsConfigurationExportDomainIdPost)
Path parameters
domainId (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
byte[]
Example data
Content-Type: application/json
""Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success byte[]Up
post /api/v{version}/collectors/activedirectory/domains/controllers/search (apiVversionCollectorsActivedirectoryDomainsControllersSearchPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body DomainSearch (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"lastActive" : "2000-01-23T04:56:07.000+00:00",
"statusMessage" : "statusMessage",
"enabled" : true,
"sid" : "sid",
"netBiosName" : "netBiosName",
"hasAgent" : true,
"osVersion" : "osVersion",
"domain" : "domain",
"name" : "name",
"agentVersion" : "agentVersion",
"id" : 6,
"upgradeRequired" : true,
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DomainControllerUp
get /api/v{version}/collectors/activedirectory/domains (apiVversionCollectorsActivedirectoryDomainsGet)
Path parameters
version (required)
Path Parameter —
Query parameters
isDCListToBeIncluded (optional)
Query Parameter — default: false
hideDisabled (optional)
Query Parameter — default: true
Return type
Example data
Content-Type: application/json
{
"accountName" : "accountName",
"backupPassword" : "backupPassword",
"flags" : 1,
"dnsName" : "dnsName",
"domainControllers" : [ {
"lastActive" : "2000-01-23T04:56:07.000+00:00",
"statusMessage" : "statusMessage",
"enabled" : true,
"sid" : "sid",
"netBiosName" : "netBiosName",
"hasAgent" : true,
"osVersion" : "osVersion",
"domain" : "domain",
"name" : "name",
"agentVersion" : "agentVersion",
"id" : 6,
"upgradeRequired" : true,
"status" : 0
}, {
"lastActive" : "2000-01-23T04:56:07.000+00:00",
"statusMessage" : "statusMessage",
"enabled" : true,
"sid" : "sid",
"netBiosName" : "netBiosName",
"hasAgent" : true,
"osVersion" : "osVersion",
"domain" : "domain",
"name" : "name",
"agentVersion" : "agentVersion",
"id" : 6,
"upgradeRequired" : true,
"status" : 0
} ],
"backupAccountName" : "backupAccountName",
"ncName" : "ncName",
"enabled" : true,
"parentDomain" : "parentDomain",
"dcAccountName" : "dcAccountName",
"dcPassword" : "dcPassword",
"password" : "password",
"statusDescription" : "statusDescription",
"netBiosName" : "netBiosName",
"localDcCollection" : true,
"agentConfiguration" : {
"processNestedGroupUserMembers" : true,
"processNestedGroupMembers" : true,
"suppressNestedGroupEventData" : true,
"enableGPOBackup" : true,
"combineEventsDelay" : 5,
"enableMissingGPOBackup" : true,
"ignoreLogonEvents" : true,
"workstationResolution" : true,
"combineEventsEnabled" : true,
"suppressNestedGroupEventBacklinks" : true,
"processNestedGroupUsers" : true,
"workstationReverseLookup" : true,
"nestedGroups" : [ {
"msdsPrincipalName" : "msdsPrincipalName",
"presentationName" : "presentationName",
"displayName" : "displayName",
"accountExpires" : 3,
"objectClass" : "objectClass",
"samAccountName" : "samAccountName",
"dnsName" : "dnsName",
"description" : "description",
"dn" : "dn",
"cn" : "cn",
"ldapName" : "ldapName",
"managerEmail" : "managerEmail",
"domain" : "domain",
"objectGuid" : "objectGuid",
"name" : "name",
"objectSid" : "objectSid",
"attributes" : [ {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
}, {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
} ],
"userPrincipalName" : "userPrincipalName",
"userAccountControl" : 7,
"pwdLastSet" : 9
}, {
"msdsPrincipalName" : "msdsPrincipalName",
"presentationName" : "presentationName",
"displayName" : "displayName",
"accountExpires" : 3,
"objectClass" : "objectClass",
"samAccountName" : "samAccountName",
"dnsName" : "dnsName",
"description" : "description",
"dn" : "dn",
"cn" : "cn",
"ldapName" : "ldapName",
"managerEmail" : "managerEmail",
"domain" : "domain",
"objectGuid" : "objectGuid",
"name" : "name",
"objectSid" : "objectSid",
"attributes" : [ {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
}, {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
} ],
"userPrincipalName" : "userPrincipalName",
"userAccountControl" : 7,
"pwdLastSet" : 9
} ],
"logLevel" : 2,
"processNestedGroups" : true,
"excludedAttributes" : "excludedAttributes",
"ldapTimeout" : 2
},
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"id" : 0,
"collectionInterval" : 6,
"status" : 5
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DomainConfigurationUp
delete /api/v{version}/collectors/activedirectory/domains/{id}/controllers/all (apiVversionCollectorsActivedirectoryDomainsIdControllersAllDelete)
Path parameters
Id (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
delete /api/v{version}/collectors/activedirectory/domains/{id}/controllers/{dcid} (apiVversionCollectorsActivedirectoryDomainsIdControllersDcidDelete)
Path parameters
Id (required)
Path Parameter — format: int32
DcId (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
post /api/v{version}/collectors/activedirectory/domains/{id}/controllers/{dcid}/restart (apiVversionCollectorsActivedirectoryDomainsIdControllersDcidRestartPost)
Path parameters
id (required)
Path Parameter — format: int32
dcId (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"lastActive" : "2000-01-23T04:56:07.000+00:00",
"statusMessage" : "statusMessage",
"enabled" : true,
"sid" : "sid",
"netBiosName" : "netBiosName",
"hasAgent" : true,
"osVersion" : "osVersion",
"domain" : "domain",
"name" : "name",
"agentVersion" : "agentVersion",
"id" : 6,
"upgradeRequired" : true,
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DomainControllerUp
post /api/v{version}/collectors/activedirectory/domains/{id}/controllers/{dcid}/start (apiVversionCollectorsActivedirectoryDomainsIdControllersDcidStartPost)
Path parameters
id (required)
Path Parameter — format: int32
dcId (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"lastActive" : "2000-01-23T04:56:07.000+00:00",
"statusMessage" : "statusMessage",
"enabled" : true,
"sid" : "sid",
"netBiosName" : "netBiosName",
"hasAgent" : true,
"osVersion" : "osVersion",
"domain" : "domain",
"name" : "name",
"agentVersion" : "agentVersion",
"id" : 6,
"upgradeRequired" : true,
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DomainControllerUp
post /api/v{version}/collectors/activedirectory/domains/{id}/controllers/{dcid}/stop (apiVversionCollectorsActivedirectoryDomainsIdControllersDcidStopPost)
Path parameters
id (required)
Path Parameter — format: int32
dcId (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"lastActive" : "2000-01-23T04:56:07.000+00:00",
"statusMessage" : "statusMessage",
"enabled" : true,
"sid" : "sid",
"netBiosName" : "netBiosName",
"hasAgent" : true,
"osVersion" : "osVersion",
"domain" : "domain",
"name" : "name",
"agentVersion" : "agentVersion",
"id" : 6,
"upgradeRequired" : true,
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DomainControllerUp
delete /api/v{version}/collectors/activedirectory/domains/{id}/controllers (apiVversionCollectorsActivedirectoryDomainsIdControllersDelete)
Path parameters
Id (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Query parameters
dcIds (optional)
Query Parameter — format: int32
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
get /api/v{version}/collectors/activedirectory/domains/{id}/controllers (apiVversionCollectorsActivedirectoryDomainsIdControllersGet)
Path parameters
id (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"lastActive" : "2000-01-23T04:56:07.000+00:00",
"statusMessage" : "statusMessage",
"enabled" : true,
"sid" : "sid",
"netBiosName" : "netBiosName",
"hasAgent" : true,
"osVersion" : "osVersion",
"domain" : "domain",
"name" : "name",
"agentVersion" : "agentVersion",
"id" : 6,
"upgradeRequired" : true,
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DomainControllerUp
post /api/v{version}/collectors/activedirectory/domains/{id}/controllers (apiVversionCollectorsActivedirectoryDomainsIdControllersPost)
Path parameters
Id (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body DomainController (optional)
Body Parameter —
Query parameters
force (optional)
Query Parameter — default: false
Return type
Example data
Content-Type: application/json
{
"lastActive" : "2000-01-23T04:56:07.000+00:00",
"statusMessage" : "statusMessage",
"enabled" : true,
"sid" : "sid",
"netBiosName" : "netBiosName",
"hasAgent" : true,
"osVersion" : "osVersion",
"domain" : "domain",
"name" : "name",
"agentVersion" : "agentVersion",
"id" : 6,
"upgradeRequired" : true,
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DomainControllerUp
put /api/v{version}/collectors/activedirectory/domains/{id}/controllers (apiVversionCollectorsActivedirectoryDomainsIdControllersPut)
Path parameters
Id (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body DomainController (optional)
Body Parameter —
Query parameters
force (optional)
Query Parameter — default: false
Return type
Example data
Content-Type: application/json
{
"lastActive" : "2000-01-23T04:56:07.000+00:00",
"statusMessage" : "statusMessage",
"enabled" : true,
"sid" : "sid",
"netBiosName" : "netBiosName",
"hasAgent" : true,
"osVersion" : "osVersion",
"domain" : "domain",
"name" : "name",
"agentVersion" : "agentVersion",
"id" : 6,
"upgradeRequired" : true,
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DomainControllerUp
delete /api/v{version}/collectors/activedirectory/domains/{id} (apiVversionCollectorsActivedirectoryDomainsIdDelete)
Path parameters
Id (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
get /api/v{version}/collectors/activedirectory/domains/{id} (apiVversionCollectorsActivedirectoryDomainsIdGet)
Path parameters
id (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Query parameters
isDCListToBeIncluded (optional)
Query Parameter — default: true
Return type
Example data
Content-Type: application/json
{
"systemAttributes" : [ "systemAttributes", "systemAttributes" ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ActiveDirectoryProfileUp
put /api/v{version}/collectors/activedirectory/domains/{id} (apiVversionCollectorsActivedirectoryDomainsIdPut)
Path parameters
id (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body DomainConfiguration (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"accountName" : "accountName",
"backupPassword" : "backupPassword",
"flags" : 1,
"dnsName" : "dnsName",
"domainControllers" : [ {
"lastActive" : "2000-01-23T04:56:07.000+00:00",
"statusMessage" : "statusMessage",
"enabled" : true,
"sid" : "sid",
"netBiosName" : "netBiosName",
"hasAgent" : true,
"osVersion" : "osVersion",
"domain" : "domain",
"name" : "name",
"agentVersion" : "agentVersion",
"id" : 6,
"upgradeRequired" : true,
"status" : 0
}, {
"lastActive" : "2000-01-23T04:56:07.000+00:00",
"statusMessage" : "statusMessage",
"enabled" : true,
"sid" : "sid",
"netBiosName" : "netBiosName",
"hasAgent" : true,
"osVersion" : "osVersion",
"domain" : "domain",
"name" : "name",
"agentVersion" : "agentVersion",
"id" : 6,
"upgradeRequired" : true,
"status" : 0
} ],
"backupAccountName" : "backupAccountName",
"ncName" : "ncName",
"enabled" : true,
"parentDomain" : "parentDomain",
"dcAccountName" : "dcAccountName",
"dcPassword" : "dcPassword",
"password" : "password",
"statusDescription" : "statusDescription",
"netBiosName" : "netBiosName",
"localDcCollection" : true,
"agentConfiguration" : {
"processNestedGroupUserMembers" : true,
"processNestedGroupMembers" : true,
"suppressNestedGroupEventData" : true,
"enableGPOBackup" : true,
"combineEventsDelay" : 5,
"enableMissingGPOBackup" : true,
"ignoreLogonEvents" : true,
"workstationResolution" : true,
"combineEventsEnabled" : true,
"suppressNestedGroupEventBacklinks" : true,
"processNestedGroupUsers" : true,
"workstationReverseLookup" : true,
"nestedGroups" : [ {
"msdsPrincipalName" : "msdsPrincipalName",
"presentationName" : "presentationName",
"displayName" : "displayName",
"accountExpires" : 3,
"objectClass" : "objectClass",
"samAccountName" : "samAccountName",
"dnsName" : "dnsName",
"description" : "description",
"dn" : "dn",
"cn" : "cn",
"ldapName" : "ldapName",
"managerEmail" : "managerEmail",
"domain" : "domain",
"objectGuid" : "objectGuid",
"name" : "name",
"objectSid" : "objectSid",
"attributes" : [ {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
}, {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
} ],
"userPrincipalName" : "userPrincipalName",
"userAccountControl" : 7,
"pwdLastSet" : 9
}, {
"msdsPrincipalName" : "msdsPrincipalName",
"presentationName" : "presentationName",
"displayName" : "displayName",
"accountExpires" : 3,
"objectClass" : "objectClass",
"samAccountName" : "samAccountName",
"dnsName" : "dnsName",
"description" : "description",
"dn" : "dn",
"cn" : "cn",
"ldapName" : "ldapName",
"managerEmail" : "managerEmail",
"domain" : "domain",
"objectGuid" : "objectGuid",
"name" : "name",
"objectSid" : "objectSid",
"attributes" : [ {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
}, {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
} ],
"userPrincipalName" : "userPrincipalName",
"userAccountControl" : 7,
"pwdLastSet" : 9
} ],
"logLevel" : 2,
"processNestedGroups" : true,
"excludedAttributes" : "excludedAttributes",
"ldapTimeout" : 2
},
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"id" : 0,
"collectionInterval" : 6,
"status" : 5
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DomainConfigurationUp
post /api/v{version}/collectors/activedirectory/domains (apiVversionCollectorsActivedirectoryDomainsPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body DomainConfiguration (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"accountName" : "accountName",
"backupPassword" : "backupPassword",
"flags" : 1,
"dnsName" : "dnsName",
"domainControllers" : [ {
"lastActive" : "2000-01-23T04:56:07.000+00:00",
"statusMessage" : "statusMessage",
"enabled" : true,
"sid" : "sid",
"netBiosName" : "netBiosName",
"hasAgent" : true,
"osVersion" : "osVersion",
"domain" : "domain",
"name" : "name",
"agentVersion" : "agentVersion",
"id" : 6,
"upgradeRequired" : true,
"status" : 0
}, {
"lastActive" : "2000-01-23T04:56:07.000+00:00",
"statusMessage" : "statusMessage",
"enabled" : true,
"sid" : "sid",
"netBiosName" : "netBiosName",
"hasAgent" : true,
"osVersion" : "osVersion",
"domain" : "domain",
"name" : "name",
"agentVersion" : "agentVersion",
"id" : 6,
"upgradeRequired" : true,
"status" : 0
} ],
"backupAccountName" : "backupAccountName",
"ncName" : "ncName",
"enabled" : true,
"parentDomain" : "parentDomain",
"dcAccountName" : "dcAccountName",
"dcPassword" : "dcPassword",
"password" : "password",
"statusDescription" : "statusDescription",
"netBiosName" : "netBiosName",
"localDcCollection" : true,
"agentConfiguration" : {
"processNestedGroupUserMembers" : true,
"processNestedGroupMembers" : true,
"suppressNestedGroupEventData" : true,
"enableGPOBackup" : true,
"combineEventsDelay" : 5,
"enableMissingGPOBackup" : true,
"ignoreLogonEvents" : true,
"workstationResolution" : true,
"combineEventsEnabled" : true,
"suppressNestedGroupEventBacklinks" : true,
"processNestedGroupUsers" : true,
"workstationReverseLookup" : true,
"nestedGroups" : [ {
"msdsPrincipalName" : "msdsPrincipalName",
"presentationName" : "presentationName",
"displayName" : "displayName",
"accountExpires" : 3,
"objectClass" : "objectClass",
"samAccountName" : "samAccountName",
"dnsName" : "dnsName",
"description" : "description",
"dn" : "dn",
"cn" : "cn",
"ldapName" : "ldapName",
"managerEmail" : "managerEmail",
"domain" : "domain",
"objectGuid" : "objectGuid",
"name" : "name",
"objectSid" : "objectSid",
"attributes" : [ {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
}, {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
} ],
"userPrincipalName" : "userPrincipalName",
"userAccountControl" : 7,
"pwdLastSet" : 9
}, {
"msdsPrincipalName" : "msdsPrincipalName",
"presentationName" : "presentationName",
"displayName" : "displayName",
"accountExpires" : 3,
"objectClass" : "objectClass",
"samAccountName" : "samAccountName",
"dnsName" : "dnsName",
"description" : "description",
"dn" : "dn",
"cn" : "cn",
"ldapName" : "ldapName",
"managerEmail" : "managerEmail",
"domain" : "domain",
"objectGuid" : "objectGuid",
"name" : "name",
"objectSid" : "objectSid",
"attributes" : [ {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
}, {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
} ],
"userPrincipalName" : "userPrincipalName",
"userAccountControl" : 7,
"pwdLastSet" : 9
} ],
"logLevel" : 2,
"processNestedGroups" : true,
"excludedAttributes" : "excludedAttributes",
"ldapTimeout" : 2
},
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"id" : 0,
"collectionInterval" : 6,
"status" : 5
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DomainConfigurationUp
post /api/v{version}/collectors/activedirectory/domains/search (apiVversionCollectorsActivedirectoryDomainsSearchPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body DomainSearch (optional)
Body Parameter —
Return type
array[ActiveDirectoryDomain]
Example data
Content-Type: application/json
[ {
"netBiosName" : "netBiosName",
"objectGuid" : "objectGuid",
"dnsName" : "dnsName",
"id" : 0,
"ncName" : "ncName"
}, {
"netBiosName" : "netBiosName",
"objectGuid" : "objectGuid",
"dnsName" : "dnsName",
"id" : 0,
"ncName" : "ncName"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessEvent
Up
get /api/v{version}/events/{id}Retrieve an event (apiVversionEventsIdGet)
Locates a specific event by its ID and retrieves details.
Path parameters
id (required)
Path Parameter — The ID of an event. format: int32
version (required)
Path Parameter —
Query parameters
type (required)
Query Parameter — The data source ID.<br><br>0 = Unknown, 1 = Active Directory, 2 = File System, 3 = Entra ID, 4 = Entra ID Sign-In, 5 = Exchange Online, 6 = SharePoint Online, 7 = VMWare, 8 = Active Directory Rollback, 9 = Microsoft Teams, 10 = Cygna Auditor, 11 = OneDrive, 12 = Azure, 14 = Security & Compliance Center, 101 = Active Directory (Blackbird)
database (required)
Query Parameter — The database ID. format: uuid
Return type
Example data
Content-Type: application/json
{
"organizationId" : 1,
"displayMessage" : "displayMessage",
"userCategory" : 5,
"success" : true,
"eventTime" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"source" : 6,
"statusMessage" : "statusMessage"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success AuditEventDetailBase400
Bad Request. The event ID is not a positive integer or the type is not a valid data source ID.401
Unauthorized. The request does not contain a valid authorization header and session-id header, or the user is not authorized to read audit events.410
The requested event was not found.500
An unexpected error occurred.Up
post /api/v{version}/eventsList events (apiVversionEventsPost)
Searches and retrieves audit events based on search parameters.
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body EventsRequest (optional)
Body Parameter —
Query parameters
limit (optional)
Query Parameter — The maximum number of events to retrieve. format: int32
useCoreDatabase (optional)
Query Parameter — The database to search through. default: false
Return type
array[AuditEvent]
Example data
Content-Type: application/json
[ {
"teamName" : "teamName",
"vmHost" : "vmHost",
"resourceGroup" : "resourceGroup",
"sourceFileName" : "sourceFileName",
"databaseName" : "databaseName",
"eventCategory" : "eventCategory",
"samAccountName" : "samAccountName",
"when" : "2000-01-23T04:56:07.000+00:00",
"vmCategory" : "vmCategory",
"teamMember" : "teamMember",
"path" : "path",
"vmType" : "vmType",
"valueAdded" : "valueAdded",
"crossMailboxOperations" : true,
"workstationId" : 5,
"valueAddedDisplay" : "valueAddedDisplay",
"eventName" : "eventName",
"id" : 0,
"tenant" : "tenant",
"identityName" : "identityName",
"attributeValue" : "attributeValue",
"level" : "level",
"module" : 6,
"attributePreviousValue" : "attributePreviousValue",
"mailboxFolder" : "mailboxFolder",
"objectClass" : "objectClass",
"workstation" : "workstation",
"opn" : 9,
"external" : true,
"success" : 1,
"vm" : "vm",
"status" : "status",
"valueRemoved" : "valueRemoved",
"server" : "server",
"itemType" : 2,
"subscription" : "subscription",
"nativeEventId" : 5,
"fromAgent" : true,
"client" : "client",
"attribute" : "attribute",
"databaseId" : "databaseId",
"isRisky" : true,
"mailboxUPN" : "mailboxUPN",
"dataCenter" : "dataCenter",
"aDsType" : 7,
"workload" : "workload",
"objectDN" : "objectDN",
"objectName" : "objectName",
"dataStore" : "dataStore",
"teamRole" : "teamRole",
"location" : "location",
"accountSid" : "accountSid",
"user" : "user",
"operation" : "operation",
"resourceType" : "resourceType"
}, {
"teamName" : "teamName",
"vmHost" : "vmHost",
"resourceGroup" : "resourceGroup",
"sourceFileName" : "sourceFileName",
"databaseName" : "databaseName",
"eventCategory" : "eventCategory",
"samAccountName" : "samAccountName",
"when" : "2000-01-23T04:56:07.000+00:00",
"vmCategory" : "vmCategory",
"teamMember" : "teamMember",
"path" : "path",
"vmType" : "vmType",
"valueAdded" : "valueAdded",
"crossMailboxOperations" : true,
"workstationId" : 5,
"valueAddedDisplay" : "valueAddedDisplay",
"eventName" : "eventName",
"id" : 0,
"tenant" : "tenant",
"identityName" : "identityName",
"attributeValue" : "attributeValue",
"level" : "level",
"module" : 6,
"attributePreviousValue" : "attributePreviousValue",
"mailboxFolder" : "mailboxFolder",
"objectClass" : "objectClass",
"workstation" : "workstation",
"opn" : 9,
"external" : true,
"success" : 1,
"vm" : "vm",
"status" : "status",
"valueRemoved" : "valueRemoved",
"server" : "server",
"itemType" : 2,
"subscription" : "subscription",
"nativeEventId" : 5,
"fromAgent" : true,
"client" : "client",
"attribute" : "attribute",
"databaseId" : "databaseId",
"isRisky" : true,
"mailboxUPN" : "mailboxUPN",
"dataCenter" : "dataCenter",
"aDsType" : 7,
"workload" : "workload",
"objectDN" : "objectDN",
"objectName" : "objectName",
"dataStore" : "dataStore",
"teamRole" : "teamRole",
"location" : "location",
"accountSid" : "accountSid",
"user" : "user",
"operation" : "operation",
"resourceType" : "resourceType"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessFileSystem
Up
put /api/v{version}/collectors/filesystem/delete/all (apiVversionCollectorsFilesystemDeleteAllPut)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body FileSystemConfiguration (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"serverName" : "serverName",
"workItemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"serverId" : 6,
"version" : "version",
"serverDnsName" : "serverDnsName",
"serverSid" : "serverSid",
"alertCount" : 5,
"lastUpdate" : "2000-01-23T04:56:07.000+00:00",
"lastCollection" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"isDriver" : true,
"collectionInterval" : 5,
"upgradeRequired" : true,
"status" : 1
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success FileServerUp
put /api/v{version}/collectors/filesystem/delete (apiVversionCollectorsFilesystemDeletePut)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body FileSystemConfiguration (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"serverName" : "serverName",
"workItemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"serverId" : 6,
"version" : "version",
"serverDnsName" : "serverDnsName",
"serverSid" : "serverSid",
"alertCount" : 5,
"lastUpdate" : "2000-01-23T04:56:07.000+00:00",
"lastCollection" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"isDriver" : true,
"collectionInterval" : 5,
"upgradeRequired" : true,
"status" : 1
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success FileServerUp
get /api/v{version}/collectors/filesystem (apiVversionCollectorsFilesystemGet)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"serverName" : "serverName",
"workItemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"serverId" : 6,
"version" : "version",
"serverDnsName" : "serverDnsName",
"serverSid" : "serverSid",
"alertCount" : 5,
"lastUpdate" : "2000-01-23T04:56:07.000+00:00",
"lastCollection" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"isDriver" : true,
"collectionInterval" : 5,
"upgradeRequired" : true,
"status" : 1
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success FileServerUp
get /api/v{version}/collectors/filesystem/{id} (apiVversionCollectorsFilesystemIdGet)
Path parameters
id (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"serverName" : "serverName",
"workItemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"serverId" : 6,
"version" : "version",
"serverDnsName" : "serverDnsName",
"serverSid" : "serverSid",
"alertCount" : 5,
"lastUpdate" : "2000-01-23T04:56:07.000+00:00",
"lastCollection" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"isDriver" : true,
"collectionInterval" : 5,
"upgradeRequired" : true,
"status" : 1
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success FileServerUp
post /api/v{version}/collectors/filesystem (apiVversionCollectorsFilesystemPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body FileSystemConfiguration (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"serverName" : "serverName",
"workItemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"serverId" : 6,
"version" : "version",
"serverDnsName" : "serverDnsName",
"serverSid" : "serverSid",
"alertCount" : 5,
"lastUpdate" : "2000-01-23T04:56:07.000+00:00",
"lastCollection" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"isDriver" : true,
"collectionInterval" : 5,
"upgradeRequired" : true,
"status" : 1
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success FileServerUp
put /api/v{version}/collectors/filesystem (apiVversionCollectorsFilesystemPut)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body FileSystemConfiguration (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"serverName" : "serverName",
"workItemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"serverId" : 6,
"version" : "version",
"serverDnsName" : "serverDnsName",
"serverSid" : "serverSid",
"alertCount" : 5,
"lastUpdate" : "2000-01-23T04:56:07.000+00:00",
"lastCollection" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"isDriver" : true,
"collectionInterval" : 5,
"upgradeRequired" : true,
"status" : 1
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success FileServerUp
put /api/v{version}/collectors/filesystem/restart (apiVversionCollectorsFilesystemRestartPut)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body FileSystemConfiguration (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"serverName" : "serverName",
"workItemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"serverId" : 6,
"version" : "version",
"serverDnsName" : "serverDnsName",
"serverSid" : "serverSid",
"alertCount" : 5,
"lastUpdate" : "2000-01-23T04:56:07.000+00:00",
"lastCollection" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"isDriver" : true,
"collectionInterval" : 5,
"upgradeRequired" : true,
"status" : 1
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success FileServerUp
post /api/v{version}/collectors/filesystem/search (apiVversionCollectorsFilesystemSearchPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body DomainSearch (optional)
Body Parameter —
Return type
array[FileServer]
Example data
Content-Type: application/json
[ {
"serverName" : "serverName",
"workItemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"serverId" : 6,
"version" : "version",
"serverDnsName" : "serverDnsName",
"serverSid" : "serverSid",
"alertCount" : 5,
"lastUpdate" : "2000-01-23T04:56:07.000+00:00",
"lastCollection" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"isDriver" : true,
"collectionInterval" : 5,
"upgradeRequired" : true,
"status" : 1
}, {
"serverName" : "serverName",
"workItemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"serverId" : 6,
"version" : "version",
"serverDnsName" : "serverDnsName",
"serverSid" : "serverSid",
"alertCount" : 5,
"lastUpdate" : "2000-01-23T04:56:07.000+00:00",
"lastCollection" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"isDriver" : true,
"collectionInterval" : 5,
"upgradeRequired" : true,
"status" : 1
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
put /api/v{version}/collectors/filesystem/start (apiVversionCollectorsFilesystemStartPut)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body FileSystemConfiguration (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"serverName" : "serverName",
"workItemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"serverId" : 6,
"version" : "version",
"serverDnsName" : "serverDnsName",
"serverSid" : "serverSid",
"alertCount" : 5,
"lastUpdate" : "2000-01-23T04:56:07.000+00:00",
"lastCollection" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"isDriver" : true,
"collectionInterval" : 5,
"upgradeRequired" : true,
"status" : 1
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success FileServerUp
put /api/v{version}/collectors/filesystem/stop (apiVversionCollectorsFilesystemStopPut)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body FileSystemConfiguration (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"serverName" : "serverName",
"workItemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"serverId" : 6,
"version" : "version",
"serverDnsName" : "serverDnsName",
"serverSid" : "serverSid",
"alertCount" : 5,
"lastUpdate" : "2000-01-23T04:56:07.000+00:00",
"lastCollection" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"isDriver" : true,
"collectionInterval" : 5,
"upgradeRequired" : true,
"status" : 1
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success FileServerFilter
Up
get /api/v{version}/collectors/filesystem/filters (apiVversionCollectorsFilesystemFiltersGet)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isAlert" : true,
"reportType" : "reportType",
"baseQuery" : "baseQuery",
"sortAscending" : true,
"clauses" : [ {
"comparison" : "comparison",
"field" : "field",
"values" : [ {
"value2" : "value2",
"value1" : "value1"
}, {
"value2" : "value2",
"value1" : "value1"
} ],
"type" : "type"
}, {
"comparison" : "comparison",
"field" : "field",
"values" : [ {
"value2" : "value2",
"value1" : "value1"
}, {
"value2" : "value2",
"value1" : "value1"
} ],
"type" : "type"
} ],
"maxRecordCount" : 0,
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"actions" : [ {
"data" : "data",
"type" : "type"
}, {
"data" : "data",
"type" : "type"
} ],
"enabled" : true,
"tags" : "tags"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success FilterReportUp
delete /api/v{version}/collectors/filesystem/filters/{id} (apiVversionCollectorsFilesystemFiltersIdDelete)
Path parameters
id (required)
Path Parameter — format: uuid
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
0Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygStatusUp
get /api/v{version}/collectors/filesystem/filters/{id} (apiVversionCollectorsFilesystemFiltersIdGet)
Path parameters
id (required)
Path Parameter — format: uuid
version (required)
Path Parameter —
Responses
200
SuccessUp
put /api/v{version}/collectors/filesystem/filters/{id} (apiVversionCollectorsFilesystemFiltersIdPut)
Path parameters
id (required)
Path Parameter — format: uuid
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body FilterReport (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
0Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygStatusUp
post /api/v{version}/collectors/filesystem/filters (apiVversionCollectorsFilesystemFiltersPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body FilterReport (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
0Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygStatusUp
post /api/v{version}/collectors/filesystem/filters/shares (apiVversionCollectorsFilesystemFiltersSharesPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body string (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
0Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygStatusHealthCheck
Up
post /api/v{version}/healthcheck/all (apiVversionHealthcheckAllPost)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"name" : "name",
"description" : "description",
"statusDetail" : "statusDetail",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success HealthCheckUp
post /api/v{version}/healthcheck/{id} (apiVversionHealthcheckIdPost)
Path parameters
id (required)
Path Parameter — format: uuid
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"name" : "name",
"description" : "description",
"statusDetail" : "statusDetail",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success HealthCheckUp
post /api/v{version}/healthcheck/ping (apiVversionHealthcheckPingPost)
Path parameters
version (required)
Path Parameter —
Responses
200
SuccessIIS
Up
get /api/v{version}/setup/iis/applicationpools/current (apiVversionSetupIisApplicationpoolsCurrentGet)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"managedPipelineMode" : 0,
"identity" : {
"identityType" : 1,
"credentials" : {
"password" : "password",
"username" : "username"
}
},
"name" : "name",
"state" : 6,
"managedRuntimeVersion" : "managedRuntimeVersion"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ApplicationPoolUp
put /api/v{version}/setup/iis/applicationpools/current/identity (apiVversionSetupIisApplicationpoolsCurrentIdentityPut)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body ApplicationPoolIdentity (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"identityType" : 1,
"credentials" : {
"password" : "password",
"username" : "username"
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ApplicationPoolIdentityUp
post /api/v{version}/setup/iis/applicationpools/current (apiVversionSetupIisApplicationpoolsCurrentPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body ApplicationPool (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"managedPipelineMode" : 0,
"identity" : {
"identityType" : 1,
"credentials" : {
"password" : "password",
"username" : "username"
}
},
"name" : "name",
"state" : 6,
"managedRuntimeVersion" : "managedRuntimeVersion"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ApplicationPoolUp
put /api/v{version}/setup/iis/applicationpools/current (apiVversionSetupIisApplicationpoolsCurrentPut)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body ApplicationPool (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"managedPipelineMode" : 0,
"identity" : {
"identityType" : 1,
"credentials" : {
"password" : "password",
"username" : "username"
}
},
"name" : "name",
"state" : 6,
"managedRuntimeVersion" : "managedRuntimeVersion"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ApplicationPoolUp
post /api/v{version}/setup/iis/applicationpools/current/recycle (apiVversionSetupIisApplicationpoolsCurrentRecyclePost)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
0Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygStatusUp
get /api/v{version}/setup/iis/applicationpools (apiVversionSetupIisApplicationpoolsGet)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"managedPipelineMode" : 0,
"identity" : {
"identityType" : 1,
"credentials" : {
"password" : "password",
"username" : "username"
}
},
"name" : "name",
"state" : 6,
"managedRuntimeVersion" : "managedRuntimeVersion"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ApplicationPoolIdentity
Up
delete /api/v{version}/identity/allDelete identities (apiVversionIdentityAllDelete)
Revokes all identity settings. The accounts will no longer be associated with each other and will be treated as separate accounts.
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
get /api/v{version}/identityList identities (apiVversionIdentityGet)
Retrieves a list of available Cygna identities. An identity enables you to manage several accounts of the same person as one.
For example, on-premises Active Directory account and Entra ID account.
Path parameters
version (required)
Path Parameter —
Query parameters
searchText (optional)
Query Parameter — Provide a Cygna identity name to search for it.
Return type
array[Identity]
Example data
Content-Type: application/json
[ {
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"description" : "description",
"id" : 0,
"accounts" : [ {
"accountId" : 5,
"accountName" : "accountName",
"identityId" : 1,
"displayName" : "displayName",
"securityIdentifier" : "securityIdentifier",
"id" : 6,
"source" : 5,
"state" : 2
}, {
"accountId" : 5,
"accountName" : "accountName",
"identityId" : 1,
"displayName" : "displayName",
"securityIdentifier" : "securityIdentifier",
"id" : 6,
"source" : 5,
"state" : 2
} ]
}, {
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"description" : "description",
"id" : 0,
"accounts" : [ {
"accountId" : 5,
"accountName" : "accountName",
"identityId" : 1,
"displayName" : "displayName",
"securityIdentifier" : "securityIdentifier",
"id" : 6,
"source" : 5,
"state" : 2
}, {
"accountId" : 5,
"accountName" : "accountName",
"identityId" : 1,
"displayName" : "displayName",
"securityIdentifier" : "securityIdentifier",
"id" : 6,
"source" : 5,
"state" : 2
} ]
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
delete /api/v{version}/identity/{id}Delete an identity (apiVversionIdentityIdDelete)
Locates a Cygna identity by its ID and deletes it. Provide an ID in the path.
Path parameters
id (required)
Path Parameter — Cygna identity ID format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
get /api/v{version}/identity/{id}Retrieve an identity (apiVversionIdentityIdGet)
Locates a Cygna identity by its ID and retrieves its details. Provide an ID in the path.
Path parameters
id (required)
Path Parameter — Cygna identity ID format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"description" : "description",
"id" : 0,
"accounts" : [ {
"accountId" : 5,
"accountName" : "accountName",
"identityId" : 1,
"displayName" : "displayName",
"securityIdentifier" : "securityIdentifier",
"id" : 6,
"source" : 5,
"state" : 2
}, {
"accountId" : 5,
"accountName" : "accountName",
"identityId" : 1,
"displayName" : "displayName",
"securityIdentifier" : "securityIdentifier",
"id" : 6,
"source" : 5,
"state" : 2
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success IdentityUp
put /api/v{version}/identity/{id}Update an identity (apiVversionIdentityIdPut)
Locates a Cygna identity by its ID and modifies it. Provide an ID in the path.
Path parameters
id (required)
Path Parameter — Cygna identity ID format: int32
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body Identity (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"description" : "description",
"id" : 0,
"accounts" : [ {
"accountId" : 5,
"accountName" : "accountName",
"identityId" : 1,
"displayName" : "displayName",
"securityIdentifier" : "securityIdentifier",
"id" : 6,
"source" : 5,
"state" : 2
}, {
"accountId" : 5,
"accountName" : "accountName",
"identityId" : 1,
"displayName" : "displayName",
"securityIdentifier" : "securityIdentifier",
"id" : 6,
"source" : 5,
"state" : 2
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success IdentityUp
delete /api/v{version}/identity/{identity}/accounts/{id}Remove an account from identity (apiVversionIdentityIdentityAccountsIdDelete)
Locates an account by its ID and removes mapping with a Cygna identity.
The account will no longer be associated with this identity.
Provide identity and id in the path.
Path parameters
id (required)
Path Parameter — User account ID format: int32
version (required)
Path Parameter —
identity (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
post /api/v{version}/identityCreate an identity (apiVversionIdentityPost)
Adds a new custom identity. An identity enables you to combine several accounts of the same person and manage as one.
For example, on-premises Active Directory account and Entra ID account.
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body Identity (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"description" : "description",
"id" : 0,
"accounts" : [ {
"accountId" : 5,
"accountName" : "accountName",
"identityId" : 1,
"displayName" : "displayName",
"securityIdentifier" : "securityIdentifier",
"id" : 6,
"source" : 5,
"state" : 2
}, {
"accountId" : 5,
"accountName" : "accountName",
"identityId" : 1,
"displayName" : "displayName",
"securityIdentifier" : "securityIdentifier",
"id" : 6,
"source" : 5,
"state" : 2
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success IdentityLicense
Up
delete /api/v{version}/system/config/license (apiVversionSystemConfigLicenseDelete)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
0Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygStatusUp
get /api/v{version}/system/config/license (apiVversionSystemConfigLicenseGet)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"generatedOn" : "2000-01-23T04:56:07.000+00:00",
"configuration" : {
"xml" : "xml",
"companyName" : "companyName"
},
"maintenanceExpiry" : "2000-01-23T04:56:07.000+00:00",
"company" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"version" : 1,
"modules" : [ {
"licenseType" : 6,
"endDate" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"count" : 0,
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, {
"licenseType" : 6,
"endDate" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"count" : 0,
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success LicenseUp
post /api/v{version}/system/config/license (apiVversionSystemConfigLicensePost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body string (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"generatedOn" : "2000-01-23T04:56:07.000+00:00",
"configuration" : {
"xml" : "xml",
"companyName" : "companyName"
},
"maintenanceExpiry" : "2000-01-23T04:56:07.000+00:00",
"company" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"version" : 1,
"modules" : [ {
"licenseType" : 6,
"endDate" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"count" : 0,
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, {
"licenseType" : 6,
"endDate" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"count" : 0,
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success LicenseUp
get /api/v{version}/system/config/license/status (apiVversionSystemConfigLicenseStatusGet)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isConfigured" : true,
"item" : 0,
"displayName" : "displayName"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ConfigurationStatusUp
post /api/v{version}/system/config/license/verify (apiVversionSystemConfigLicenseVerifyPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body string (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"generatedOn" : "2000-01-23T04:56:07.000+00:00",
"configuration" : {
"xml" : "xml",
"companyName" : "companyName"
},
"maintenanceExpiry" : "2000-01-23T04:56:07.000+00:00",
"company" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"version" : 1,
"modules" : [ {
"licenseType" : 6,
"endDate" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"count" : 0,
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, {
"licenseType" : 6,
"endDate" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"count" : 0,
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success LicenseLog
Up
get /api/v{version}/system/log/config (apiVversionSystemLogConfigGet)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"level" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success LogConfigurationUp
post /api/v{version}/system/log (apiVversionSystemLogPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body LogMessage (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseLogging
Up
delete /api/v{version}/system/config/logging (apiVversionSystemConfigLoggingDelete)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
get /api/v{version}/system/config/logging (apiVversionSystemConfigLoggingGet)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isStatusEventsLoggingEnabled" : true,
"isApiLoggingEnabled" : true
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success LoggingConfigurationUp
post /api/v{version}/system/config/logging (apiVversionSystemConfigLoggingPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body LoggingConfiguration (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"isStatusEventsLoggingEnabled" : true,
"isApiLoggingEnabled" : true
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success LoggingConfigurationUp
put /api/v{version}/system/config/logging (apiVversionSystemConfigLoggingPut)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body LoggingConfiguration (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"isStatusEventsLoggingEnabled" : true,
"isApiLoggingEnabled" : true
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success LoggingConfigurationOffice365
Up
put /api/v{version}/collectors/o365/refreshLicense (apiVversionCollectorsO365RefreshLicensePut)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
get /api/v{version}/collectors/o365/teams/channelsSearch for MS Teams channels that have IDs in the supplied list. (apiVversionCollectorsO365TeamsChannelsGet)
Return a lists of channel objects (from Microsoft Teams) based on the search criteria.
Path parameters
version (required)
Path Parameter —
Query parameters
channelIds (optional)
Query Parameter — A list of integer channel IDs. format: int32
Return type
array[TeamsChannel]
Example data
Content-Type: application/json
[ {
"teamName" : "teamName",
"mailboxUpn" : "mailboxUpn",
"teamGuid" : "teamGuid",
"channelName" : "channelName",
"channelType" : "channelType",
"id" : 0,
"channelGuid" : "channelGuid"
}, {
"teamName" : "teamName",
"mailboxUpn" : "mailboxUpn",
"teamGuid" : "teamGuid",
"channelName" : "channelName",
"channelType" : "channelType",
"id" : 0,
"channelGuid" : "channelGuid"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
get /api/v{version}/collectors/o365/teams/{searchString}/channelsSearch for MS Teams channels that match the search string by team name. (apiVversionCollectorsO365TeamsSearchStringChannelsGet)
Return a lists of channel objects (from Microsoft Teams) based on the search criteria.
Path parameters
searchString (required)
Path Parameter — A partial team name.
version (required)
Path Parameter —
Query parameters
includeChannelsWithoutEmail (optional)
Query Parameter — Whether or not to include teams channels without a group email address in the results. default: true
Return type
array[TeamsChannel]
Example data
Content-Type: application/json
[ {
"teamName" : "teamName",
"mailboxUpn" : "mailboxUpn",
"teamGuid" : "teamGuid",
"channelName" : "channelName",
"channelType" : "channelType",
"id" : 0,
"channelGuid" : "channelGuid"
}, {
"teamName" : "teamName",
"mailboxUpn" : "mailboxUpn",
"teamGuid" : "teamGuid",
"channelName" : "channelName",
"channelType" : "channelType",
"id" : 0,
"channelGuid" : "channelGuid"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
get /api/v{version}/collectors/o365/tenants (apiVversionCollectorsO365TenantsGet)
Path parameters
version (required)
Path Parameter —
Return type
array[Tenant]
Example data
Content-Type: application/json
[ {
"displayName" : "displayName",
"tenantId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"interval" : 6,
"id" : 0,
"tenantCode" : "tenantCode",
"enabled" : true
}, {
"displayName" : "displayName",
"tenantId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"interval" : 6,
"id" : 0,
"tenantCode" : "tenantCode",
"enabled" : true
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
delete /api/v{version}/collectors/o365/tenants/{id} (apiVversionCollectorsO365TenantsIdDelete)
Path parameters
id (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
get /api/v{version}/collectors/o365/tenants/{id} (apiVversionCollectorsO365TenantsIdGet)
Path parameters
id (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"displayName" : "displayName",
"tenantId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"interval" : 6,
"id" : 0,
"tenantCode" : "tenantCode",
"enabled" : true
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success TenantUp
put /api/v{version}/collectors/o365/tenants/{id} (apiVversionCollectorsO365TenantsIdPut)
Path parameters
id (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body Tenant (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"displayName" : "displayName",
"tenantId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"interval" : 6,
"id" : 0,
"tenantCode" : "tenantCode",
"enabled" : true
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success TenantUp
post /api/v{version}/collectors/o365/tenants (apiVversionCollectorsO365TenantsPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body TenantState (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"displayName" : "displayName",
"tenantId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"interval" : 6,
"id" : 0,
"tenantCode" : "tenantCode",
"enabled" : true
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success TenantUp
get /api/v{version}/collectors/o365/tenants/precursor (apiVversionCollectorsO365TenantsPrecursorGet)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"authorizationUrl" : "authorizationUrl",
"state" : {
"state" : "state"
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success TenantPrecursorUp
get /api/v{version}/collectors/o365/verify (apiVversionCollectorsO365VerifyGet)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBasePermission
Up
get /api/v{version}/delegation/permissionsList permissions (apiVversionDelegationPermissionsGet)
Retrieves all available permissions.
Path parameters
version (required)
Path Parameter —
Return type
array[Permission]
Example data
Content-Type: application/json
[ {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
}, {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessProfile
Up
get /api/v{version}/collectors/activedirectory/profile (apiVversionCollectorsActivedirectoryProfileGet)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"systemAttributes" : [ "systemAttributes", "systemAttributes" ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ActiveDirectoryProfileProtection
Up
delete /api/v{version}/protector/domain/{domainId}/policies (apiVversionProtectorDomainDomainIdPoliciesDelete)
Path parameters
domainId (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
get /api/v{version}/protector/domain/{domainId}/policies (apiVversionProtectorDomainDomainIdPoliciesGet)
Path parameters
domainId (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
array[DomainProtectionPolicy]
Example data
Content-Type: application/json
[ {
"rule" : {
"builtIn" : true,
"name" : "name",
"description" : "description",
"id" : 5,
"defaultAllow" : true,
"filters" : [ {
"objectClasses" : [ "objectClasses", "objectClasses" ],
"objects" : [ {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
}, {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
} ],
"eventMask" : 7,
"attributes" : [ "attributes", "attributes" ],
"id" : 2,
"accounts" : [ {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
}, {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
} ]
}, {
"objectClasses" : [ "objectClasses", "objectClasses" ],
"objects" : [ {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
}, {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
} ],
"eventMask" : 7,
"attributes" : [ "attributes", "attributes" ],
"id" : 2,
"accounts" : [ {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
}, {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
} ]
} ]
},
"id" : 0,
"ruleId" : 1,
"domainId" : 6,
"enabled" : true,
"actionMask" : 5
}, {
"rule" : {
"builtIn" : true,
"name" : "name",
"description" : "description",
"id" : 5,
"defaultAllow" : true,
"filters" : [ {
"objectClasses" : [ "objectClasses", "objectClasses" ],
"objects" : [ {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
}, {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
} ],
"eventMask" : 7,
"attributes" : [ "attributes", "attributes" ],
"id" : 2,
"accounts" : [ {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
}, {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
} ]
}, {
"objectClasses" : [ "objectClasses", "objectClasses" ],
"objects" : [ {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
}, {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
} ],
"eventMask" : 7,
"attributes" : [ "attributes", "attributes" ],
"id" : 2,
"accounts" : [ {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
}, {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
} ]
} ]
},
"id" : 0,
"ruleId" : 1,
"domainId" : 6,
"enabled" : true,
"actionMask" : 5
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
post /api/v{version}/protector/domain/policies/export/{domainId} (apiVversionProtectorDomainPoliciesExportDomainIdPost)
Path parameters
domainId (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
byte[]
Example data
Content-Type: application/json
""Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success byte[]Up
get /api/v{version}/protector/domain/policies (apiVversionProtectorDomainPoliciesGet)
Path parameters
version (required)
Path Parameter —
Return type
array[DomainProtectionPolicy]
Example data
Content-Type: application/json
[ {
"rule" : {
"builtIn" : true,
"name" : "name",
"description" : "description",
"id" : 5,
"defaultAllow" : true,
"filters" : [ {
"objectClasses" : [ "objectClasses", "objectClasses" ],
"objects" : [ {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
}, {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
} ],
"eventMask" : 7,
"attributes" : [ "attributes", "attributes" ],
"id" : 2,
"accounts" : [ {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
}, {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
} ]
}, {
"objectClasses" : [ "objectClasses", "objectClasses" ],
"objects" : [ {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
}, {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
} ],
"eventMask" : 7,
"attributes" : [ "attributes", "attributes" ],
"id" : 2,
"accounts" : [ {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
}, {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
} ]
} ]
},
"id" : 0,
"ruleId" : 1,
"domainId" : 6,
"enabled" : true,
"actionMask" : 5
}, {
"rule" : {
"builtIn" : true,
"name" : "name",
"description" : "description",
"id" : 5,
"defaultAllow" : true,
"filters" : [ {
"objectClasses" : [ "objectClasses", "objectClasses" ],
"objects" : [ {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
}, {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
} ],
"eventMask" : 7,
"attributes" : [ "attributes", "attributes" ],
"id" : 2,
"accounts" : [ {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
}, {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
} ]
}, {
"objectClasses" : [ "objectClasses", "objectClasses" ],
"objects" : [ {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
}, {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
} ],
"eventMask" : 7,
"attributes" : [ "attributes", "attributes" ],
"id" : 2,
"accounts" : [ {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
}, {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
} ]
} ]
},
"id" : 0,
"ruleId" : 1,
"domainId" : 6,
"enabled" : true,
"actionMask" : 5
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
delete /api/v{version}/protector/domain/policies/{policyId} (apiVversionProtectorDomainPoliciesPolicyIdDelete)
Path parameters
policyId (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
get /api/v{version}/protector/domain/policies/{policyId} (apiVversionProtectorDomainPoliciesPolicyIdGet)
Path parameters
policyId (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
array[DomainProtectionPolicy]
Example data
Content-Type: application/json
[ {
"rule" : {
"builtIn" : true,
"name" : "name",
"description" : "description",
"id" : 5,
"defaultAllow" : true,
"filters" : [ {
"objectClasses" : [ "objectClasses", "objectClasses" ],
"objects" : [ {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
}, {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
} ],
"eventMask" : 7,
"attributes" : [ "attributes", "attributes" ],
"id" : 2,
"accounts" : [ {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
}, {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
} ]
}, {
"objectClasses" : [ "objectClasses", "objectClasses" ],
"objects" : [ {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
}, {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
} ],
"eventMask" : 7,
"attributes" : [ "attributes", "attributes" ],
"id" : 2,
"accounts" : [ {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
}, {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
} ]
} ]
},
"id" : 0,
"ruleId" : 1,
"domainId" : 6,
"enabled" : true,
"actionMask" : 5
}, {
"rule" : {
"builtIn" : true,
"name" : "name",
"description" : "description",
"id" : 5,
"defaultAllow" : true,
"filters" : [ {
"objectClasses" : [ "objectClasses", "objectClasses" ],
"objects" : [ {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
}, {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
} ],
"eventMask" : 7,
"attributes" : [ "attributes", "attributes" ],
"id" : 2,
"accounts" : [ {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
}, {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
} ]
}, {
"objectClasses" : [ "objectClasses", "objectClasses" ],
"objects" : [ {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
}, {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
} ],
"eventMask" : 7,
"attributes" : [ "attributes", "attributes" ],
"id" : 2,
"accounts" : [ {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
}, {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
} ]
} ]
},
"id" : 0,
"ruleId" : 1,
"domainId" : 6,
"enabled" : true,
"actionMask" : 5
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
post /api/v{version}/protector/domain/policies (apiVversionProtectorDomainPoliciesPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body DomainProtectionPolicy (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
put /api/v{version}/protector/policies (apiVversionProtectorPoliciesPut)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body DomainProtectionPolicy (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
get /api/v{version}/protector/rules (apiVversionProtectorRulesGet)
Path parameters
version (required)
Path Parameter —
Return type
array[ProtectionRule]
Example data
Content-Type: application/json
[ {
"builtIn" : true,
"name" : "name",
"description" : "description",
"id" : 5,
"defaultAllow" : true,
"filters" : [ {
"objectClasses" : [ "objectClasses", "objectClasses" ],
"objects" : [ {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
}, {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
} ],
"eventMask" : 7,
"attributes" : [ "attributes", "attributes" ],
"id" : 2,
"accounts" : [ {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
}, {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
} ]
}, {
"objectClasses" : [ "objectClasses", "objectClasses" ],
"objects" : [ {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
}, {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
} ],
"eventMask" : 7,
"attributes" : [ "attributes", "attributes" ],
"id" : 2,
"accounts" : [ {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
}, {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
} ]
} ]
}, {
"builtIn" : true,
"name" : "name",
"description" : "description",
"id" : 5,
"defaultAllow" : true,
"filters" : [ {
"objectClasses" : [ "objectClasses", "objectClasses" ],
"objects" : [ {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
}, {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
} ],
"eventMask" : 7,
"attributes" : [ "attributes", "attributes" ],
"id" : 2,
"accounts" : [ {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
}, {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
} ]
}, {
"objectClasses" : [ "objectClasses", "objectClasses" ],
"objects" : [ {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
}, {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
} ],
"eventMask" : 7,
"attributes" : [ "attributes", "attributes" ],
"id" : 2,
"accounts" : [ {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
}, {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
} ]
} ]
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
post /api/v{version}/protector/rules (apiVversionProtectorRulesPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body ProtectionRule (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
put /api/v{version}/protector/rules (apiVversionProtectorRulesPut)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body ProtectionRule (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
delete /api/v{version}/protector/rules/{ruleId} (apiVversionProtectorRulesRuleIdDelete)
Path parameters
ruleId (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
get /api/v{version}/protector/rules/{ruleId} (apiVversionProtectorRulesRuleIdGet)
Path parameters
ruleId (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"builtIn" : true,
"name" : "name",
"description" : "description",
"id" : 5,
"defaultAllow" : true,
"filters" : [ {
"objectClasses" : [ "objectClasses", "objectClasses" ],
"objects" : [ {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
}, {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
} ],
"eventMask" : 7,
"attributes" : [ "attributes", "attributes" ],
"id" : 2,
"accounts" : [ {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
}, {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
} ]
}, {
"objectClasses" : [ "objectClasses", "objectClasses" ],
"objects" : [ {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
}, {
"excluded" : true,
"displayName" : "displayName",
"objectClass" : "objectClass",
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"inheritance" : 2,
"dn" : "dn",
"id" : 3,
"domainId" : 4
} ],
"eventMask" : 7,
"attributes" : [ "attributes", "attributes" ],
"id" : 2,
"accounts" : [ {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
}, {
"excluded" : true,
"displayName" : "displayName",
"domain" : "domain",
"dn" : "dn",
"id" : 9,
"sid" : "sid"
} ]
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ProtectionRuleProxy
Up
post /api/v{version}/system/config/proxy/delete (apiVversionSystemConfigProxyDeletePost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body AccountCredentials (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
get /api/v{version}/system/config/proxy (apiVversionSystemConfigProxyGet)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"server" : "server",
"isProxyToBeUsed" : true,
"port" : 0,
"userCredentials" : {
"password" : "password",
"username" : "username"
},
"isSpecificUserToBeUsed" : true
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ProxyConfigurationWebUp
post /api/v{version}/system/config/proxy (apiVversionSystemConfigProxyPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body ProxyConfigurationWeb (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"server" : "server",
"isProxyToBeUsed" : true,
"port" : 0,
"userCredentials" : {
"password" : "password",
"username" : "username"
},
"isSpecificUserToBeUsed" : true
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ProxyConfigurationWebUp
put /api/v{version}/system/config/proxy (apiVversionSystemConfigProxyPut)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body ProxyConfigurationWeb (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"server" : "server",
"isProxyToBeUsed" : true,
"port" : 0,
"userCredentials" : {
"password" : "password",
"username" : "username"
},
"isSpecificUserToBeUsed" : true
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ProxyConfigurationWebUp
get /api/v{version}/system/config/proxy/status (apiVversionSystemConfigProxyStatusGet)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isConfigured" : true,
"item" : 0,
"displayName" : "displayName"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ConfigurationStatusUp
post /api/v{version}/system/config/proxy/test (apiVversionSystemConfigProxyTestPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body ProxyConfigurationWeb (optional)
Body Parameter —
Query parameters
url (optional)
Query Parameter — format: uri
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
post /api/v{version}/system/config/proxy/verify (apiVversionSystemConfigProxyVerifyPost)
Path parameters
version (required)
Path Parameter —
Query parameters
url (optional)
Query Parameter — format: uri
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseRecovery
Up
get /api/v{version}/collectors/activedirectory/recovery (apiVversionCollectorsActivedirectoryRecoveryGet)
Path parameters
version (required)
Path Parameter —
Query parameters
domain (optional)
Query Parameter — format: int32
type (optional)
Query Parameter —
days (optional)
Query Parameter — default: 0 format: int32
limit (optional)
Query Parameter — default: 0 format: int32
Return type
Example data
Content-Type: application/json
{
"presentationName" : "presentationName",
"displayName" : "displayName",
"accountExpires" : 1,
"deletedOn" : "2000-01-23T04:56:07.000+00:00",
"samAccountName" : "samAccountName",
"dnsName" : "dnsName",
"description" : "description",
"distinguishedName" : "distinguishedName",
"dn" : "dn",
"lastKnownParent" : "lastKnownParent",
"timeLeftBeforePurge" : "timeLeftBeforePurge",
"ldapName" : "ldapName",
"managerEmail" : "managerEmail",
"hasInferiors" : true,
"userPrincipalName" : "userPrincipalName",
"userAccountControl" : 0,
"msdsPrincipalName" : "msdsPrincipalName",
"objectClass" : "objectClass",
"cn" : "cn",
"rawValues" : {
"key" : [ "", "" ]
},
"showInAdvancedViewOnly" : true,
"domain" : "domain",
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"name" : "name",
"objectSid" : "objectSid",
"attributes" : [ {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
}, {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
} ],
"pwdLastSet" : 6
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DeletedObjectUp
post /api/v{version}/collectors/activedirectory/recovery/password (apiVversionCollectorsActivedirectoryRecoveryPasswordPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body RecoveryRequest (optional)
Body Parameter —
Return type
Boolean
Example data
Content-Type: application/json
trueProduces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success BooleanUp
post /api/v{version}/collectors/activedirectory/recovery (apiVversionCollectorsActivedirectoryRecoveryPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body RecoveryRequest (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"exception" : {
"helpLink" : "helpLink",
"data" : {
"key" : ""
},
"targetSite" : {
"isStatic" : true,
"metadataToken" : 2,
"isAssembly" : true,
"isCollectible" : true,
"isHideBySig" : true,
"isSecurityTransparent" : true,
"isPrivate" : true,
"isSecuritySafeCritical" : true,
"isPublic" : true,
"isGenericMethod" : true,
"isFinal" : true,
"containsGenericParameters" : true,
"declaringType" : {
"isSealed" : true,
"genericParameterPosition" : 1,
"isAnsiClass" : true,
"metadataToken" : 6,
"isContextful" : true,
"isLayoutSequential" : true,
"isCollectible" : true,
"isNestedFamANDAssem" : true,
"isExplicitLayout" : true,
"isTypeDefinition" : true,
"isSecuritySafeCritical" : true,
"isGenericTypeDefinition" : true,
"isNestedPrivate" : true,
"isVariableBoundArray" : true,
"isInterface" : true,
"isNestedPublic" : true,
"isUnicodeClass" : true,
"isNestedAssembly" : true,
"isAutoLayout" : true,
"isPointer" : true,
"isSpecialName" : true,
"isVisible" : true,
"isSecurityCritical" : true,
"isNotPublic" : true,
"isNestedFamORAssem" : true,
"isMarshalByRef" : true,
"isGenericParameter" : true,
"isByRef" : true,
"name" : "name",
"isSerializable" : true,
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"isArray" : true,
"isPrimitive" : true,
"customAttributes" : [ {
"namedArguments" : [ {
"isField" : true,
"memberName" : "memberName"
}, {
"isField" : true,
"memberName" : "memberName"
} ],
"constructor" : {
"isStatic" : true,
"metadataToken" : 3,
"isAssembly" : true,
"isCollectible" : true,
"isHideBySig" : true,
"isSecurityTransparent" : true,
"isPrivate" : true,
"isSecuritySafeCritical" : true,
"isPublic" : true,
"isGenericMethod" : true,
"isFinal" : true,
"containsGenericParameters" : true,
"isGenericMethodDefinition" : true,
"module" : {
"metadataToken" : 6,
"mdStreamVersion" : 8,
"scopeName" : "scopeName",
"assembly" : {
"isDynamic" : true,
"codeBase" : "codeBase",
"isCollectible" : true,
"escapedCodeBase" : "escapedCodeBase",
"fullName" : "fullName",
"reflectionOnly" : true,
"modules" : [ null, null ],
"hostContext" : 9,
"definedTypes" : [ {
"isSealed" : true,
"genericParameterPosition" : 5,
"isAnsiClass" : true,
"metadataToken" : 1,
"isContextful" : true,
"isLayoutSequential" : true,
"isCollectible" : true,
"isNestedFamANDAssem" : true,
"isExplicitLayout" : true,
"isTypeDefinition" : true,
"isSecuritySafeCritical" : true,
"declaredConstructors" : [ null, null ],
"isGenericTypeDefinition" : true,
"declaredFields" : [ {
"isStatic" : true,
"metadataToken" : 1,
"isAssembly" : true,
"isCollectible" : true,
"isSecurityTransparent" : true,
"isPrivate" : true,
"isNotSerialized" : true,
"isSecuritySafeCritical" : true,
"fieldHandle" : { },
"isInitOnly" : true,
"isPublic" : true,
"isFamilyOrAssembly" : true,
"isSpecialName" : true,
"isFamily" : true,
"isSecurityCritical" : true,
"isPinvokeImpl" : true,
"isLiteral" : true,
"isFamilyAndAssembly" : true,
"name" : "name",
"attributes" : 4,
"customAttributes" : [ null, null ]
}, {
"isStatic" : true,
"metadataToken" : 1,
"isAssembly" : true,
"isCollectible" : true,
"isSecurityTransparent" : true,
"isPrivate" : true,
"isNotSerialized" : true,
"isSecuritySafeCritical" : true,
"fieldHandle" : { },
"isInitOnly" : true,
"isPublic" : true,
"isFamilyOrAssembly" : true,
"isSpecialName" : true,
"isFamily" : true,
"isSecurityCritical" : true,
"isPinvokeImpl" : true,
"isLiteral" : true,
"isFamilyAndAssembly" : true,
"name" : "name",
"attributes" : 4,
"customAttributes" : [ null, null ]
} ],
"declaredMembers" : [ null, null ],
"isNestedPrivate" : true,
"isVariableBoundArray" : true,
"isInterface" : true,
"isNestedPublic" : true,
"isUnicodeClass" : true,
"isNestedAssembly" : true,
"isAutoLayout" : true,
"isPointer" : true,
"isSpecialName" : true,
"isVisible" : true,
"isSecurityCritical" : true,
"isNotPublic" : true,
"isNestedFamORAssem" : true,
"isMarshalByRef" : true,
"isGenericParameter" : true,
"isByRef" : true,
"genericTypeParameters" : [ null, null ],
"name" : "name",
"isSerializable" : true,
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"isArray" : true,
"declaredNestedTypes" : [ null, null ],
"isPrimitive" : true,
"customAttributes" : [ null, null ],
"isCOMObject" : true,
"isGenericTypeParameter" : true,
"isGenericMethodParameter" : true,
"isSecurityTransparent" : true,
"declaredMethods" : [ null, null ],
"genericParameterAttributes" : 5,
"isAutoClass" : true,
"assemblyQualifiedName" : "assemblyQualifiedName",
"isValueType" : true,
"isGenericType" : true,
"isPublic" : true,
"containsGenericParameters" : true,
"isByRefLike" : true,
"isClass" : true,
"isImport" : true,
"typeHandle" : {
"value" : { }
},
"declaredProperties" : [ {
"metadataToken" : 5,
"canRead" : true,
"isCollectible" : true,
"canWrite" : true,
"isSpecialName" : true,
"name" : "name",
"attributes" : 9,
"customAttributes" : [ null, null ]
}, {
"metadataToken" : 5,
"canRead" : true,
"isCollectible" : true,
"canWrite" : true,
"isSpecialName" : true,
"name" : "name",
"attributes" : 9,
"customAttributes" : [ null, null ]
} ],
"isNested" : true,
"fullName" : "fullName",
"isEnum" : true,
"isAbstract" : true,
"isSignatureType" : true,
"declaredEvents" : [ {
"metadataToken" : 9,
"isCollectible" : true,
"isSpecialName" : true,
"name" : "name",
"attributes" : 3,
"isMulticast" : true,
"customAttributes" : [ null, null ],
"addMethod" : {
"isStatic" : true,
"methodHandle" : { },
"returnTypeCustomAttributes" : { },
"metadataToken" : 2,
"callingConvention" : 1,
"isAssembly" : true,
"returnParameter" : {
"hasDefaultValue" : true,
"metadataToken" : 7,
"defaultValue" : "",
"isOptional" : true,
"rawDefaultValue" : "",
"isRetval" : true,
"member" : {
"metadataToken" : 1,
"isCollectible" : true,
"name" : "name",
"customAttributes" : [ null, null ]
},
"name" : "name",
"isLcid" : true,
"isOut" : true,
"attributes" : 1,
"position" : 6,
"isIn" : true,
"customAttributes" : [ null, null ]
},
"isCollectible" : true,
"isHideBySig" : true,
"isSecurityTransparent" : true,
"isPrivate" : true,
"isSecuritySafeCritical" : true,
"methodImplementationFlags" : 7,
"isPublic" : true,
"isGenericMethod" : true,
"isFinal" : true,
"containsGenericParameters" : true,
"isGenericMethodDefinition" : true,
"isFamilyOrAssembly" : true,
"isSpecialName" : true,
"isFamily" : true,
"isSecurityCritical" : true,
"isAbstract" : true,
"isConstructedGenericMethod" : true,
"isConstructor" : true,
"isFamilyAndAssembly" : true,
"name" : "name",
"attributes" : 4,
"isVirtual" : true,
"customAttributes" : [ null, null ]
}
}, {
"metadataToken" : 9,
"isCollectible" : true,
"isSpecialName" : true,
"name" : "name",
"attributes" : 3,
"isMulticast" : true,
"customAttributes" : [ null, null ],
"addMethod" : {
"isStatic" : true,
"methodHandle" : { },
"returnTypeCustomAttributes" : { },
"metadataToken" : 2,
"callingConvention" : 1,
"isAssembly" : true,
"returnParameter" : {
"hasDefaultValue" : true,
"metadataToken" : 7,
"defaultValue" : "",
"isOptional" : true,
"rawDefaultValue" : "",
"isRetval" : true,
"member" : {
"metadataToken" : 1,
"isCollectible" : true,
"name" : "name",
"customAttributes" : [ null, null ]
},
"name" : "name",
"isLcid" : true,
"isOut" : true,
"attributes" : 1,
"position" : 6,
"isIn" : true,
"customAttributes" : [ null, null ]
},
"isCollectible" : true,
"isHideBySig" : true,
"isSecurityTransparent" : true,
"isPrivate" : true,
"isSecuritySafeCritical" : true,
"methodImplementationFlags" : 7,
"isPublic" : true,
"isGenericMethod" : true,
"isFinal" : true,
"containsGenericParameters" : true,
"isGenericMethodDefinition" : true,
"isFamilyOrAssembly" : true,
"isSpecialName" : true,
"isFamily" : true,
"isSecurityCritical" : true,
"isAbstract" : true,
"isConstructedGenericMethod" : true,
"isConstructor" : true,
"isFamilyAndAssembly" : true,
"name" : "name",
"attributes" : 4,
"isVirtual" : true,
"customAttributes" : [ null, null ]
}
} ],
"implementedInterfaces" : [ null, null ],
"isSZArray" : true,
"isNestedFamily" : true,
"structLayoutAttribute" : {
"typeId" : "",
"value" : 7
},
"namespace" : "namespace",
"genericTypeArguments" : [ null, null ],
"isConstructedGenericType" : true,
"attributes" : 2,
"hasElementType" : true
}, {
"isSealed" : true,
"genericParameterPosition" : 5,
"isAnsiClass" : true,
"metadataToken" : 1,
"isContextful" : true,
"isLayoutSequential" : true,
"isCollectible" : true,
"isNestedFamANDAssem" : true,
"isExplicitLayout" : true,
"isTypeDefinition" : true,
"isSecuritySafeCritical" : true,
"declaredConstructors" : [ null, null ],
"isGenericTypeDefinition" : true,
"declaredFields" : [ {
"isStatic" : true,
"metadataToken" : 1,
"isAssembly" : true,
"isCollectible" : true,
"isSecurityTransparent" : true,
"isPrivate" : true,
"isNotSerialized" : true,
"isSecuritySafeCritical" : true,
"fieldHandle" : { },
"isInitOnly" : true,
"isPublic" : true,
"isFamilyOrAssembly" : true,
"isSpecialName" : true,
"isFamily" : true,
"isSecurityCritical" : true,
"isPinvokeImpl" : true,
"isLiteral" : true,
"isFamilyAndAssembly" : true,
"name" : "name",
"attributes" : 4,
"customAttributes" : [ null, null ]
}, {
"isStatic" : true,
"metadataToken" : 1,
"isAssembly" : true,
"isCollectible" : true,
"isSecurityTransparent" : true,
"isPrivate" : true,
"isNotSerialized" : true,
"isSecuritySafeCritical" : true,
"fieldHandle" : { },
"isInitOnly" : true,
"isPublic" : true,
"isFamilyOrAssembly" : true,
"isSpecialName" : true,
"isFamily" : true,
"isSecurityCritical" : true,
"isPinvokeImpl" : true,
"isLiteral" : true,
"isFamilyAndAssembly" : true,
"name" : "name",
"attributes" : 4,
"customAttributes" : [ null, null ]
} ],
"declaredMembers" : [ null, null ],
"isNestedPrivate" : true,
"isVariableBoundArray" : true,
"isInterface" : true,
"isNestedPublic" : true,
"isUnicodeClass" : true,
"isNestedAssembly" : true,
"isAutoLayout" : true,
"isPointer" : true,
"isSpecialName" : true,
"isVisible" : true,
"isSecurityCritical" : true,
"isNotPublic" : true,
"isNestedFamORAssem" : true,
"isMarshalByRef" : true,
"isGenericParameter" : true,
"isByRef" : true,
"genericTypeParameters" : [ null, null ],
"name" : "name",
"isSerializable" : true,
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"isArray" : true,
"declaredNestedTypes" : [ null, null ],
"isPrimitive" : true,
"customAttributes" : [ null, null ],
"isCOMObject" : true,
"isGenericTypeParameter" : true,
"isGenericMethodParameter" : true,
"isSecurityTransparent" : true,
"declaredMethods" : [ null, null ],
"genericParameterAttributes" : 5,
"isAutoClass" : true,
"assemblyQualifiedName" : "assemblyQualifiedName",
"isValueType" : true,
"isGenericType" : true,
"isPublic" : true,
"containsGenericParameters" : true,
"isByRefLike" : true,
"isClass" : true,
"isImport" : true,
"typeHandle" : {
"value" : { }
},
"declaredProperties" : [ {
"metadataToken" : 5,
"canRead" : true,
"isCollectible" : true,
"canWrite" : true,
"isSpecialName" : true,
"name" : "name",
"attributes" : 9,
"customAttributes" : [ null, null ]
}, {
"metadataToken" : 5,
"canRead" : true,
"isCollectible" : true,
"canWrite" : true,
"isSpecialName" : true,
"name" : "name",
"attributes" : 9,
"customAttributes" : [ null, null ]
} ],
"isNested" : true,
"fullName" : "fullName",
"isEnum" : true,
"isAbstract" : true,
"isSignatureType" : true,
"declaredEvents" : [ {
"metadataToken" : 9,
"isCollectible" : true,
"isSpecialName" : true,
"name" : "name",
"attributes" : 3,
"isMulticast" : true,
"customAttributes" : [ null, null ],
"addMethod" : {
"isStatic" : true,
"methodHandle" : { },
"returnTypeCustomAttributes" : { },
"metadataToken" : 2,
"callingConvention" : 1,
"isAssembly" : true,
"returnParameter" : {
"hasDefaultValue" : true,
"metadataToken" : 7,
"defaultValue" : "",
"isOptional" : true,
"rawDefaultValue" : "",
"isRetval" : true,
"member" : {
"metadataToken" : 1,
"isCollectible" : true,
"name" : "name",
"customAttributes" : [ null, null ]
},
"name" : "name",
"isLcid" : true,
"isOut" : true,
"attributes" : 1,
"position" : 6,
"isIn" : true,
"customAttributes" : [ null, null ]
},
"isCollectible" : true,
"isHideBySig" : true,
"isSecurityTransparent" : true,
"isPrivate" : true,
"isSecuritySafeCritical" : true,
"methodImplementationFlags" : 7,
"isPublic" : true,
"isGenericMethod" : true,
"isFinal" : true,
"containsGenericParameters" : true,
"isGenericMethodDefinition" : true,
"isFamilyOrAssembly" : true,
"isSpecialName" : true,
"isFamily" : true,
"isSecurityCritical" : true,
"isAbstract" : true,
"isConstructedGenericMethod" : true,
"isConstructor" : true,
"isFamilyAndAssembly" : true,
"name" : "name",
"attributes" : 4,
"isVirtual" : true,
"customAttributes" : [ null, null ]
}
}, {
"metadataToken" : 9,
"isCollectible" : true,
"isSpecialName" : true,
"name" : "name",
"attributes" : 3,
"isMulticast" : true,
"customAttributes" : [ null, null ],
"addMethod" : {
"isStatic" : true,
"methodHandle" : { },
"returnTypeCustomAttributes" : { },
"metadataToken" : 2,
"callingConvention" : 1,
"isAssembly" : true,
"returnParameter" : {
"hasDefaultValue" : true,
"metadataToken" : 7,
"defaultValue" : "",
"isOptional" : true,
"rawDefaultValue" : "",
"isRetval" : true,
"member" : {
"metadataToken" : 1,
"isCollectible" : true,
"name" : "name",
"customAttributes" : [ null, null ]
},
"name" : "name",
"isLcid" : true,
"isOut" : true,
"attributes" : 1,
"position" : 6,
"isIn" : true,
"customAttributes" : [ null, null ]
},
"isCollectible" : true,
"isHideBySig" : true,
"isSecurityTransparent" : true,
"isPrivate" : true,
"isSecuritySafeCritical" : true,
"methodImplementationFlags" : 7,
"isPublic" : true,
"isGenericMethod" : true,
"isFinal" : true,
"containsGenericParameters" : true,
"isGenericMethodDefinition" : true,
"isFamilyOrAssembly" : true,
"isSpecialName" : true,
"isFamily" : true,
"isSecurityCritical" : true,
"isAbstract" : true,
"isConstructedGenericMethod" : true,
"isConstructor" : true,
"isFamilyAndAssembly" : true,
"name" : "name",
"attributes" : 4,
"isVirtual" : true,
"customAttributes" : [ null, null ]
}
} ],
"implementedInterfaces" : [ null, null ],
"isSZArray" : true,
"isNestedFamily" : true,
"structLayoutAttribute" : {
"typeId" : "",
"value" : 7
},
"namespace" : "namespace",
"genericTypeArguments" : [ null, null ],
"isConstructedGenericType" : true,
"attributes" : 2,
"hasElementType" : true
} ],
"exportedTypes" : [ null, null ],
"isFullyTrusted" : true,
"location" : "location",
"globalAssemblyCache" : true,
"imageRuntimeVersion" : "imageRuntimeVersion",
"securityRuleSet" : 6,
"customAttributes" : [ null, null ]
},
"name" : "name",
"moduleVersionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"moduleHandle" : {
"mdStreamVersion" : 9
},
"fullyQualifiedName" : "fullyQualifiedName",
"customAttributes" : [ null, null ]
},
"isFamilyOrAssembly" : true,
"isSpecialName" : true,
"isFamily" : true,
"isSecurityCritical" : true,
"isAbstract" : true,
"isConstructedGenericMethod" : true,
"isConstructor" : true,
"isFamilyAndAssembly" : true,
"name" : "name",
"isVirtual" : true,
"customAttributes" : [ null, null ]
},
"constructorArguments" : [ {
"value" : ""
}, {
"value" : ""
} ]
}, {
"namedArguments" : [ {
"isField" : true,
"memberName" : "memberName"
}, {
"isField" : true,
"memberName" : "memberName"
} ],
"constructor" : {
"isStatic" : true,
"metadataToken" : 3,
"isAssembly" : true,
"isCollectible" : true,
"isHideBySig" : true,
"isSecurityTransparent" : true,
"isPrivate" : true,
"isSecuritySafeCritical" : true,
"isPublic" : true,
"isGenericMethod" : true,
"isFinal" : true,
"containsGenericParameters" : true,
"isGenericMethodDefinition" : true,
"module" : {
"metadataToken" : 6,
"mdStreamVersion" : 8,
"scopeName" : "scopeName",
"assembly" : {
"isDynamic" : true,
"codeBase" : "codeBase",
"isCollectible" : true,
"escapedCodeBase" : "escapedCodeBase",
"fullName" : "fullName",
"reflectionOnly" : true,
"modules" : [ null, null ],
"hostContext" : 9,
"definedTypes" : [ {
"isSealed" : true,
"genericParameterPosition" : 5,
"isAnsiClass" : true,
"metadataToken" : 1,
"isContextful" : true,
"isLayoutSequential" : true,
"isCollectible" : true,
"isNestedFamANDAssem" : true,
"isExplicitLayout" : true,
"isTypeDefinition" : true,
"isSecuritySafeCritical" : true,
"declaredConstructors" : [ null, null ],
"isGenericTypeDefinition" : true,
"declaredFields" : [ {
"isStatic" : true,
"metadataToken" : 1,
"isAssembly" : true,
"isCollectible" : true,
"isSecurityTransparent" : true,
"isPrivate" : true,
"isNotSerialized" : true,
"isSecuritySafeCritical" : true,
"fieldHandle" : { },
"isInitOnly" : true,
"isPublic" : true,
"isFamilyOrAssembly" : true,
"isSpecialName" : true,
"isFamily" : true,
"isSecurityCritical" : true,
"isPinvokeImpl" : true,
"isLiteral" : true,
"isFamilyAndAssembly" : true,
"name" : "name",
"attributes" : 4,
"customAttributes" : [ null, null ]
}, {
"isStatic" : true,
"metadataToken" : 1,
"isAssembly" : true,
"isCollectible" : true,
"isSecurityTransparent" : true,
"isPrivate" : true,
"isNotSerialized" : true,
"isSecuritySafeCritical" : true,
"fieldHandle" : { },
"isInitOnly" : true,
"isPublic" : true,
"isFamilyOrAssembly" : true,
"isSpecialName" : true,
"isFamily" : true,
"isSecurityCritical" : true,
"isPinvokeImpl" : true,
"isLiteral" : true,
"isFamilyAndAssembly" : true,
"name" : "name",
"attributes" : 4,
"customAttributes" : [ null, null ]
} ],
"declaredMembers" : [ null, null ],
"isNestedPrivate" : true,
"isVariableBoundArray" : true,
"isInterface" : true,
"isNestedPublic" : true,
"isUnicodeClass" : true,
"isNestedAssembly" : true,
"isAutoLayout" : true,
"isPointer" : true,
"isSpecialName" : true,
"isVisible" : true,
"isSecurityCritical" : true,
"isNotPublic" : true,
"isNestedFamORAssem" : true,
"isMarshalByRef" : true,
"isGenericParameter" : true,
"isByRef" : true,
"genericTypeParameters" : [ null, null ],
"name" : "name",
"isSerializable" : true,
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"isArray" : true,
"declaredNestedTypes" : [ null, null ],
"isPrimitive" : true,
"customAttributes" : [ null, null ],
"isCOMObject" : true,
"isGenericTypeParameter" : true,
"isGenericMethodParameter" : true,
"isSecurityTransparent" : true,
"declaredMethods" : [ null, null ],
"genericParameterAttributes" : 5,
"isAutoClass" : true,
"assemblyQualifiedName" : "assemblyQualifiedName",
"isValueType" : true,
"isGenericType" : true,
"isPublic" : true,
"containsGenericParameters" : true,
"isByRefLike" : true,
"isClass" : true,
"isImport" : true,
"typeHandle" : {
"value" : { }
},
"declaredProperties" : [ {
"metadataToken" : 5,
"canRead" : true,
"isCollectible" : true,
"canWrite" : true,
"isSpecialName" : true,
"name" : "name",
"attributes" : 9,
"customAttributes" : [ null, null ]
}, {
"metadataToken" : 5,
"canRead" : true,
"isCollectible" : true,
"canWrite" : true,
"isSpecialName" : true,
"name" : "name",
"attributes" : 9,
"customAttributes" : [ null, null ]
} ],
"isNested" : true,
"fullName" : "fullName",
"isEnum" : true,
"isAbstract" : true,
"isSignatureType" : true,
"declaredEvents" : [ {
"metadataToken" : 9,
"isCollectible" : true,
"isSpecialName" : true,
"name" : "name",
"attributes" : 3,
"isMulticast" : true,
"customAttributes" : [ null, null ],
"addMethod" : {
"isStatic" : true,
"methodHandle" : { },
"returnTypeCustomAttributes" : { },
"metadataToken" : 2,
"callingConvention" : 1,
"isAssembly" : true,
"returnParameter" : {
"hasDefaultValue" : true,
"metadataToken" : 7,
"defaultValue" : "",
"isOptional" : true,
"rawDefaultValue" : "",
"isRetval" : true,
"member" : {
"metadataToken" : 1,
"isCollectible" : true,
"name" : "name",
"customAttributes" : [ null, null ]
},
"name" : "name",
"isLcid" : true,
"isOut" : true,
"attributes" : 1,
"position" : 6,
"isIn" : true,
"customAttributes" : [ null, null ]
},
"isCollectible" : true,
"isHideBySig" : true,
"isSecurityTransparent" : true,
"isPrivate" : true,
"isSecuritySafeCritical" : true,
"methodImplementationFlags" : 7,
"isPublic" : true,
"isGenericMethod" : true,
"isFinal" : true,
"containsGenericParameters" : true,
"isGenericMethodDefinition" : true,
"isFamilyOrAssembly" : true,
"isSpecialName" : true,
"isFamily" : true,
"isSecurityCritical" : true,
"isAbstract" : true,
"isConstructedGenericMethod" : true,
"isConstructor" : true,
"isFamilyAndAssembly" : true,
"name" : "name",
"attributes" : 4,
"isVirtual" : true,
"customAttributes" : [ null, null ]
}
}, {
"metadataToken" : 9,
"isCollectible" : true,
"isSpecialName" : true,
"name" : "name",
"attributes" : 3,
"isMulticast" : true,
"customAttributes" : [ null, null ],
"addMethod" : {
"isStatic" : true,
"methodHandle" : { },
"returnTypeCustomAttributes" : { },
"metadataToken" : 2,
"callingConvention" : 1,
"isAssembly" : true,
"returnParameter" : {
"hasDefaultValue" : true,
"metadataToken" : 7,
"defaultValue" : "",
"isOptional" : true,
"rawDefaultValue" : "",
"isRetval" : true,
"member" : {
"metadataToken" : 1,
"isCollectible" : true,
"name" : "name",
"customAttributes" : [ null, null ]
},
"name" : "name",
"isLcid" : true,
"isOut" : true,
"attributes" : 1,
"position" : 6,
"isIn" : true,
"customAttributes" : [ null, null ]
},
"isCollectible" : true,
"isHideBySig" : true,
"isSecurityTransparent" : true,
"isPrivate" : true,
"isSecuritySafeCritical" : true,
"methodImplementationFlags" : 7,
"isPublic" : true,
"isGenericMethod" : true,
"isFinal" : true,
"containsGenericParameters" : true,
"isGenericMethodDefinition" : true,
"isFamilyOrAssembly" : true,
"isSpecialName" : true,
"isFamily" : true,
"isSecurityCritical" : true,
"isAbstract" : true,
"isConstructedGenericMethod" : true,
"isConstructor" : true,
"isFamilyAndAssembly" : true,
"name" : "name",
"attributes" : 4,
"isVirtual" : true,
"customAttributes" : [ null, null ]
}
} ],
"implementedInterfaces" : [ null, null ],
"isSZArray" : true,
"isNestedFamily" : true,
"structLayoutAttribute" : {
"typeId" : "",
"value" : 7
},
"namespace" : "namespace",
"genericTypeArguments" : [ null, null ],
"isConstructedGenericType" : true,
"attributes" : 2,
"hasElementType" : true
}, {
"isSealed" : true,
"genericParameterPosition" : 5,
"isAnsiClass" : true,
"metadataToken" : 1,
"isContextful" : true,
"isLayoutSequential" : true,
"isCollectible" : true,
"isNestedFamANDAssem" : true,
"isExplicitLayout" : true,
"isTypeDefinition" : true,
"isSecuritySafeCritical" : true,
"declaredConstructors" : [ null, null ],
"isGenericTypeDefinition" : true,
"declaredFields" : [ {
"isStatic" : true,
"metadataToken" : 1,
"isAssembly" : true,
"isCollectible" : true,
"isSecurityTransparent" : true,
"isPrivate" : true,
"isNotSerialized" : true,
"isSecuritySafeCritical" : true,
"fieldHandle" : { },
"isInitOnly" : true,
"isPublic" : true,
"isFamilyOrAssembly" : true,
"isSpecialName" : true,
"isFamily" : true,
"isSecurityCritical" : true,
"isPinvokeImpl" : true,
"isLiteral" : true,
"isFamilyAndAssembly" : true,
"name" : "name",
"attributes" : 4,
"customAttributes" : [ null, null ]
}, {
"isStatic" : true,
"metadataToken" : 1,
"isAssembly" : true,
"isCollectible" : true,
"isSecurityTransparent" : true,
"isPrivate" : true,
"isNotSerialized" : true,
"isSecuritySafeCritical" : true,
"fieldHandle" : { },
"isInitOnly" : true,
"isPublic" : true,
"isFamilyOrAssembly" : true,
"isSpecialName" : true,
"isFamily" : true,
"isSecurityCritical" : true,
"isPinvokeImpl" : true,
"isLiteral" : true,
"isFamilyAndAssembly" : true,
"name" : "name",
"attributes" : 4,
"customAttributes" : [ null, null ]
} ],
"declaredMembers" : [ null, null ],
"isNestedPrivate" : true,
"isVariableBoundArray" : true,
"isInterface" : true,
"isNestedPublic" : true,
"isUnicodeClass" : true,
"isNestedAssembly" : true,
"isAutoLayout" : true,
"isPointer" : true,
"isSpecialName" : true,
"isVisible" : true,
"isSecurityCritical" : true,
"isNotPublic" : true,
"isNestedFamORAssem" : true,
"isMarshalByRef" : true,
"isGenericParameter" : true,
"isByRef" : true,
"genericTypeParameters" : [ null, null ],
"name" : "name",
"isSerializable" : true,
"guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"isArray" : true,
"declaredNestedTypes" : [ null, null ],
"isPrimitive" : true,
"customAttributes" : [ null, null ],
"isCOMObject" : true,
"isGenericTypeParameter" : true,
"isGenericMethodParameter" : true,
"isSecurityTransparent" : true,
"declaredMethods" : [ null, null ],
"genericParameterAttributes" : 5,
"isAutoClass" : true,
"assemblyQualifiedName" : "assemblyQualifiedName",
"isValueType" : true,
"isGenericType" : true,
"isPublic" : true,
"containsGenericParameters" : true,
"isByRefLike" : true,
"isClass" : true,
"isImport" : true,
"typeHandle" : {
"value" : { }
},
"declaredProperties" : [ {
"metadataToken" : 5,
"canRead" : true,
"isCollectible" : true,
"canWrite" : true,
"isSpecialName" : true,
"name" : "name",
"attributes" : 9,
"customAttributes" : [ null, null ]
}, {
"metadataToken" : 5,
"canRead" : true,
"isCollectible" : true,
"canWrite" : true,
"isSpecialName" : true,
"name" : "name",
"attributes" : 9,
"customAttributes" : [ null, null ]
} ],
"isNested" : true,
"fullName" : "fullName",
"isEnum" : true,
"isAbstract" : true,
"isSignatureType" : true,
"declaredEvents" : [ {
"metadataToken" : 9,
"isCollectible" : true,
"isSpecialName" : true,
"name" : "name",
"attributes" : 3,
"isMulticast" : true,
"customAttributes" : [ null, null ],
"addMethod" : {
"isStatic" : true,
"methodHandle" : { },
"returnTypeCustomAttributes" : { },
"metadataToken" : 2,
"callingConvention" : 1,
"isAssembly" : true,
"returnParameter" : {
"hasDefaultValue" : true,
"metadataToken" : 7,
"defaultValue" : "",
"isOptional" : true,
"rawDefaultValue" : "",
"isRetval" : true,
"member" : {
"metadataToken" : 1,
"isCollectible" : true,
"name" : "name",
"customAttributes" : [ null, null ]
},
"name" : "name",
"isLcid" : true,
"isOut" : true,
"attributes" : 1,
"position" : 6,
"isIn" : true,
"customAttributes" : [ null, null ]
},
"isCollectible" : true,
"isHideBySig" : true,
"isSecurityTransparent" : true,
"isPrivate" : true,
"isSecuritySafeCritical" : true,
"methodImplementationFlags" : 7,
"isPublic" : true,
"isGenericMethod" : true,
"isFinal" : true,
"containsGenericParameters" : true,
"isGenericMethodDefinition" : true,
"isFamilyOrAssembly" : true,
"isSpecialName" : true,
"isFamily" : true,
"isSecurityCritical" : true,
"isAbstract" : true,
"isConstructedGenericMethod" : true,
"isConstructor" : true,
"isFamilyAndAssembly" : true,
"name" : "name",
"attributes" : 4,
"isVirtual" : true,
"customAttributes" : [ null, null ]
}
}, {
"metadataToken" : 9,
"isCollectible" : true,
"isSpecialName" : true,
"name" : "name",
"attributes" : 3,
"isMulticast" : true,
"customAttributes" : [ null, null ],
"addMethod" : {
"isStatic" : true,
"methodHandle" : { },
"returnTypeCustomAttributes" : { },
"metadataToken" : 2,
"callingConvention" : 1,
"isAssembly" : true,
"returnParameter" : {
"hasDefaultValue" : true,
"metadataToken" : 7,
"defaultValue" : "",
"isOptional" : true,
"rawDefaultValue" : "",
"isRetval" : true,
"member" : {
"metadataToken" : 1,
"isCollectible" : true,
"name" : "name",
"customAttributes" : [ null, null ]
},
"name" : "name",
"isLcid" : true,
"isOut" : true,
"attributes" : 1,
"position" : 6,
"isIn" : true,
"customAttributes" : [ null, null ]
},
"isCollectible" : true,
"isHideBySig" : true,
"isSecurityTransparent" : true,
"isPrivate" : true,
"isSecuritySafeCritical" : true,
"methodImplementationFlags" : 7,
"isPublic" : true,
"isGenericMethod" : true,
"isFinal" : true,
"containsGenericParameters" : true,
"isGenericMethodDefinition" : true,
"isFamilyOrAssembly" : true,
"isSpecialName" : true,
"isFamily" : true,
"isSecurityCritical" : true,
"isAbstract" : true,
"isConstructedGenericMethod" : true,
"isConstructor" : true,
"isFamilyAndAssembly" : true,
"name" : "name",
"attributes" : 4,
"isVirtual" : true,
"customAttributes" : [ null, null ]
}
} ],
"implementedInterfaces" : [ null, null ],
"isSZArray" : true,
"isNestedFamily" : true,
"structLayoutAttribute" : {
"typeId" : "",
"value" : 7
},
"namespace" : "namespace",
"genericTypeArguments" : [ null, null ],
"isConstructedGenericType" : true,
"attributes" : 2,
"hasElementType" : true
} ],
"exportedTypes" : [ null, null ],
"isFullyTrusted" : true,
"location" : "location",
"globalAssemblyCache" : true,
"imageRuntimeVersion" : "imageRuntimeVersion",
"securityRuleSet" : 6,
"customAttributes" : [ null, null ]
},
"name" : "name",
"moduleVersionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"moduleHandle" : {
"mdStreamVersion" : 9
},
"fullyQualifiedName" : "fullyQualifiedName",
"customAttributes" : [ null, null ]
},
"isFamilyOrAssembly" : true,
"isSpecialName" : true,
"isFamily" : true,
"isSecurityCritical" : true,
"isAbstract" : true,
"isConstructedGenericMethod" : true,
"isConstructor" : true,
"isFamilyAndAssembly" : true,
"name" : "name",
"isVirtual" : true,
"customAttributes" : [ null, null ]
},
"constructorArguments" : [ {
"value" : ""
}, {
"value" : ""
} ]
} ],
"isCOMObject" : true,
"isGenericTypeParameter" : true,
"isGenericMethodParameter" : true,
"isSecurityTransparent" : true,
"isAutoClass" : true,
"assemblyQualifiedName" : "assemblyQualifiedName",
"isValueType" : true,
"isGenericType" : true,
"isPublic" : true,
"containsGenericParameters" : true,
"isByRefLike" : true,
"isClass" : true,
"isImport" : true,
"isNested" : true,
"fullName" : "fullName",
"isEnum" : true,
"isAbstract" : true,
"isSignatureType" : true,
"isSZArray" : true,
"isNestedFamily" : true,
"namespace" : "namespace",
"genericTypeArguments" : [ null, null ],
"isConstructedGenericType" : true,
"hasElementType" : true
},
"isGenericMethodDefinition" : true,
"isFamilyOrAssembly" : true,
"isSpecialName" : true,
"isFamily" : true,
"isSecurityCritical" : true,
"isAbstract" : true,
"isConstructedGenericMethod" : true,
"isConstructor" : true,
"isFamilyAndAssembly" : true,
"name" : "name",
"memberType" : 6,
"isVirtual" : true,
"customAttributes" : [ null, null ]
},
"stackTrace" : "stackTrace",
"source" : "source",
"message" : "message",
"hResult" : 6
},
"item" : true,
"auditDetails" : "auditDetails",
"isException" : true,
"count" : 6,
"message" : "message",
"items" : [ true, true ],
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success BooleanCygTResultBaseRemoteLoggerConfiguration
Up
delete /api/v{version}/system/config/remotelogger (apiVversionSystemConfigRemoteloggerDelete)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
get /api/v{version}/system/config/remotelogger (apiVversionSystemConfigRemoteloggerGet)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"configInfo" : { },
"type" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success RemoteLoggerConfigurationXUp
post /api/v{version}/system/config/remotelogger (apiVversionSystemConfigRemoteloggerPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body RemoteLoggerConfigurationX (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"configInfo" : { },
"type" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success RemoteLoggerConfigurationXUp
put /api/v{version}/system/config/remotelogger (apiVversionSystemConfigRemoteloggerPut)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body RemoteLoggerConfigurationX (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"configInfo" : { },
"type" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success RemoteLoggerConfigurationXReport
Up
get /api/v{version}/reports/EventColumnsAlpha (apiVversionReportsEventColumnsAlphaGet)
Path parameters
version (required)
Path Parameter —
Query parameters
sources (optional)
Query Parameter — format: int32
Return type
map[String, array[AuditEventColumn]]
Example data
Content-Type: application/json
{
"key" : [ {
"isIntersecting" : true,
"hover" : {
"addAction" : 5,
"removeAction" : 2,
"field" : "field",
"position" : "position"
},
"visible" : true,
"sources" : [ 0, 0 ],
"isMetaEventColumn" : true,
"name" : "name",
"width" : {
"default" : 1,
"value" : 6,
"minimum" : 5
},
"header" : "header",
"position" : "position",
"type" : "type"
}, {
"isIntersecting" : true,
"hover" : {
"addAction" : 5,
"removeAction" : 2,
"field" : "field",
"position" : "position"
},
"visible" : true,
"sources" : [ 0, 0 ],
"isMetaEventColumn" : true,
"name" : "name",
"width" : {
"default" : 1,
"value" : 6,
"minimum" : 5
},
"header" : "header",
"position" : "position",
"type" : "type"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
get /api/v{version}/reports/EventColumns (apiVversionReportsEventColumnsGet)
Path parameters
version (required)
Path Parameter —
Query parameters
sources (optional)
Query Parameter — format: int32
Return type
map[String, array[AuditEventColumn]]
Example data
Content-Type: application/json
{
"key" : [ {
"isIntersecting" : true,
"hover" : {
"addAction" : 5,
"removeAction" : 2,
"field" : "field",
"position" : "position"
},
"visible" : true,
"sources" : [ 0, 0 ],
"isMetaEventColumn" : true,
"name" : "name",
"width" : {
"default" : 1,
"value" : 6,
"minimum" : 5
},
"header" : "header",
"position" : "position",
"type" : "type"
}, {
"isIntersecting" : true,
"hover" : {
"addAction" : 5,
"removeAction" : 2,
"field" : "field",
"position" : "position"
},
"visible" : true,
"sources" : [ 0, 0 ],
"isMetaEventColumn" : true,
"name" : "name",
"width" : {
"default" : 1,
"value" : 6,
"minimum" : 5
},
"header" : "header",
"position" : "position",
"type" : "type"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
post /api/v{version}/reports/export (apiVversionReportsExportPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body ReportRunnerJobInfo (optional)
Body Parameter —
Return type
byte[]
Example data
Content-Type: application/json
""Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success byte[]Up
get /api/v{version}/reports (apiVversionReportsGet)
Path parameters
version (required)
Path Parameter —
Query parameters
tags (optional)
Query Parameter —
tagIds (optional)
Query Parameter — format: uuid
Return type
array[ReportWeb]
Example data
Content-Type: application/json
[ {
"filter" : [ {
"childClauses" : [ null, null ],
"fieldName" : "fieldName",
"comparison" : 6,
"values" : [ {
"value2" : "value2",
"value" : "value"
}, {
"value2" : "value2",
"value" : "value"
} ],
"type" : 0
}, {
"childClauses" : [ null, null ],
"fieldName" : "fieldName",
"comparison" : 6,
"values" : [ {
"value2" : "value2",
"value" : "value"
}, {
"value2" : "value2",
"value" : "value"
} ],
"type" : 0
} ],
"access" : {
"createdByUserId" : "createdByUserId",
"createdByUserName" : "createdByUserName",
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"reportId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"modifiedByUserName" : "modifiedByUserName",
"id" : 5,
"isPrivate" : true,
"createdOn" : "2000-01-23T04:56:07.000+00:00",
"modifiedByUserId" : "modifiedByUserId",
"createdByUserType" : 5
},
"delegatedResources" : [ {
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
}, {
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
} ],
"isReadOnly" : true,
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type",
"actions" : [ {
"configuration" : "configuration",
"credentials" : {
"password" : "password",
"username" : "username"
},
"isEnabled" : true,
"type" : "type"
}, {
"configuration" : "configuration",
"credentials" : {
"password" : "password",
"username" : "username"
},
"isEnabled" : true,
"type" : "type"
} ],
"eventColumns" : [ {
"isIntersecting" : true,
"hover" : {
"addAction" : 5,
"removeAction" : 2,
"field" : "field",
"position" : "position"
},
"visible" : true,
"sources" : [ 0, 0 ],
"isMetaEventColumn" : true,
"name" : "name",
"width" : {
"default" : 1,
"value" : 6,
"minimum" : 5
},
"header" : "header",
"position" : "position",
"type" : "type"
}, {
"isIntersecting" : true,
"hover" : {
"addAction" : 5,
"removeAction" : 2,
"field" : "field",
"position" : "position"
},
"visible" : true,
"sources" : [ 0, 0 ],
"isMetaEventColumn" : true,
"name" : "name",
"width" : {
"default" : 1,
"value" : 6,
"minimum" : 5
},
"header" : "header",
"position" : "position",
"type" : "type"
} ],
"tags" : [ {
"origin" : 1,
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, {
"origin" : 1,
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
} ]
}, {
"filter" : [ {
"childClauses" : [ null, null ],
"fieldName" : "fieldName",
"comparison" : 6,
"values" : [ {
"value2" : "value2",
"value" : "value"
}, {
"value2" : "value2",
"value" : "value"
} ],
"type" : 0
}, {
"childClauses" : [ null, null ],
"fieldName" : "fieldName",
"comparison" : 6,
"values" : [ {
"value2" : "value2",
"value" : "value"
}, {
"value2" : "value2",
"value" : "value"
} ],
"type" : 0
} ],
"access" : {
"createdByUserId" : "createdByUserId",
"createdByUserName" : "createdByUserName",
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"reportId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"modifiedByUserName" : "modifiedByUserName",
"id" : 5,
"isPrivate" : true,
"createdOn" : "2000-01-23T04:56:07.000+00:00",
"modifiedByUserId" : "modifiedByUserId",
"createdByUserType" : 5
},
"delegatedResources" : [ {
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
}, {
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
} ],
"isReadOnly" : true,
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type",
"actions" : [ {
"configuration" : "configuration",
"credentials" : {
"password" : "password",
"username" : "username"
},
"isEnabled" : true,
"type" : "type"
}, {
"configuration" : "configuration",
"credentials" : {
"password" : "password",
"username" : "username"
},
"isEnabled" : true,
"type" : "type"
} ],
"eventColumns" : [ {
"isIntersecting" : true,
"hover" : {
"addAction" : 5,
"removeAction" : 2,
"field" : "field",
"position" : "position"
},
"visible" : true,
"sources" : [ 0, 0 ],
"isMetaEventColumn" : true,
"name" : "name",
"width" : {
"default" : 1,
"value" : 6,
"minimum" : 5
},
"header" : "header",
"position" : "position",
"type" : "type"
}, {
"isIntersecting" : true,
"hover" : {
"addAction" : 5,
"removeAction" : 2,
"field" : "field",
"position" : "position"
},
"visible" : true,
"sources" : [ 0, 0 ],
"isMetaEventColumn" : true,
"name" : "name",
"width" : {
"default" : 1,
"value" : 6,
"minimum" : 5
},
"header" : "header",
"position" : "position",
"type" : "type"
} ],
"tags" : [ {
"origin" : 1,
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, {
"origin" : 1,
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
} ]
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
delete /api/v{version}/reports/{id} (apiVversionReportsIdDelete)
Path parameters
id (required)
Path Parameter — format: uuid
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
get /api/v{version}/reports/{id} (apiVversionReportsIdGet)
Path parameters
id (required)
Path Parameter — format: uuid
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"filter" : [ {
"childClauses" : [ null, null ],
"fieldName" : "fieldName",
"comparison" : 6,
"values" : [ {
"value2" : "value2",
"value" : "value"
}, {
"value2" : "value2",
"value" : "value"
} ],
"type" : 0
}, {
"childClauses" : [ null, null ],
"fieldName" : "fieldName",
"comparison" : 6,
"values" : [ {
"value2" : "value2",
"value" : "value"
}, {
"value2" : "value2",
"value" : "value"
} ],
"type" : 0
} ],
"access" : {
"createdByUserId" : "createdByUserId",
"createdByUserName" : "createdByUserName",
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"reportId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"modifiedByUserName" : "modifiedByUserName",
"id" : 5,
"isPrivate" : true,
"createdOn" : "2000-01-23T04:56:07.000+00:00",
"modifiedByUserId" : "modifiedByUserId",
"createdByUserType" : 5
},
"delegatedResources" : [ {
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
}, {
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
} ],
"isReadOnly" : true,
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type",
"actions" : [ {
"configuration" : "configuration",
"credentials" : {
"password" : "password",
"username" : "username"
},
"isEnabled" : true,
"type" : "type"
}, {
"configuration" : "configuration",
"credentials" : {
"password" : "password",
"username" : "username"
},
"isEnabled" : true,
"type" : "type"
} ],
"eventColumns" : [ {
"isIntersecting" : true,
"hover" : {
"addAction" : 5,
"removeAction" : 2,
"field" : "field",
"position" : "position"
},
"visible" : true,
"sources" : [ 0, 0 ],
"isMetaEventColumn" : true,
"name" : "name",
"width" : {
"default" : 1,
"value" : 6,
"minimum" : 5
},
"header" : "header",
"position" : "position",
"type" : "type"
}, {
"isIntersecting" : true,
"hover" : {
"addAction" : 5,
"removeAction" : 2,
"field" : "field",
"position" : "position"
},
"visible" : true,
"sources" : [ 0, 0 ],
"isMetaEventColumn" : true,
"name" : "name",
"width" : {
"default" : 1,
"value" : 6,
"minimum" : 5
},
"header" : "header",
"position" : "position",
"type" : "type"
} ],
"tags" : [ {
"origin" : 1,
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, {
"origin" : 1,
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ReportWebUp
put /api/v{version}/reports/{id} (apiVversionReportsIdPut)
Path parameters
id (required)
Path Parameter — format: uuid
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body ReportWeb (optional)
Body Parameter —
Query parameters
isPrivate (optional)
Query Parameter — default: false
isOwnerToBeReset (optional)
Query Parameter — default: false
Return type
Example data
Content-Type: application/json
{
"filter" : [ {
"childClauses" : [ null, null ],
"fieldName" : "fieldName",
"comparison" : 6,
"values" : [ {
"value2" : "value2",
"value" : "value"
}, {
"value2" : "value2",
"value" : "value"
} ],
"type" : 0
}, {
"childClauses" : [ null, null ],
"fieldName" : "fieldName",
"comparison" : 6,
"values" : [ {
"value2" : "value2",
"value" : "value"
}, {
"value2" : "value2",
"value" : "value"
} ],
"type" : 0
} ],
"access" : {
"createdByUserId" : "createdByUserId",
"createdByUserName" : "createdByUserName",
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"reportId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"modifiedByUserName" : "modifiedByUserName",
"id" : 5,
"isPrivate" : true,
"createdOn" : "2000-01-23T04:56:07.000+00:00",
"modifiedByUserId" : "modifiedByUserId",
"createdByUserType" : 5
},
"delegatedResources" : [ {
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
}, {
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
} ],
"isReadOnly" : true,
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type",
"actions" : [ {
"configuration" : "configuration",
"credentials" : {
"password" : "password",
"username" : "username"
},
"isEnabled" : true,
"type" : "type"
}, {
"configuration" : "configuration",
"credentials" : {
"password" : "password",
"username" : "username"
},
"isEnabled" : true,
"type" : "type"
} ],
"eventColumns" : [ {
"isIntersecting" : true,
"hover" : {
"addAction" : 5,
"removeAction" : 2,
"field" : "field",
"position" : "position"
},
"visible" : true,
"sources" : [ 0, 0 ],
"isMetaEventColumn" : true,
"name" : "name",
"width" : {
"default" : 1,
"value" : 6,
"minimum" : 5
},
"header" : "header",
"position" : "position",
"type" : "type"
}, {
"isIntersecting" : true,
"hover" : {
"addAction" : 5,
"removeAction" : 2,
"field" : "field",
"position" : "position"
},
"visible" : true,
"sources" : [ 0, 0 ],
"isMetaEventColumn" : true,
"name" : "name",
"width" : {
"default" : 1,
"value" : 6,
"minimum" : 5
},
"header" : "header",
"position" : "position",
"type" : "type"
} ],
"tags" : [ {
"origin" : 1,
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, {
"origin" : 1,
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ReportWebUp
post /api/v{version}/reports/{id}/tags (apiVversionReportsIdTagsPost)
Path parameters
id (required)
Path Parameter — format: uuid
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body Tag (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"filter" : [ {
"childClauses" : [ null, null ],
"fieldName" : "fieldName",
"comparison" : 6,
"values" : [ {
"value2" : "value2",
"value" : "value"
}, {
"value2" : "value2",
"value" : "value"
} ],
"type" : 0
}, {
"childClauses" : [ null, null ],
"fieldName" : "fieldName",
"comparison" : 6,
"values" : [ {
"value2" : "value2",
"value" : "value"
}, {
"value2" : "value2",
"value" : "value"
} ],
"type" : 0
} ],
"access" : {
"createdByUserId" : "createdByUserId",
"createdByUserName" : "createdByUserName",
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"reportId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"modifiedByUserName" : "modifiedByUserName",
"id" : 5,
"isPrivate" : true,
"createdOn" : "2000-01-23T04:56:07.000+00:00",
"modifiedByUserId" : "modifiedByUserId",
"createdByUserType" : 5
},
"delegatedResources" : [ {
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
}, {
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
} ],
"isReadOnly" : true,
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type",
"actions" : [ {
"configuration" : "configuration",
"credentials" : {
"password" : "password",
"username" : "username"
},
"isEnabled" : true,
"type" : "type"
}, {
"configuration" : "configuration",
"credentials" : {
"password" : "password",
"username" : "username"
},
"isEnabled" : true,
"type" : "type"
} ],
"eventColumns" : [ {
"isIntersecting" : true,
"hover" : {
"addAction" : 5,
"removeAction" : 2,
"field" : "field",
"position" : "position"
},
"visible" : true,
"sources" : [ 0, 0 ],
"isMetaEventColumn" : true,
"name" : "name",
"width" : {
"default" : 1,
"value" : 6,
"minimum" : 5
},
"header" : "header",
"position" : "position",
"type" : "type"
}, {
"isIntersecting" : true,
"hover" : {
"addAction" : 5,
"removeAction" : 2,
"field" : "field",
"position" : "position"
},
"visible" : true,
"sources" : [ 0, 0 ],
"isMetaEventColumn" : true,
"name" : "name",
"width" : {
"default" : 1,
"value" : 6,
"minimum" : 5
},
"header" : "header",
"position" : "position",
"type" : "type"
} ],
"tags" : [ {
"origin" : 1,
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, {
"origin" : 1,
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ReportWebUp
post /api/v{version}/reports (apiVversionReportsPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body ReportWeb (optional)
Body Parameter —
Query parameters
isPrivate (optional)
Query Parameter — default: false
Return type
Example data
Content-Type: application/json
{
"filter" : [ {
"childClauses" : [ null, null ],
"fieldName" : "fieldName",
"comparison" : 6,
"values" : [ {
"value2" : "value2",
"value" : "value"
}, {
"value2" : "value2",
"value" : "value"
} ],
"type" : 0
}, {
"childClauses" : [ null, null ],
"fieldName" : "fieldName",
"comparison" : 6,
"values" : [ {
"value2" : "value2",
"value" : "value"
}, {
"value2" : "value2",
"value" : "value"
} ],
"type" : 0
} ],
"access" : {
"createdByUserId" : "createdByUserId",
"createdByUserName" : "createdByUserName",
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"reportId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"modifiedByUserName" : "modifiedByUserName",
"id" : 5,
"isPrivate" : true,
"createdOn" : "2000-01-23T04:56:07.000+00:00",
"modifiedByUserId" : "modifiedByUserId",
"createdByUserType" : 5
},
"delegatedResources" : [ {
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
}, {
"resourceId" : "resourceId",
"id" : 1,
"accounts" : [ {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
}, {
"isReadOnly" : true,
"displayName" : "displayName",
"domain" : "domain",
"objectClass" : 5,
"dn" : "dn",
"sid" : "sid"
} ],
"type" : 5
} ],
"isReadOnly" : true,
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type",
"actions" : [ {
"configuration" : "configuration",
"credentials" : {
"password" : "password",
"username" : "username"
},
"isEnabled" : true,
"type" : "type"
}, {
"configuration" : "configuration",
"credentials" : {
"password" : "password",
"username" : "username"
},
"isEnabled" : true,
"type" : "type"
} ],
"eventColumns" : [ {
"isIntersecting" : true,
"hover" : {
"addAction" : 5,
"removeAction" : 2,
"field" : "field",
"position" : "position"
},
"visible" : true,
"sources" : [ 0, 0 ],
"isMetaEventColumn" : true,
"name" : "name",
"width" : {
"default" : 1,
"value" : 6,
"minimum" : 5
},
"header" : "header",
"position" : "position",
"type" : "type"
}, {
"isIntersecting" : true,
"hover" : {
"addAction" : 5,
"removeAction" : 2,
"field" : "field",
"position" : "position"
},
"visible" : true,
"sources" : [ 0, 0 ],
"isMetaEventColumn" : true,
"name" : "name",
"width" : {
"default" : 1,
"value" : 6,
"minimum" : 5
},
"header" : "header",
"position" : "position",
"type" : "type"
} ],
"tags" : [ {
"origin" : 1,
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, {
"origin" : 1,
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ReportWebReportStyling
Up
get /api/v{version}/reportstylings (apiVversionReportstylingsGet)
Path parameters
version (required)
Path Parameter —
Return type
array[ReportStylingX]
Example data
Content-Type: application/json
[ {
"isItalic" : true,
"mappings" : {
"key" : 0
},
"textColour" : "textColour",
"isBold" : true,
"elementName" : "elementName"
}, {
"isItalic" : true,
"mappings" : {
"key" : 0
},
"textColour" : "textColour",
"isBold" : true,
"elementName" : "elementName"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
post /api/v{version}/reportstylings (apiVversionReportstylingsPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body ReportStylingX (optional)
Body Parameter —
Return type
array[ReportStylingX]
Example data
Content-Type: application/json
[ {
"isItalic" : true,
"mappings" : {
"key" : 0
},
"textColour" : "textColour",
"isBold" : true,
"elementName" : "elementName"
}, {
"isItalic" : true,
"mappings" : {
"key" : 0
},
"textColour" : "textColour",
"isBold" : true,
"elementName" : "elementName"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessRole
Up
get /api/v{version}/delegation/roles/accountsList role assignments (apiVversionDelegationRolesAccountsGet)
Retrieves roles and users these roles are assigned to.
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"roleId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"id" : 0,
"scopes" : [ {
"accountRoleId" : 5,
"displayName" : "displayName",
"id" : 1,
"configurationObject" : "configurationObject",
"type" : 5
}, {
"accountRoleId" : 5,
"displayName" : "displayName",
"id" : 1,
"configurationObject" : "configurationObject",
"type" : 5
} ],
"delegationAccount" : {
"identifier" : "identifier",
"displayName" : "displayName",
"roles" : [ {
"permissions" : [ {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
}, {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
} ],
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : 0
}, {
"permissions" : [ {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
}, {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
} ],
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : 0
} ],
"name" : "name",
"id" : 6,
"type" : "type",
"enabled" : true,
"lastLogon" : "2000-01-23T04:56:07.000+00:00"
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success AccountRoleWebUp
get /api/v{version}/delegation/rolesList roles (apiVversionDelegationRolesGet)
Retrieves a list of configured roles.
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"permissions" : [ {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
}, {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
} ],
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success RoleUp
get /api/v{version}/delegation/roles/{id}/accounts/{accountId}Retrieve account details (apiVversionDelegationRolesIdAccountsAccountIdGet)
Locates and retrieves details of a specific account that is assigned to a certain role.
Path parameters
id (required)
Path Parameter — The ID of the role format: uuid
accountId (required)
Path Parameter — The ID of the account format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"roleId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"id" : 0,
"scopes" : [ {
"accountRoleId" : 5,
"displayName" : "displayName",
"id" : 1,
"configurationObject" : "configurationObject",
"type" : 5
}, {
"accountRoleId" : 5,
"displayName" : "displayName",
"id" : 1,
"configurationObject" : "configurationObject",
"type" : 5
} ],
"delegationAccount" : {
"identifier" : "identifier",
"displayName" : "displayName",
"roles" : [ {
"permissions" : [ {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
}, {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
} ],
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : 0
}, {
"permissions" : [ {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
}, {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
} ],
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : 0
} ],
"name" : "name",
"id" : 6,
"type" : "type",
"enabled" : true,
"lastLogon" : "2000-01-23T04:56:07.000+00:00"
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success AccountRoleWebUp
put /api/v{version}/delegation/roles/{id}/accounts/{accountId}Update a user role assignment (apiVversionDelegationRolesIdAccountsAccountIdPut)
Locates and modifies a role assignemnt for a specific user account.
Path parameters
id (required)
Path Parameter — The ID of the role format: uuid
accountId (required)
Path Parameter — The ID of the account format: int32
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body AccountRoleWeb (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"roleId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"id" : 0,
"scopes" : [ {
"accountRoleId" : 5,
"displayName" : "displayName",
"id" : 1,
"configurationObject" : "configurationObject",
"type" : 5
}, {
"accountRoleId" : 5,
"displayName" : "displayName",
"id" : 1,
"configurationObject" : "configurationObject",
"type" : 5
} ],
"delegationAccount" : {
"identifier" : "identifier",
"displayName" : "displayName",
"roles" : [ {
"permissions" : [ {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
}, {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
} ],
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : 0
}, {
"permissions" : [ {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
}, {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
} ],
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : 0
} ],
"name" : "name",
"id" : 6,
"type" : "type",
"enabled" : true,
"lastLogon" : "2000-01-23T04:56:07.000+00:00"
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success AccountRoleWebUp
get /api/v{version}/delegation/roles/{id}/accountsList assignments for a role (apiVversionDelegationRolesIdAccountsGet)
Locates all user accounts assigned to a specific role. Provide 'roleID' as 'id' in the path.
Path parameters
id (required)
Path Parameter — The ID of the role format: uuid
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"roleId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"id" : 0,
"scopes" : [ {
"accountRoleId" : 5,
"displayName" : "displayName",
"id" : 1,
"configurationObject" : "configurationObject",
"type" : 5
}, {
"accountRoleId" : 5,
"displayName" : "displayName",
"id" : 1,
"configurationObject" : "configurationObject",
"type" : 5
} ],
"delegationAccount" : {
"identifier" : "identifier",
"displayName" : "displayName",
"roles" : [ {
"permissions" : [ {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
}, {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
} ],
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : 0
}, {
"permissions" : [ {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
}, {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
} ],
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : 0
} ],
"name" : "name",
"id" : 6,
"type" : "type",
"enabled" : true,
"lastLogon" : "2000-01-23T04:56:07.000+00:00"
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success AccountRoleWebUp
post /api/v{version}/delegation/roles/{id}/accountsCreate a role assignment (apiVversionDelegationRolesIdAccountsPost)
Adds a new role assignment entry to a role.
Path parameters
id (required)
Path Parameter — The ID of the role format: uuid
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body AccountRoleWeb (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"roleId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"id" : 0,
"scopes" : [ {
"accountRoleId" : 5,
"displayName" : "displayName",
"id" : 1,
"configurationObject" : "configurationObject",
"type" : 5
}, {
"accountRoleId" : 5,
"displayName" : "displayName",
"id" : 1,
"configurationObject" : "configurationObject",
"type" : 5
} ],
"delegationAccount" : {
"identifier" : "identifier",
"displayName" : "displayName",
"roles" : [ {
"permissions" : [ {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
}, {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
} ],
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : 0
}, {
"permissions" : [ {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
}, {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
} ],
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : 0
} ],
"name" : "name",
"id" : 6,
"type" : "type",
"enabled" : true,
"lastLogon" : "2000-01-23T04:56:07.000+00:00"
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success AccountRoleWebUp
delete /api/v{version}/delegation/roles/{id}Delete a role (apiVversionDelegationRolesIdDelete)
Locates a role by its ID and removes it.
Path parameters
id (required)
Path Parameter — The ID of the role format: uuid
version (required)
Path Parameter —
Responses
200
SuccessUp
get /api/v{version}/delegation/roles/{id}Retrieve a role (apiVversionDelegationRolesIdGet)
Locates a role and retrieves its details by the role ID.
Path parameters
id (required)
Path Parameter — The ID of the role format: uuid
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"permissions" : [ {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
}, {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
} ],
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success RoleUp
post /api/v{version}/delegation/rolesCreate a role (apiVversionDelegationRolesPost)
Adds a new role to Cygna Auditor delegation settings.
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body Role (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"permissions" : [ {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
}, {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
} ],
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success RoleUp
put /api/v{version}/delegation/rolesUpdate a role (apiVversionDelegationRolesPut)
Modifies an existing role. For example, adds or revokes permissions, changes the role name.
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body Role (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"permissions" : [ {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
}, {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
} ],
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success RoleUp
delete /api/v{version}/delegation/roles/{roleId}/accounts/{accountId}Delete a role assignment (apiVversionDelegationRolesRoleIdAccountsAccountIdDelete)
Revokes a specific role assignment. The user will no longer have the role. Provide 'roleId' and 'accountId' in the path.
Path parameters
roleId (required)
Path Parameter — The ID of the role format: uuid
accountId (required)
Path Parameter — The ID of the account format: int32
version (required)
Path Parameter —
Responses
200
SuccessScheduledJob
Up
get /api/v{version}/scheduledjobs (apiVversionScheduledjobsGet)
Path parameters
version (required)
Path Parameter —
Return type
array[ScheduledJobWeb]
Example data
Content-Type: application/json
[ {
"nextRunOn" : "2000-01-23T04:56:07.000+00:00",
"timingInfo" : {
"misfireRule" : 1,
"type" : 6,
"priority" : 5,
"effectiveDates" : {
"endAt" : "2000-01-23T04:56:07.000+00:00",
"startAt" : "2000-01-23T04:56:07.000+00:00"
}
},
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isEnabled" : true,
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"state" : 5,
"type" : 0,
"jobInfo" : { },
"lastRunOn" : "2000-01-23T04:56:07.000+00:00"
}, {
"nextRunOn" : "2000-01-23T04:56:07.000+00:00",
"timingInfo" : {
"misfireRule" : 1,
"type" : 6,
"priority" : 5,
"effectiveDates" : {
"endAt" : "2000-01-23T04:56:07.000+00:00",
"startAt" : "2000-01-23T04:56:07.000+00:00"
}
},
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isEnabled" : true,
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"state" : 5,
"type" : 0,
"jobInfo" : { },
"lastRunOn" : "2000-01-23T04:56:07.000+00:00"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
delete /api/v{version}/scheduledjobs/{id} (apiVversionScheduledjobsIdDelete)
Path parameters
id (required)
Path Parameter — format: uuid
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
get /api/v{version}/scheduledjobs/{id} (apiVversionScheduledjobsIdGet)
Path parameters
id (required)
Path Parameter — format: uuid
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"nextRunOn" : "2000-01-23T04:56:07.000+00:00",
"timingInfo" : {
"misfireRule" : 1,
"type" : 6,
"priority" : 5,
"effectiveDates" : {
"endAt" : "2000-01-23T04:56:07.000+00:00",
"startAt" : "2000-01-23T04:56:07.000+00:00"
}
},
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isEnabled" : true,
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"state" : 5,
"type" : 0,
"jobInfo" : { },
"lastRunOn" : "2000-01-23T04:56:07.000+00:00"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ScheduledJobWebUp
put /api/v{version}/scheduledjobs/{id} (apiVversionScheduledjobsIdPut)
Path parameters
id (required)
Path Parameter — format: uuid
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body ScheduledJobWeb (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"nextRunOn" : "2000-01-23T04:56:07.000+00:00",
"timingInfo" : {
"misfireRule" : 1,
"type" : 6,
"priority" : 5,
"effectiveDates" : {
"endAt" : "2000-01-23T04:56:07.000+00:00",
"startAt" : "2000-01-23T04:56:07.000+00:00"
}
},
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isEnabled" : true,
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"state" : 5,
"type" : 0,
"jobInfo" : { },
"lastRunOn" : "2000-01-23T04:56:07.000+00:00"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ScheduledJobWebUp
post /api/v{version}/scheduledjobs (apiVversionScheduledjobsPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body ScheduledJobWeb (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"nextRunOn" : "2000-01-23T04:56:07.000+00:00",
"timingInfo" : {
"misfireRule" : 1,
"type" : 6,
"priority" : 5,
"effectiveDates" : {
"endAt" : "2000-01-23T04:56:07.000+00:00",
"startAt" : "2000-01-23T04:56:07.000+00:00"
}
},
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isEnabled" : true,
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"state" : 5,
"type" : 0,
"jobInfo" : { },
"lastRunOn" : "2000-01-23T04:56:07.000+00:00"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ScheduledJobWebScheduler
Up
get /api/v{version}/system/config/scheduler (apiVversionSystemConfigSchedulerGet)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"directive" : 0,
"status" : 6
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success SchedulerConfigurationUp
put /api/v{version}/system/config/scheduler (apiVversionSystemConfigSchedulerPut)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body SchedulerConfiguration (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"directive" : 0,
"status" : 6
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success SchedulerConfigurationSearch
Up
get /api/v{version}/search (apiVversionSearchGet)
Path parameters
version (required)
Path Parameter —
Query parameters
type (optional)
Query Parameter — 0 = None, 1 = Active Directory, 2 = Azure, 3 = O365, 4 = Teams, 5 = V M Ware, 6 = AzureARM
field (optional)
Query Parameter —
value (optional)
Query Parameter —
limit (optional)
Query Parameter — default: 100 format: int32
option (optional)
Query Parameter — 0 = Starts With, 1 = Ends With, 2 = Contains
order (optional)
Query Parameter — 0 = Asc, 1 = Desc
Return type
String
Example data
Content-Type: application/json
""Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success StringServiceCommand
Up
post /api/v{version}/servicecommand (apiVversionServicecommandPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body ServiceCommand (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseSetup
Up
post /api/v{version}/setup/finalize (apiVversionSetupFinalizePost)
Path parameters
version (required)
Path Parameter —
Responses
200
SuccessSmtp
Up
delete /api/v{version}/system/config/smtp (apiVversionSystemConfigSmtpDelete)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
get /api/v{version}/system/config/smtp (apiVversionSystemConfigSmtpGet)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"server" : "server",
"port" : 0,
"isSslToBeUsed" : true,
"userCredentials" : {
"password" : "password",
"username" : "username"
},
"fromName" : "fromName",
"fromAddress" : "fromAddress",
"toAddress" : "toAddress"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success SmtpConfigurationUp
post /api/v{version}/system/config/smtp (apiVversionSystemConfigSmtpPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body SmtpConfiguration (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"server" : "server",
"port" : 0,
"isSslToBeUsed" : true,
"userCredentials" : {
"password" : "password",
"username" : "username"
},
"fromName" : "fromName",
"fromAddress" : "fromAddress",
"toAddress" : "toAddress"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success SmtpConfigurationUp
put /api/v{version}/system/config/smtp (apiVversionSystemConfigSmtpPut)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body SmtpConfiguration (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"server" : "server",
"port" : 0,
"isSslToBeUsed" : true,
"userCredentials" : {
"password" : "password",
"username" : "username"
},
"fromName" : "fromName",
"fromAddress" : "fromAddress",
"toAddress" : "toAddress"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success SmtpConfigurationUp
get /api/v{version}/system/config/smtp/status (apiVversionSystemConfigSmtpStatusGet)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isConfigured" : true,
"item" : 0,
"displayName" : "displayName"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ConfigurationStatusUp
post /api/v{version}/system/config/smtp/test (apiVversionSystemConfigSmtpTestPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body SmtpConfiguration (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseSystem
Up
get /api/v{version}/system/about (apiVversionSystemAboutGet)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"databaseStatistics" : {
"eventsPerGb" : 1,
"totalEventCount" : 4,
"vMwareEventCount" : 2,
"azureLogonEventCount" : 5,
"adEventCount" : 0,
"securityComplianceCenterEventCount" : 2,
"sharePointOnlineEventCount" : 7,
"fsEventCount" : 6,
"microsoftTeamsEventCount" : 9,
"azureAdEventCount" : 1,
"databaseSize" : 7,
"azureEventCount" : 5,
"exchangeOnlineEventCount" : 3
},
"about" : {
"copyright" : "copyright",
"company" : "company",
"productName" : "productName"
},
"systemInformation" : {
"fsDriverVersion" : "fsDriverVersion",
"productVersion" : "productVersion",
"databaseServer" : "databaseServer",
"databaseName" : "databaseName",
"processorCount" : "processorCount",
"adDriverVersion" : "adDriverVersion",
"maintenanceExpiry" : "maintenanceExpiry",
"buildDate" : "buildDate",
"operatingSystem" : "operatingSystem",
"licensedTo" : "licensedTo",
"machineName" : "machineName",
"rsatExtensionVersion" : "rsatExtensionVersion"
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success AboutInformationUp
get /api/v{version}/system/status (apiVversionSystemStatusGet)
Path parameters
version (required)
Path Parameter —
Return type
array[SystemStatus]
Example data
Content-Type: application/json
[ {
"appVersion" : "appVersion",
"lastActiveTime" : "2000-01-23T04:56:07.000+00:00",
"isInactive" : true,
"errorCode" : 5,
"type" : "type",
"statusMessage" : "statusMessage",
"enabled" : true,
"isAgent" : true,
"statusId" : 2,
"name" : "name",
"parentItem" : "parentItem",
"statusCodeDisplay" : "statusCodeDisplay",
"interval" : 5,
"lastEventTime" : "2000-01-23T04:56:07.000+00:00",
"statusCodeDisplayEnhanced" : "statusCodeDisplayEnhanced",
"id" : 0,
"configurationId" : 6,
"applicationGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"isStale" : true,
"statusCode" : 1
}, {
"appVersion" : "appVersion",
"lastActiveTime" : "2000-01-23T04:56:07.000+00:00",
"isInactive" : true,
"errorCode" : 5,
"type" : "type",
"statusMessage" : "statusMessage",
"enabled" : true,
"isAgent" : true,
"statusId" : 2,
"name" : "name",
"parentItem" : "parentItem",
"statusCodeDisplay" : "statusCodeDisplay",
"interval" : 5,
"lastEventTime" : "2000-01-23T04:56:07.000+00:00",
"statusCodeDisplayEnhanced" : "statusCodeDisplayEnhanced",
"id" : 0,
"configurationId" : 6,
"applicationGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"isStale" : true,
"statusCode" : 1
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessSystemConfiguration
Up
delete /api/v{version}/system/config/{id} (apiVversionSystemConfigIdDelete)
Path parameters
id (required)
Path Parameter — format: uuid
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
0Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygStatusUp
get /api/v{version}/system/config/{id} (apiVversionSystemConfigIdGet)
Path parameters
id (required)
Path Parameter — format: uuid
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{ }Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success SystemConfigurationBaseUp
post /api/v{version}/system/config (apiVversionSystemConfigPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body SystemConfiguration (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{ }Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success SystemConfigurationBaseUp
put /api/v{version}/system/config (apiVversionSystemConfigPut)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body SystemConfiguration (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{ }Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success SystemConfigurationBaseUp
get /api/v{version}/system/config/status (apiVversionSystemConfigStatusGet)
Path parameters
version (required)
Path Parameter —
Return type
array[ConfigurationStatus]
Example data
Content-Type: application/json
[ {
"isConfigured" : true,
"item" : 0,
"displayName" : "displayName"
}, {
"isConfigured" : true,
"item" : 0,
"displayName" : "displayName"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
post /api/v{version}/system/config/test (apiVversionSystemConfigTestPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body SystemConfiguration (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"adminCredentials" : {
"password" : "password",
"username" : "username"
},
"data" : "data",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success SystemConfigurationUp
post /api/v{version}/system/config/validate (apiVversionSystemConfigValidatePost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body SystemConfiguration (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"adminCredentials" : {
"password" : "password",
"username" : "username"
},
"data" : "data",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success SystemConfigurationTag
Up
post /api/v{version}/tags/context/{context} (apiVversionTagsContextContextPost)
Path parameters
context (required)
Path Parameter — 0 = Reports, 1 = Alerts, 1111 = All
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body Tag (optional)
Body Parameter —
Query parameters
id (required)
Query Parameter — format: uuid
Return type
Example data
Content-Type: application/json
{
"origin" : 1,
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success TagUp
get /api/v{version}/tags/contextual (apiVversionTagsContextualGet)
Path parameters
version (required)
Path Parameter —
Query parameters
context (optional)
Query Parameter — 0 = Reports, 1 = Alerts, 1111 = All
origin (optional)
Query Parameter — 0 = Built In, 1 = User, 1111 = All
Return type
array[ContextualTag]
Example data
Content-Type: application/json
[ {
"origin" : 0,
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"contexts" : [ 6, 6 ]
}, {
"origin" : 0,
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"contexts" : [ 6, 6 ]
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
get /api/v{version}/tags (apiVversionTagsGet)
Path parameters
version (required)
Path Parameter —
Return type
array[Tag]
Example data
Content-Type: application/json
[ {
"origin" : 1,
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, {
"origin" : 1,
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
delete /api/v{version}/tags/{id} (apiVversionTagsIdDelete)
Path parameters
id (required)
Path Parameter — format: uuid
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
get /api/v{version}/tags/{id} (apiVversionTagsIdGet)
Path parameters
id (required)
Path Parameter — format: uuid
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"origin" : 1,
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success TagUp
put /api/v{version}/tags/{id} (apiVversionTagsIdPut)
Path parameters
id (required)
Path Parameter — format: uuid
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body Tag (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"origin" : 1,
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success TagUp
post /api/v{version}/tags (apiVversionTagsPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body Tag (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"origin" : 1,
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success TagUser
Up
get /api/v{version}/delegation/usersList users with roles (apiVversionDelegationUsersGet)
Retrieves a list of users and the roles they are assigned.
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"identifier" : "identifier",
"displayName" : "displayName",
"roles" : [ {
"permissions" : [ {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
}, {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
} ],
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : 0
}, {
"permissions" : [ {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
}, {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
} ],
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : 0
} ],
"name" : "name",
"id" : 6,
"type" : "type",
"enabled" : true,
"lastLogon" : "2000-01-23T04:56:07.000+00:00"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DelegationAccountUp
delete /api/v{version}/delegation/users/{id}Delete a user (apiVversionDelegationUsersIdDelete)
Removes a user and revokes permissions.
Path parameters
id (required)
Path Parameter — The ID of the user format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"identifier" : "identifier",
"displayName" : "displayName",
"roles" : [ {
"permissions" : [ {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
}, {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
} ],
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : 0
}, {
"permissions" : [ {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
}, {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
} ],
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : 0
} ],
"name" : "name",
"id" : 6,
"type" : "type",
"enabled" : true,
"lastLogon" : "2000-01-23T04:56:07.000+00:00"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DelegationAccountUp
get /api/v{version}/delegation/users/{id}/permissionsList user permissions (apiVversionDelegationUsersIdPermissionsGet)
Locates a user and retrieves associated permissions.
Path parameters
id (required)
Path Parameter — The ID of the user format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success PermissionUp
put /api/v{version}/delegation/users/{id}Update a user (apiVversionDelegationUsersIdPut)
Locates a specific user and updates its delegation settings.
Path parameters
id (required)
Path Parameter — The ID of the user format: int32
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body DelegationAccount (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"identifier" : "identifier",
"displayName" : "displayName",
"roles" : [ {
"permissions" : [ {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
}, {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
} ],
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : 0
}, {
"permissions" : [ {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
}, {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
} ],
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : 0
} ],
"name" : "name",
"id" : 6,
"type" : "type",
"enabled" : true,
"lastLogon" : "2000-01-23T04:56:07.000+00:00"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DelegationAccountUp
get /api/v{version}/delegation/users/{id}/rolesList user roles (apiVversionDelegationUsersIdRolesGet)
Locates a specific user and retrieves assigned roles.
Path parameters
id (required)
Path Parameter — The ID of the user format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"permissions" : [ {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
}, {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
} ],
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success RoleUp
post /api/v{version}/delegation/usersAdd a new user (apiVversionDelegationUsersPost)
Adds new user and assigns a role.
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body DelegationAccount (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"identifier" : "identifier",
"displayName" : "displayName",
"roles" : [ {
"permissions" : [ {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
}, {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
} ],
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : 0
}, {
"permissions" : [ {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
}, {
"code" : 0,
"visible" : true,
"configuration" : "configuration",
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"category" : "category",
"shortName" : "shortName",
"type" : "type",
"displayPermission" : "displayPermission"
} ],
"name" : "name",
"description" : "description",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : 0
} ],
"name" : "name",
"id" : 6,
"type" : "type",
"enabled" : true,
"lastLogon" : "2000-01-23T04:56:07.000+00:00"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success DelegationAccountUp
post /api/v{version}/user/credentials/verify (apiVversionUserCredentialsVerifyPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body AccountCredentials (optional)
Body Parameter —
Query parameters
isAdminRequired (required)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
get /api/v{version}/user/search/activedirectory (apiVversionUserSearchActivedirectoryGet)
Path parameters
version (required)
Path Parameter —
Query parameters
searchString (optional)
Query Parameter —
objectType (optional)
Query Parameter — 1 = Local Users, 2 = Local Groups, 4 = Domain Users, 8 = Domain Groups, 16 = Computers, 32 = Domain Controllers, 64 = Exchange Servers, 128 = Sql Servers, 256 = Containers, 512 = Organizational Units
limit (optional)
Query Parameter — default: 50 format: int32
Return type
array[ActiveDirectoryObject]
Example data
Content-Type: application/json
[ {
"msdsPrincipalName" : "msdsPrincipalName",
"presentationName" : "presentationName",
"displayName" : "displayName",
"accountExpires" : 1,
"objectClass" : "objectClass",
"samAccountName" : "samAccountName",
"dnsName" : "dnsName",
"description" : "description",
"dn" : "dn",
"cn" : "cn",
"ldapName" : "ldapName",
"managerEmail" : "managerEmail",
"rawValues" : {
"key" : [ "", "" ]
},
"domain" : "domain",
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"name" : "name",
"objectSid" : "objectSid",
"attributes" : [ {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
}, {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
} ],
"userPrincipalName" : "userPrincipalName",
"userAccountControl" : 0,
"pwdLastSet" : 6
}, {
"msdsPrincipalName" : "msdsPrincipalName",
"presentationName" : "presentationName",
"displayName" : "displayName",
"accountExpires" : 1,
"objectClass" : "objectClass",
"samAccountName" : "samAccountName",
"dnsName" : "dnsName",
"description" : "description",
"dn" : "dn",
"cn" : "cn",
"ldapName" : "ldapName",
"managerEmail" : "managerEmail",
"rawValues" : {
"key" : [ "", "" ]
},
"domain" : "domain",
"objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"name" : "name",
"objectSid" : "objectSid",
"attributes" : [ {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
}, {
"isClass" : true,
"displayValue" : "displayValue",
"linkId" : 1,
"systemOnly" : true,
"displayName" : "displayName",
"schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"values" : [ "", "" ],
"name" : "name",
"aDsType" : 6,
"id" : 0,
"isOID" : true,
"syntaxOID" : "syntaxOID"
} ],
"userPrincipalName" : "userPrincipalName",
"userAccountControl" : 0,
"pwdLastSet" : 6
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
get /api/v{version}/user/search (apiVversionUserSearchGet)
Path parameters
version (required)
Path Parameter —
Query parameters
searchText (optional)
Query Parameter —
maxMatches (optional)
Query Parameter — default: 100 format: int32
includeLiveSearch (optional)
Query Parameter — default: true
Return type
array[IUserSearchMatch]
Example data
Content-Type: application/json
[ {
"accountId" : 0,
"presentationName" : "presentationName",
"origin" : 6,
"matchedElements" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
}, {
"accountId" : 0,
"presentationName" : "presentationName",
"origin" : 6,
"matchedElements" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUserConfiguration
Up
delete /api/v{version}/user/config (apiVversionUserConfigDelete)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
post /api/v{version}/user/config/delete (apiVversionUserConfigDeletePost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body AccountCredentials (optional)
Body Parameter —
Query parameters
deleteUserSid (optional)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
get /api/v{version}/user/config (apiVversionUserConfigGet)
Path parameters
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"applicationTheme" : "applicationTheme",
"consoleOptions" : "consoleOptions",
"applicationSettings" : {
"enableAutoSearch" : true,
"reportEventLimit" : 9,
"enableAuditPaging" : true,
"rollbackLayout" : [ null, null ],
"auditEventLimit" : 7,
"auditingLayout" : [ {
"isIntersecting" : true,
"hover" : {
"addAction" : 5,
"removeAction" : 2,
"field" : "field",
"position" : "position"
},
"visible" : true,
"sources" : [ 0, 0 ],
"isMetaEventColumn" : true,
"name" : "name",
"width" : {
"default" : 1,
"value" : 6,
"minimum" : 5
},
"header" : "header",
"position" : "position",
"type" : "type"
}, {
"isIntersecting" : true,
"hover" : {
"addAction" : 5,
"removeAction" : 2,
"field" : "field",
"position" : "position"
},
"visible" : true,
"sources" : [ 0, 0 ],
"isMetaEventColumn" : true,
"name" : "name",
"width" : {
"default" : 1,
"value" : 6,
"minimum" : 5
},
"header" : "header",
"position" : "position",
"type" : "type"
} ],
"isSideMenuExpanded" : true
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success UserConfigurationUp
post /api/v{version}/user/config (apiVversionUserConfigPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body UserConfiguration (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"applicationTheme" : "applicationTheme",
"consoleOptions" : "consoleOptions",
"applicationSettings" : {
"enableAutoSearch" : true,
"reportEventLimit" : 9,
"enableAuditPaging" : true,
"rollbackLayout" : [ null, null ],
"auditEventLimit" : 7,
"auditingLayout" : [ {
"isIntersecting" : true,
"hover" : {
"addAction" : 5,
"removeAction" : 2,
"field" : "field",
"position" : "position"
},
"visible" : true,
"sources" : [ 0, 0 ],
"isMetaEventColumn" : true,
"name" : "name",
"width" : {
"default" : 1,
"value" : 6,
"minimum" : 5
},
"header" : "header",
"position" : "position",
"type" : "type"
}, {
"isIntersecting" : true,
"hover" : {
"addAction" : 5,
"removeAction" : 2,
"field" : "field",
"position" : "position"
},
"visible" : true,
"sources" : [ 0, 0 ],
"isMetaEventColumn" : true,
"name" : "name",
"width" : {
"default" : 1,
"value" : 6,
"minimum" : 5
},
"header" : "header",
"position" : "position",
"type" : "type"
} ],
"isSideMenuExpanded" : true
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success UserConfigurationUp
put /api/v{version}/user/config (apiVversionUserConfigPut)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body UserConfiguration (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"applicationTheme" : "applicationTheme",
"consoleOptions" : "consoleOptions",
"applicationSettings" : {
"enableAutoSearch" : true,
"reportEventLimit" : 9,
"enableAuditPaging" : true,
"rollbackLayout" : [ null, null ],
"auditEventLimit" : 7,
"auditingLayout" : [ {
"isIntersecting" : true,
"hover" : {
"addAction" : 5,
"removeAction" : 2,
"field" : "field",
"position" : "position"
},
"visible" : true,
"sources" : [ 0, 0 ],
"isMetaEventColumn" : true,
"name" : "name",
"width" : {
"default" : 1,
"value" : 6,
"minimum" : 5
},
"header" : "header",
"position" : "position",
"type" : "type"
}, {
"isIntersecting" : true,
"hover" : {
"addAction" : 5,
"removeAction" : 2,
"field" : "field",
"position" : "position"
},
"visible" : true,
"sources" : [ 0, 0 ],
"isMetaEventColumn" : true,
"name" : "name",
"width" : {
"default" : 1,
"value" : 6,
"minimum" : 5
},
"header" : "header",
"position" : "position",
"type" : "type"
} ],
"isSideMenuExpanded" : true
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success UserConfigurationVMWare
Up
get /api/v{version}/collectors/vmware/servers (apiVversionCollectorsVmwareServersGet)
Path parameters
version (required)
Path Parameter —
Return type
array[VMWareServer]
Example data
Content-Type: application/json
[ {
"lastActiveTime" : "2000-01-23T04:56:07.000+00:00",
"isCertToBeIgnored" : true,
"credentials" : {
"password" : "password",
"username" : "username"
},
"isSsoToBeDisabled" : true,
"backupCollectionInterval" : 1,
"lastCollectionTime" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"message" : "message",
"vCenterName" : "vCenterName",
"collectionInterval" : 6,
"status" : 5
}, {
"lastActiveTime" : "2000-01-23T04:56:07.000+00:00",
"isCertToBeIgnored" : true,
"credentials" : {
"password" : "password",
"username" : "username"
},
"isSsoToBeDisabled" : true,
"backupCollectionInterval" : 1,
"lastCollectionTime" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"message" : "message",
"vCenterName" : "vCenterName",
"collectionInterval" : 6,
"status" : 5
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
SuccessUp
delete /api/v{version}/collectors/vmware/servers/{id} (apiVversionCollectorsVmwareServersIdDelete)
Path parameters
id (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"isSuccessful" : true,
"message" : "message",
"status" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success CygApiResultBaseUp
get /api/v{version}/collectors/vmware/servers/{id} (apiVversionCollectorsVmwareServersIdGet)
Path parameters
id (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"lastActiveTime" : "2000-01-23T04:56:07.000+00:00",
"isCertToBeIgnored" : true,
"credentials" : {
"password" : "password",
"username" : "username"
},
"isSsoToBeDisabled" : true,
"backupCollectionInterval" : 1,
"lastCollectionTime" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"message" : "message",
"vCenterName" : "vCenterName",
"collectionInterval" : 6,
"status" : 5
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success VMWareServerUp
put /api/v{version}/collectors/vmware/servers/{id} (apiVversionCollectorsVmwareServersIdPut)
Path parameters
id (required)
Path Parameter — format: int32
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body VMWareServer (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"lastActiveTime" : "2000-01-23T04:56:07.000+00:00",
"isCertToBeIgnored" : true,
"credentials" : {
"password" : "password",
"username" : "username"
},
"isSsoToBeDisabled" : true,
"backupCollectionInterval" : 1,
"lastCollectionTime" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"message" : "message",
"vCenterName" : "vCenterName",
"collectionInterval" : 6,
"status" : 5
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success VMWareServerUp
post /api/v{version}/collectors/vmware/servers (apiVversionCollectorsVmwareServersPost)
Path parameters
version (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Request body
body VMWareServer (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"lastActiveTime" : "2000-01-23T04:56:07.000+00:00",
"isCertToBeIgnored" : true,
"credentials" : {
"password" : "password",
"username" : "username"
},
"isSsoToBeDisabled" : true,
"backupCollectionInterval" : 1,
"lastCollectionTime" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"message" : "message",
"vCenterName" : "vCenterName",
"collectionInterval" : 6,
"status" : 5
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success VMWareServerModels
ADBackupConfigurationAboutInformationAccountCredentialsAccountRoleWebActionConfigurationActiveDirectoryAceActiveDirectoryAttributeActiveDirectoryAttributeDataActiveDirectoryDomainActiveDirectoryObjectActiveDirectoryObject2ActiveDirectoryObjectRecordActiveDirectoryProfileActiveDirectorySecurityDescriptorApplicationPoolApplicationPoolIdentityApplicationSettingsAssemblyAttributeValueAuditEventAuditEventColumnAuditEventColumnHoverAuditEventColumnWidthAuditEventDetailBaseAzureSnapshotBooleanCygTResultBaseCallingConventionsChartChartParameterChartTypeClauseClauseTypeClauseValueCollectionConfigurationCollectorBackupCollectorStatusCheckCollectorCollectorStatusCheckConfigurationCollectorStatusCheckConfigurationStateCollectorStatusCheckDirectiveConfigurationConfigurationStatusConnectionStringConstructorInfoContainerOptionContextualTagCreateTargetCustomAttributeDataCustomAttributeNamedArgumentCustomAttributeTypedArgumentCygApiResultBaseCygStatusCygnaAuditorServiceDataComparisonDataSourceDatabaseConnectorDesignationDatabaseConnectorTypeDatabaseInfoDatabaseListDatabaseSetupDatabaseStatisticsDatabaseVersionDatabaseVersionCompareDelegatedAccountDelegatedDatabaseConnectorDelegatedResourceTypeDelegatedResourceXDelegationAccountDeletedObjectDomainConfigurationDomainControllerDomainControllerSearchDomainProtectionPolicyDomainSearchEventAttributesEventInfoEventsRequestExceptionFieldAttributesFieldInfoFileServerFileSystemConfigurationFilterActionFilterClauseFilterReportFilterValueGenericParameterAttributesGpoChangeHealthCheckHealthStatusICustomAttributeProviderIMatchedElementIUserSearchMatchIdentityIdentityAccountIdentityAccountStateIdentityTypeInheritanceTypeIntPtrJobInfoBaseLayoutKindLdapScopeLicenseLicenseDetailLogConfigurationLogLevelLogMessageLoggingConfigurationManagedPipelineModeMemberInfoMemberTypesMethodAttributesMethodBaseMethodImplAttributesMethodInfoMisfireRuleModuleModuleHandleNamingConflictOptionNamingContextObjectObjectClassTypeObjectSnapshotOptionOrderParameterAttributesParameterInfoPermissionPostRunActionBasePostRunActionTypeProductInformationPropertyAttributesPropertyInfoProtectedAccountProtectedObjectProtectionFilterProtectionRuleProxyConfigurationWebRecoveryRequestRemoteLoggerConfigurationInfoBaseRemoteLoggerConfigurationXRemoteLoggerTypeReportAccessReportRunnerJobInfoReportStylingXReportWebRequestLockRoleRunReportInfoRuntimeFieldHandleRuntimeMethodHandleRuntimeTypeHandleScheduledJobStateScheduledJobTypeScheduledJobWebScheduledTimingTypeSchedulerConfigurationSchedulerControlDirectiveSchedulerStatusScopeSearchObjectTypeSearchTypeSecurityIdentifierSecurityRuleSetServerListServiceCommandServiceCommandIdServiceConfigurationWebServiceControllerStatusSmtpConfigurationSocketConfigurationSocketTypeSourceStateStorageTypeStructLayoutAttributeSysConfigItemSystemConfigurationSystemConfigurationBaseSystemInformationSystemStatusTagTagContextTagOriginTargetTargetConfigTeamsChannelTenantTenantPrecursorTenantStateTimeframeTimingInfoBaseTimingPriorityTypeTypeAttributesTypeInfoUserConfigurationUserIdTypeUserProfileUserProvenanceVMWareServer
ADBackupConfigurationUp
id (optional)
Integer format: int32
name (optional)
description (optional)
backupCollectionInterval (optional)
Integer format: int32
dnsName (optional)
domainController (optional)
namingContext (optional)
scope (optional)
customDN (optional)
backupCredentials (optional)
backupAccountName (optional)
backupPassword (optional)
fullBackup (optional)
enabled (optional)
objectGuid (optional)
UUID format: uuid
AboutInformationUp
about (optional)
systemInformation (optional)
databaseStatistics (optional)
AccountRoleWebUp
The object describes a role assignment.
ActionConfigurationUp
type (optional)
configuration (optional)
credentials (optional)
isEnabled (optional)
ActiveDirectoryAceUp
ActiveDirectoryAttributeUp
ActiveDirectoryDomainUp
ActiveDirectoryObjectUp
cn (optional)
objectGuid (optional)
UUID format: uuid
objectSid (optional)
objectClass (optional)
dn (optional)
displayName (optional)
name (optional)
domain (optional)
dnsName (optional)
ldapName (optional)
samAccountName (optional)
userPrincipalName (optional)
presentationName (optional)
description (optional)
msdsPrincipalName (optional)
userAccountControl (optional)
Long format: int64
managerEmail (optional)
pwdLastSet (optional)
Long format: int64
accountExpires (optional)
Long format: int64
attributes (optional)
rawValues (optional)
ActiveDirectoryObject2Up
cn (optional)
objectGuid (optional)
objectSid (optional)
objectClass (optional)
dn (optional)
displayName (optional)
name (optional)
domain (optional)
dnsName (optional)
ldapName (optional)
samAccountName (optional)
userPrincipalName (optional)
presentationName (optional)
description (optional)
msdsPrincipalName (optional)
userAccountControl (optional)
Long format: int64
managerEmail (optional)
pwdLastSet (optional)
Long format: int64
accountExpires (optional)
Long format: int64
attributes (optional)
ActiveDirectoryObjectRecordUp
ActiveDirectoryProfileUp
systemAttributes (optional)
ActiveDirectorySecurityDescriptorUp
discretionaryAccessControlList (optional)
systemAccessControlList (optional)
daclPresent (optional)
saclPresent (optional)
ApplicationPoolUp
name (optional)
managedPipelineMode (optional)
state (optional)
managedRuntimeVersion (optional)
identity (optional)
ApplicationPoolIdentityUp
ApplicationSettingsUp
AssemblyUp
definedTypes (optional)
exportedTypes (optional)
codeBase (optional)
entryPoint (optional)
fullName (optional)
imageRuntimeVersion (optional)
isDynamic (optional)
location (optional)
reflectionOnly (optional)
isCollectible (optional)
isFullyTrusted (optional)
customAttributes (optional)
escapedCodeBase (optional)
manifestModule (optional)
modules (optional)
globalAssemblyCache (optional)
hostContext (optional)
Long format: int64
securityRuleSet (optional)
AuditEventUp
An audit event record.
id (optional)
Long format: int64
module (optional)
Integer format: int32
when (optional)
Date format: date-time
user (optional)
server (optional)
eventName (optional)
objectName (optional)
success (optional)
Integer format: int32
fromAgent (optional)
workstationId (optional)
Integer format: int32
nativeEventId (optional)
Integer format: int32
databaseId (optional)
databaseName (optional)
attribute (optional)
attributeValue (optional)
attributePreviousValue (optional)
objectDN (optional)
objectClass (optional)
location (optional)
isRisky (optional)
client (optional)
crossMailboxOperations (optional)
mailboxUPN (optional)
mailboxFolder (optional)
sourceFileName (optional)
path (optional)
itemType (optional)
Integer format: int32
workload (optional)
valueAdded (optional)
valueAddedDisplay (optional)
valueRemoved (optional)
vmHost (optional)
vmType (optional)
dataCenter (optional)
dataStore (optional)
vm (optional)
vmCategory (optional)
teamName (optional)
teamRole (optional)
teamMember (optional)
tenant (optional)
external (optional)
identityName (optional)
resourceGroup (optional)
eventCategory (optional)
status (optional)
operation (optional)
resourceType (optional)
level (optional)
subscription (optional)
accountSid (optional)
workstation (optional)
samAccountName (optional)
aDsType (optional)
Integer format: int32
opn (optional)
Integer format: int32
AuditEventColumnUp
Defines the data to retrieve and display.
name (optional)
header (optional)
sources (optional)
array[Integer] format: int32
type (optional)
position (optional)
visible (optional)
width (optional)
hover (optional)
isIntersecting (optional)
isMetaEventColumn (optional)
AuditEventColumnHoverUp
AuditEventColumnWidthUp
AuditEventDetailBaseUp
Contains detailed information about the audit event.
AzureSnapshotUp
BooleanCygTResultBaseUp
CallingConventionsUp
1 = Standard, 2 = Var Args, 3 = Any, 32 = Has This, 64 = Explicit This
ChartUp
ChartParameterUp
ChartTypeUp
0 = Undefined, 1 = Events by Source, 2 = Top Users, 3 = Top Events, 4 = Events collected per day, 5 = Events per Minute, 6 = Top events per field
ClauseUp
Defines the data to search for.
type (optional)
fieldName (optional)
String The name of the field.
comparison (optional)
childClauses (optional)
array[Clause] The list of sub-clauses.
values (optional)
array[ClauseValue] The list of values.
ClauseTypeUp
The enum type of the clause.<br><br>0 = Or, 1 = And, -1 = Undefined
CollectionConfigurationUp
combineEventsDelay (optional)
Integer format: int32
combineEventsEnabled (optional)
excludedAttributes (optional)
ignoreLogonEvents (optional)
ldapTimeout (optional)
Integer format: int32
workstationResolution (optional)
workstationReverseLookup (optional)
processNestedGroups (optional)
processNestedGroupUsers (optional)
processNestedGroupMembers (optional)
processNestedGroupUserMembers (optional)
suppressNestedGroupEventBacklinks (optional)
suppressNestedGroupEventData (optional)
nestedGroups (optional)
enableGPOBackup (optional)
enableMissingGPOBackup (optional)
logLevel (optional)
Integer format: int32
CollectorBackupUp
CollectorStatusCheckConfigurationUp
CollectorStatusCheckConfigurationStateUp
0 = Undefined, 1 = Ready, 2 = Disabled
CollectorStatusCheckDirectiveUp
0 = Undefined, 1 = No Action, 2 = Change With Enable, 3 = Change With Disable
ConfigurationStatusUp
ConnectionStringUp
ConstructorInfoUp
name (optional)
declaringType (optional)
reflectedType (optional)
module (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32
attributes (optional)
methodImplementationFlags (optional)
callingConvention (optional)
isAbstract (optional)
isConstructor (optional)
isFinal (optional)
isHideBySig (optional)
isSpecialName (optional)
isStatic (optional)
isVirtual (optional)
isAssembly (optional)
isFamily (optional)
isFamilyAndAssembly (optional)
isFamilyOrAssembly (optional)
isPrivate (optional)
isPublic (optional)
isConstructedGenericMethod (optional)
isGenericMethod (optional)
isGenericMethodDefinition (optional)
containsGenericParameters (optional)
methodHandle (optional)
isSecurityCritical (optional)
isSecuritySafeCritical (optional)
isSecurityTransparent (optional)
memberType (optional)
ContainerOptionUp
0 = Do Not Restore Child Objects, 1 = Restore Immediate Children Only, 2 = Restore Entire Sub Tree, 3 = Max Value
CustomAttributeDataUp
attributeType (optional)
constructor (optional)
constructorArguments (optional)
namedArguments (optional)
CustomAttributeNamedArgumentUp
memberInfo (optional)
typedValue (optional)
memberName (optional)
isField (optional)
CygStatusUp
0 = Undefined, 1 = Created, 2 = Found, 3 = Updated, 4 = Deleted, 5 = Set, 6 = Passed, 7 = In Progress, 10 = Success, 20 = Already Exists, 22 = Not Found, 25 = Not Set, 26 = Failed, 27 = Transaction Failed, 50 = Insufficient Permission, 100 = Exception, 101 = Assert Exception, 102 = Migration Exception, 103 = Skipped, 104 = Partial
CygnaAuditorServiceUp
DataComparisonUp
Defines the condition for the search. Each value stands for a specific condition, such as doesn't contain or is.<br><br>0 = None, 1 = Equal, 2 = Not Equal, 3 = Less Than, 4 = Greater Than, 5 = Contains, 6 = Does Not Contain, 7 = Starts With, 8 = Does Not Start With, 9 = Ends With, 10 = Does Not End With, 11 = Between Dates, 12 = Not Between Dates, 13 = In, 14 = Not In, 15 = Like, 16 = Not Like, 17 = Since, 18 = In The Last, 19 = Today, 20 = Between Date Times, 21 = Not Between Date Times, 22 = Older Than
DataSourceUp
Defines the data source. Each value stands for a specific data source, such as Active Directory or File System.<br><br>0 = Unknown, 1 = Active Directory, 2 = File System, 3 = Entra ID, 4 = Entra ID Sign-In, 5 = Exchange Online, 6 = SharePoint Online, 7 = VMWare, 8 = Active Directory Rollback, 9 = Microsoft Teams, 10 = Cygna Auditor, 11 = OneDrive, 12 = Azure, 14 = Security & Compliance Center, 101 = Active Directory (Blackbird)
DatabaseConnectorDesignationUp
0 = Undefined, 1 = Cygna Auditor Core Configuration, 2 = Cygna Auditor Event Provider, 4 = Cygna Auditor Archive Event Provider
DatabaseConnectorTypeUp
0 = Undefined, 1 = Cygna Auditor, 2 = PBMS, 3 = Cygna Auditor Archive
DatabaseInfoUp
DatabaseListUp
databases (optional)
DatabaseSetupUp
credentials (optional)
connectionString (optional)
forest (optional)
DatabaseStatisticsUp
adEventCount (optional)
Integer format: int32
fsEventCount (optional)
Integer format: int32
azureAdEventCount (optional)
Integer format: int32
azureLogonEventCount (optional)
Integer format: int32
azureEventCount (optional)
Integer format: int32
securityComplianceCenterEventCount (optional)
Integer format: int32
sharePointOnlineEventCount (optional)
Integer format: int32
microsoftTeamsEventCount (optional)
Integer format: int32
exchangeOnlineEventCount (optional)
Integer format: int32
vMwareEventCount (optional)
Integer format: int32
totalEventCount (optional)
Integer format: int32
databaseSize (optional)
Integer format: int32
eventsPerGb (optional)
Integer format: int32
DatabaseVersionUp
DatabaseVersionCompareUp
DelegatedAccountUp
DelegatedDatabaseConnectorUp
id (optional)
UUID format: uuid
name (optional)
description (optional)
type (optional)
designation (optional)
isEnabled (optional)
connectionString (optional)
isReadOnly (optional)
configuration (optional)
delegatedResources (optional)
DelegatedResourceTypeUp
0 = Undefined, 1 = Report, 2 = Report Tag, 3 = Report Type, 4 = Scheduled Job, 5 = Scheduled Job Tag, 6 = Scheduled Job Type, 7 = Database Connector
DelegatedResourceXUp
DelegationAccountUp
The object contains information about the Cygna user and assigned roles.
DeletedObjectUp
cn (optional)
objectGuid (optional)
UUID format: uuid
objectSid (optional)
objectClass (optional)
dn (optional)
displayName (optional)
name (optional)
domain (optional)
dnsName (optional)
ldapName (optional)
samAccountName (optional)
userPrincipalName (optional)
presentationName (optional)
description (optional)
msdsPrincipalName (optional)
userAccountControl (optional)
Long format: int64
managerEmail (optional)
pwdLastSet (optional)
Long format: int64
accountExpires (optional)
Long format: int64
attributes (optional)
rawValues (optional)
showInAdvancedViewOnly (optional)
hasInferiors (optional)
lastKnownParent (optional)
deletedOn (optional)
Date format: date-time
distinguishedName (optional)
timeLeftBeforePurge (optional)
DomainConfigurationUp
id (optional)
Integer format: int32
dnsName (optional)
ncName (optional)
netBiosName (optional)
objectGuid (optional)
UUID format: uuid
accountName (optional)
password (optional)
collectionInterval (optional)
Integer format: int32
dcAccountName (optional)
dcPassword (optional)
backupAccountName (optional)
backupPassword (optional)
flags (optional)
Integer format: int32
status (optional)
Integer format: int32
statusDescription (optional)
localDcCollection (optional)
parentDomain (optional)
domainControllers (optional)
agentConfiguration (optional)
enabled (optional)
DomainControllerUp
domain (optional)
name (optional)
netBiosName (optional)
status (optional)
Integer format: int32
statusMessage (optional)
osVersion (optional)
agentVersion (optional)
upgradeRequired (optional)
id (optional)
Integer format: int32
sid (optional)
lastActive (optional)
Date format: date-time
hasAgent (optional)
enabled (optional)
DomainControllerSearchUp
searchString (optional)
credentials (optional)
excludeConfiguredDomains (optional)
collectorId (optional)
Integer format: int32
DomainProtectionPolicyUp
DomainSearchUp
searchString (optional)
credentials (optional)
excludeConfiguredDomains (optional)
EventAttributesUp
0 = None, 512 = Special Name, 1024 = R T Special Name
EventInfoUp
name (optional)
declaringType (optional)
reflectedType (optional)
module (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32
memberType (optional)
attributes (optional)
isSpecialName (optional)
addMethod (optional)
removeMethod (optional)
raiseMethod (optional)
isMulticast (optional)
eventHandlerType (optional)
EventsRequestUp
Defines the way returned data should be organized.
ExceptionUp
targetSite (optional)
stackTrace (optional)
message (optional)
data (optional)
innerException (optional)
helpLink (optional)
source (optional)
hResult (optional)
Integer format: int32
FieldAttributesUp
0 = Private Scope, 1 = Private, 2 = Fam AND Assem, 3 = Assembly, 4 = Family, 5 = Fam OR Assem, 6 = Public, 7 = Field Access Mask, 16 = Static, 32 = Init Only, 64 = Literal, 128 = Not Serialized, 256 = Has FieldRVA, 512 = Special Name, 1024 = R T Special Name, 4096 = Has Field Marshal, 8192 = Pinvoke Impl, 32768 = Has Default, 38144 = Reserved Mask
FieldInfoUp
name (optional)
declaringType (optional)
reflectedType (optional)
module (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32
memberType (optional)
attributes (optional)
fieldType (optional)
isInitOnly (optional)
isLiteral (optional)
isNotSerialized (optional)
isPinvokeImpl (optional)
isSpecialName (optional)
isStatic (optional)
isAssembly (optional)
isFamily (optional)
isFamilyAndAssembly (optional)
isFamilyOrAssembly (optional)
isPrivate (optional)
isPublic (optional)
isSecurityCritical (optional)
isSecuritySafeCritical (optional)
isSecurityTransparent (optional)
fieldHandle (optional)
FileServerUp
id (optional)
Integer format: int32
serverId (optional)
Integer format: int32
serverName (optional)
serverDnsName (optional)
serverSid (optional)
version (optional)
status (optional)
Integer format: int32
isDriver (optional)
lastUpdate (optional)
Date format: date-time
workItemId (optional)
UUID format: uuid
lastCollection (optional)
Date format: date-time
collectionInterval (optional)
Integer format: int32
alertCount (optional)
Integer format: int32
upgradeRequired (optional)
FileSystemConfigurationUp
FilterClauseUp
type (optional)
field (optional)
comparison (optional)
values (optional)
FilterReportUp
GenericParameterAttributesUp
0 = None, 1 = Covariant, 2 = Contravariant, 3 = Variance Mask, 4 = Reference Type Constraint, 8 = Not Nullable Value Type Constraint, 16 = Default Constructor Constraint, 28 = Special Constraint Mask
GpoChangeUp
HealthCheckUp
id (optional)
UUID format: uuid
name (optional)
description (optional)
status (optional)
statusDetail (optional)
HealthStatusUp
1 = Success, 2 = Failure, 3 = Unavailable
ICustomAttributeProviderUp
IUserSearchMatchUp
accountId (optional)
Integer format: int32
presentationName (optional)
origin (optional)
matchedElements (optional)
IdentityUp
The object describes Cygna identity and enables you to manage events created by several accounts as events created by a single entity.
IdentityAccountUp
The object contains information about the account linked to a Cygna identity.
IdentityAccountStateUp
Defines the account status in the identity configuration.<br><br>0 = Undefined, 1 = Ready, 2 = Pending Approval, 3 = Disabled, 4 = Delete Pending
IdentityTypeUp
0 = Local System, 1 = Local Service, 2 = Network Service, 3 = Specific User, 4 = Application Pool Identity
InheritanceTypeUp
0 = e This Object Only, 1 = e Child Objects Only, 2 = e This Object And Child Objects
IntPtrUp
JobInfoBaseUp
type (optional)
LayoutKindUp
0 = Sequential, 2 = Explicit, 3 = Auto
LdapScopeUp
0 = This Object Only, 1 = Child Object Only, 2 = This Object And Children
LicenseUp
LicenseDetailUp
LogLevelUp
0 = Undefined, 10 = Verbose, 11 = Debug, 12 = Info, 13 = Warn, 14 = Error, 15 = Fatal, 20 = Audit Verbose, 21 = Audit Debug, 22 = Audit Info, 23 = Audit Warn, 24 = Audit Error, 25 = Audit Fatal, 30 = Audit Exception
LoggingConfigurationUp
ManagedPipelineModeUp
0 = Integrated, 1 = Classic
MemberInfoUp
memberType (optional)
declaringType (optional)
reflectedType (optional)
name (optional)
module (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32
MemberTypesUp
1 = Constructor, 2 = Event, 4 = Field, 8 = Method, 16 = Property, 32 = Type Info, 64 = Custom, 128 = Nested Type, 191 = All
MethodAttributesUp
0 = Reuse Slot, 1 = Private, 2 = Fam AND Assem, 3 = Assembly, 4 = Family, 5 = Fam OR Assem, 6 = Public, 7 = Member Access Mask, 8 = Unmanaged Export, 16 = Static, 32 = Final, 64 = Virtual, 128 = Hide By Sig, 256 = New Slot, 512 = Check Access On Override, 1024 = Abstract, 2048 = Special Name, 4096 = R T Special Name, 8192 = Pinvoke Impl, 16384 = Has Security, 32768 = Require Sec Object, 53248 = Reserved Mask
MethodBaseUp
memberType (optional)
name (optional)
declaringType (optional)
reflectedType (optional)
module (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32
attributes (optional)
methodImplementationFlags (optional)
callingConvention (optional)
isAbstract (optional)
isConstructor (optional)
isFinal (optional)
isHideBySig (optional)
isSpecialName (optional)
isStatic (optional)
isVirtual (optional)
isAssembly (optional)
isFamily (optional)
isFamilyAndAssembly (optional)
isFamilyOrAssembly (optional)
isPrivate (optional)
isPublic (optional)
isConstructedGenericMethod (optional)
isGenericMethod (optional)
isGenericMethodDefinition (optional)
containsGenericParameters (optional)
methodHandle (optional)
isSecurityCritical (optional)
isSecuritySafeCritical (optional)
isSecurityTransparent (optional)
MethodImplAttributesUp
0 = Managed, 1 = Native, 2 = OPTIL, 3 = Code Type Mask, 4 = Unmanaged, 8 = No Inlining, 16 = Forward Ref, 32 = Synchronized, 64 = No Optimization, 128 = Preserve Sig, 256 = Aggressive Inlining, 512 = Aggressive Optimization, 4096 = Internal Call, 65535 = Max Method Impl Val
MethodInfoUp
name (optional)
declaringType (optional)
reflectedType (optional)
module (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32
attributes (optional)
methodImplementationFlags (optional)
callingConvention (optional)
isAbstract (optional)
isConstructor (optional)
isFinal (optional)
isHideBySig (optional)
isSpecialName (optional)
isStatic (optional)
isVirtual (optional)
isAssembly (optional)
isFamily (optional)
isFamilyAndAssembly (optional)
isFamilyOrAssembly (optional)
isPrivate (optional)
isPublic (optional)
isConstructedGenericMethod (optional)
isGenericMethod (optional)
isGenericMethodDefinition (optional)
containsGenericParameters (optional)
methodHandle (optional)
isSecurityCritical (optional)
isSecuritySafeCritical (optional)
isSecurityTransparent (optional)
memberType (optional)
returnParameter (optional)
returnType (optional)
returnTypeCustomAttributes (optional)
MisfireRuleUp
0 = Undefined, 1 = Do Nothing, 2 = Fire And Proceed
ModuleUp
NamingConflictOptionUp
0 = Skip the object, 1 = Prompt for new values, 2 = Automatically choose new values, 3 = Max Value
NamingContextUp
0 = Default, 1 = Configuration, 2 = Schema, 3 = RootDSE, 4 = Custom
ObjectUp
ObjectClassTypeUp
0 = Undefined, 1 = User, 2 = Group
ObjectSnapshotUp
id (optional)
Integer format: int32
objectGuid (optional)
UUID format: uuid
domain (optional)
encodedAttributeCount (optional)
Integer format: int32
encodedData (optional)
attributes (optional)
eventTime (optional)
Date format: date-time
samType (optional)
Integer format: int32
adObject (optional)
storageType (optional)
Integer format: int32
OptionUp
0 = Starts With, 1 = Ends With, 2 = Contains
OrderUp
0 = Asc, 1 = Desc
ParameterAttributesUp
0 = None, 1 = In, 2 = Out, 4 = Lcid, 8 = Retval, 16 = Optional, 4096 = Has Default, 8192 = Has Field Marshal, 16384 = Reserved3, 32768 = Reserved4, 61440 = Reserved Mask
ParameterInfoUp
attributes (optional)
member (optional)
name (optional)
parameterType (optional)
position (optional)
Integer format: int32
isIn (optional)
isLcid (optional)
isOptional (optional)
isOut (optional)
isRetval (optional)
defaultValue (optional)
rawDefaultValue (optional)
hasDefaultValue (optional)
customAttributes (optional)
metadataToken (optional)
Integer format: int32
PermissionUp
A permission record.
PostRunActionBaseUp
PostRunActionTypeUp
0 = Undefined, 1 = Email Report, 2 = Archive Report, 3 = Export Report, 4 = SMS
PropertyAttributesUp
0 = None, 512 = Special Name, 1024 = R T Special Name, 4096 = Has Default, 8192 = Reserved2, 16384 = Reserved3, 32768 = Reserved4, 62464 = Reserved Mask
PropertyInfoUp
name (optional)
declaringType (optional)
reflectedType (optional)
module (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32
memberType (optional)
propertyType (optional)
attributes (optional)
isSpecialName (optional)
canRead (optional)
canWrite (optional)
getMethod (optional)
setMethod (optional)
ProtectedAccountUp
ProtectedObjectUp
ProtectionFilterUp
ProtectionRuleUp
ProxyConfigurationWebUp
isProxyToBeUsed (optional)
server (optional)
port (optional)
Integer format: int32
isSpecificUserToBeUsed (optional)
userCredentials (optional)
adminCredentials (optional)
RecoveryRequestUp
objectId (optional)
UUID format: uuid
domainId (optional)
Integer format: int32
clearUserMustChangePasswordFlag (optional)
newPassword (optional)
containerOption (optional)
namingConflictOption (optional)
forceReplication (optional)
snapshotId (optional)
Integer format: int32
credentials (optional)
storageType (optional)
objectClass (optional)
enableAccount (optional)
domainController (optional)
RemoteLoggerConfigurationInfoBaseUp
type (optional)
RemoteLoggerConfigurationXUp
RemoteLoggerTypeUp
0 = Undefined, 1 = Splunk, 2 = Syslog
ReportAccessUp
id (optional)
Integer format: int32
reportId (optional)
UUID format: uuid
createdByUserType (optional)
createdByUserId (optional)
createdByUserName (optional)
createdOn (optional)
Date format: date-time
modifiedByUserType (optional)
modifiedByUserId (optional)
modifiedByUserName (optional)
modifiedOn (optional)
Date format: date-time
isPrivate (optional)
ReportRunnerJobInfoUp
type (optional)
runInfo (optional)
postRunActions (optional)
ReportStylingXUp
elementName (optional)
textColour (optional)
isBold (optional)
isItalic (optional)
mappings (optional)
map[String, Integer] format: int32
ReportWebUp
id (optional)
UUID format: uuid
name (optional)
description (optional)
filter (optional)
type (optional)
tags (optional)
actions (optional)
eventColumns (optional)
access (optional)
delegatedResources (optional)
isReadOnly (optional)
RoleUp
The role object contains delegation settings including a role name and included permissions.
RunReportInfoUp
ScheduledJobStateUp
0 = Undefined, 1 = Ready, 2 = Currently Active, 3 = Disabled, 4 = Delete Pending
ScheduledJobTypeUp
0 = Undefined, 2 = Report Runner, 3 = System Summary, 4 = Identity Searcher, 5 = Data Purge, 6 = WorkItem
ScheduledJobWebUp
ScheduledTimingTypeUp
0 = Undefined, 1 = Custom Interval, 2 = Simple Repeat, 3 = Explicit Cron
SchedulerConfigurationUp
SchedulerControlDirectiveUp
0 = Undefined, 1 = No Action, 2 = Pause All, 3 = Resume All, 11 = Audit Per ScheduledJobs table
SchedulerStatusUp
0 = Undefined, 1 = Active, 2 = Paused
ScopeUp
The object limits the role assignment to certain settings.
SearchObjectTypeUp
1 = Local Users, 2 = Local Groups, 4 = Domain Users, 8 = Domain Groups, 16 = Computers, 32 = Domain Controllers, 64 = Exchange Servers, 128 = Sql Servers, 256 = Containers, 512 = Organizational Units
SearchTypeUp
0 = None, 1 = Active Directory, 2 = Azure, 3 = O365, 4 = Teams, 5 = V M Ware, 6 = AzureARM
SecurityIdentifierUp
SecurityRuleSetUp
0 = None, 1 = Level1, 2 = Level2
ServerListUp
servers (optional)
ServiceCommandUp
ServiceCommandIdUp
0 = Undefined, 1 = Collect, 2 = Status, 3 = Stop, 4 = Restart
ServiceConfigurationWebUp
isRunAsLocalSystem (optional)
userCredentials (optional)
adminCredentials (optional)
serviceSocket (optional)
ServiceControllerStatusUp
1 = Stopped, 2 = Start Pending, 3 = Stop Pending, 4 = Running, 5 = Continue Pending, 6 = Pause Pending, 7 = Paused
SmtpConfigurationUp
SocketConfigurationUp
SocketTypeUp
0 = 0, 1 = Stream, 2 = Dgram, 3 = Raw, 4 = Rdm
SourceUp
Defines the data source the account authenticates in.<br><br>0 = Undefined, 1 = Active Directory, 2 = File System, 3 = Entra ID, 7 = vCenter
StateUp
0 = Escaped, 1 = Not Escaped, 2 = Start Of Token, 3 = End Of Line, 4 = 4
StorageTypeUp
0 = Unknown, 1 = Active Directory, 2 = Group Policy Container, 3 = Max Value
StructLayoutAttributeUp
SysConfigItemUp
0 = License, 1 = Proxy, 2 = Cygna Auditor Service, 3 = SMTP, 4 = Scheduler
SystemConfigurationUp
SystemConfigurationBaseUp
SystemInformationUp
productVersion (optional)
adDriverVersion (optional)
rsatExtensionVersion (optional)
fsDriverVersion (optional)
buildDate (optional)
licensedTo (optional)
maintenanceExpiry (optional)
machineName (optional)
operatingSystem (optional)
processorCount (optional)
databaseServer (optional)
databaseName (optional)
SystemStatusUp
id (optional)
Integer format: int32
configurationId (optional)
Integer format: int32
type (optional)
name (optional)
parentItem (optional)
statusCode (optional)
Integer format: int32
statusCodeDisplay (optional)
statusMessage (optional)
errorCode (optional)
Integer format: int32
interval (optional)
Integer format: int32
lastActiveTime (optional)
Date format: date-time
lastEventTime (optional)
Date format: date-time
enabled (optional)
isAgent (optional)
appVersion (optional)
isInactive (optional)
isStale (optional)
applicationGuid (optional)
UUID format: uuid
statusId (optional)
Integer format: int32
statusCodeDisplayEnhanced (optional)
TagContextUp
0 = Reports, 1 = Alerts, 1111 = All
TagOriginUp
0 = Built In, 1 = User, 1111 = All
TargetUp
TargetConfigUp
tenantActivityCollection (optional)
collectAllSubscriptions (optional)
collectResourceData (optional)
dataCollectionTimeout (optional)
Integer format: int32
activityLogCollectionTimeout (optional)
Integer format: int32
activityLogCollectionSkew (optional)
Integer format: int32
parallelResourceResolutionRequests (optional)
Integer format: int32
resolveConfigurationObjects (optional)
initialCollectionOffset (optional)
Integer format: int32
ignoredStatuses (optional)
ignoredItems (optional)
ignoredOperations (optional)
subscriptions (optional)
tenantResourceTypes (optional)
subscriptionResourceTypes (optional)
TeamsChannelUp
TenantUp
TenantPrecursorUp
TimingInfoBaseUp
type (optional)
effectiveDates (optional)
misfireRule (optional)
priority (optional)
TimingPriorityUp
No other "Schedule" should be given a TimingPriority of SchedulerOverseer or higher<br><br>0 = Undefined, 10 = Low, 20 = Medium, 30 = Default, 40 = High, 50 = Priority, 60 = Critical, 100 = Scheduler Overseer
TypeUp
name (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32
isInterface (optional)
memberType (optional)
namespace (optional)
assemblyQualifiedName (optional)
fullName (optional)
assembly (optional)
module (optional)
isNested (optional)
declaringType (optional)
declaringMethod (optional)
reflectedType (optional)
underlyingSystemType (optional)
isTypeDefinition (optional)
isArray (optional)
isByRef (optional)
isPointer (optional)
isConstructedGenericType (optional)
isGenericParameter (optional)
isGenericTypeParameter (optional)
isGenericMethodParameter (optional)
isGenericType (optional)
isGenericTypeDefinition (optional)
isSZArray (optional)
isVariableBoundArray (optional)
isByRefLike (optional)
hasElementType (optional)
genericTypeArguments (optional)
genericParameterPosition (optional)
Integer format: int32
genericParameterAttributes (optional)
attributes (optional)
isAbstract (optional)
isImport (optional)
isSealed (optional)
isSpecialName (optional)
isClass (optional)
isNestedAssembly (optional)
isNestedFamANDAssem (optional)
isNestedFamily (optional)
isNestedFamORAssem (optional)
isNestedPrivate (optional)
isNestedPublic (optional)
isNotPublic (optional)
isPublic (optional)
isAutoLayout (optional)
isExplicitLayout (optional)
isLayoutSequential (optional)
isAnsiClass (optional)
isAutoClass (optional)
isUnicodeClass (optional)
isCOMObject (optional)
isContextful (optional)
isEnum (optional)
isMarshalByRef (optional)
isPrimitive (optional)
isValueType (optional)
isSignatureType (optional)
isSecurityCritical (optional)
isSecuritySafeCritical (optional)
isSecurityTransparent (optional)
structLayoutAttribute (optional)
typeInitializer (optional)
typeHandle (optional)
guid (optional)
UUID format: uuid
baseType (optional)
isSerializable (optional)
containsGenericParameters (optional)
isVisible (optional)
TypeAttributesUp
0 = Class, 1 = Public, 2 = Nested Public, 3 = Nested Private, 4 = Nested Family, 5 = Nested Assembly, 6 = Nested Fam AND Assem, 7 = Visibility Mask, 8 = Sequential Layout, 16 = Explicit Layout, 24 = Layout Mask, 32 = Interface, 128 = Abstract, 256 = Sealed, 1024 = Special Name, 2048 = R T Special Name, 4096 = Import, 8192 = Serializable, 16384 = Windows Runtime, 65536 = Unicode Class, 131072 = Auto Class, 196608 = String Format Mask, 262144 = Has Security, 264192 = Reserved Mask, 1048576 = Before Field Init, 12582912 = Custom Format Mask
TypeInfoUp
name (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32
isInterface (optional)
memberType (optional)
namespace (optional)
assemblyQualifiedName (optional)
fullName (optional)
assembly (optional)
module (optional)
isNested (optional)
declaringType (optional)
declaringMethod (optional)
reflectedType (optional)
underlyingSystemType (optional)
isTypeDefinition (optional)
isArray (optional)
isByRef (optional)
isPointer (optional)
isConstructedGenericType (optional)
isGenericParameter (optional)
isGenericTypeParameter (optional)
isGenericMethodParameter (optional)
isGenericType (optional)
isGenericTypeDefinition (optional)
isSZArray (optional)
isVariableBoundArray (optional)
isByRefLike (optional)
hasElementType (optional)
genericTypeArguments (optional)
genericParameterPosition (optional)
Integer format: int32
genericParameterAttributes (optional)
attributes (optional)
isAbstract (optional)
isImport (optional)
isSealed (optional)
isSpecialName (optional)
isClass (optional)
isNestedAssembly (optional)
isNestedFamANDAssem (optional)
isNestedFamily (optional)
isNestedFamORAssem (optional)
isNestedPrivate (optional)
isNestedPublic (optional)
isNotPublic (optional)
isPublic (optional)
isAutoLayout (optional)
isExplicitLayout (optional)
isLayoutSequential (optional)
isAnsiClass (optional)
isAutoClass (optional)
isUnicodeClass (optional)
isCOMObject (optional)
isContextful (optional)
isEnum (optional)
isMarshalByRef (optional)
isPrimitive (optional)
isValueType (optional)
isSignatureType (optional)
isSecurityCritical (optional)
isSecuritySafeCritical (optional)
isSecurityTransparent (optional)
structLayoutAttribute (optional)
typeInitializer (optional)
typeHandle (optional)
guid (optional)
UUID format: uuid
baseType (optional)
isSerializable (optional)
containsGenericParameters (optional)
isVisible (optional)
genericTypeParameters (optional)
declaredConstructors (optional)
declaredEvents (optional)
declaredFields (optional)
declaredMembers (optional)
declaredMethods (optional)
declaredNestedTypes (optional)
declaredProperties (optional)
implementedInterfaces (optional)
UserConfigurationUp
applicationTheme (optional)
applicationSettings (optional)
consoleOptions (optional)
UserIdTypeUp
0 = Undefined, 1 = Security Identifier, 2 = Email, 3 = Cygna Auditor (Internal)
UserProfileUp
UserProvenanceUp
0 = Undefined, 1 = Active Directory Live, 2 = Active Directory Table, 3 = Office365 Table, 4 = V Mware Table, 5 = File System Table, 6 = Legacy PBMS Table, 7 = Azure Table
VMWareServerUp
id (optional)
Integer format: int32
vCenterName (optional)
credentials (optional)
collectionInterval (optional)
Integer format: int32
backupCollectionInterval (optional)
Integer format: int32
status (optional)
Integer format: int32
message (optional)
lastActiveTime (optional)
Date format: date-time
isSsoToBeDisabled (optional)
isCertToBeIgnored (optional)
lastCollectionTime (optional)
Date format: date-time
