Reports
APIs for managing reports
Get the latest report by its ID.
Note: To get the report, it must be a scheduled report with recipients.
Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
the ID of the report to get
Responses
200
Return a report file
No content
get/report/{id}/latest
GET /report/{id}/latest HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Accept: */*
200
Return a report file
No content
Execute a new report
Authorizations
AuthorizationstringRequired
Path parameters
requestIdstringRequired
the ID to register the request under
idstringRequired
the ID of the report to get
Responses
200
Request registered
No content
post/report/{id}/{requestId}/execute
POST /report/{id}/{requestId}/execute HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Accept: */*
200
Request registered
No content
Get all of the reports
Authorizations
AuthorizationstringRequired
Responses
200
Return array of reports
application/json
Report - represents report
cacheVersninteger · int64Optional
commitMessagestringOptional
createdstring · date-timeOptional
createdBystringOptional
cronstringOptional
cronViewbooleanOptional
definitionIdstringOptional
descriptionstringOptional
disableHeaderbooleanOptional
endingDatestring · date-timeOptional
endingTypestringOptional
EndingType holds the type of schedule Ending
idstringOptional
indexNamestringOptional
latestReportNamestringOptional
latestReportTimestring · date-timeOptional
latestReportUsernamestringOptional
latestScheduledReportTimestring · date-timeOptional
lockedbooleanOptional
modifiedstring · date-timeOptional
namestringOptional
nextScheduledTimestring · date-timeOptional
numericIdinteger · int64Optional
orientationstringOptional
packIDstringOptional
packNamestringOptional
packPropagationLabelsstring[]Optional
paperSizestringOptional
prevNamestringOptional
prevTypestringOptional
primaryTerminteger · int64Optional
propagationLabelsstring[]Optional
recipientsstring[]Optional
recurrentbooleanOptional
remotebooleanOptional
reportTypestringOptional
runOncebooleanOptional
runningRolesstring[]Optional
runningUserstringOptional
scheduledbooleanOptional
is it scheduled
sensitivebooleanOptional
sequenceNumberinteger · int64Optional
shouldCommitbooleanOptional
sizeInBytesinteger · int64Optional
sortValuesstring[]Optional
startDatestring · date-timeOptional
syncHashstringOptional
systembooleanOptional
tagsstring[]Optional
timesinteger · int64Optional
timezonestringOptional
timezoneOffsetinteger · int64Optional
typestringOptional
userAPIKeystringOptional
userAPIKeyIDstringOptional
vcShouldIgnorebooleanOptional
vcShouldKeepItemLegacyProdMachinebooleanOptional
versioninteger · int64Optional
get/reports
GET /reports HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Accept: */*
200
Return array of reports
[
{
"cacheVersn": 1,
"commitMessage": "text",
"created": "2026-01-01T00:00:00.000Z",
"createdBy": "text",
"cron": "text",
"cronView": true,
"dashboard": {
"accounts": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"allRead": true,
"allReadWrite": true,
"cacheVersn": 1,
"commitMessage": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"definitionId": "text",
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"fromServerVersion": {
"Digits": [
1
],
"Label": "text"
},
"hasRole": true,
"hidePivot": true,
"hideSearch": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"isCommon": true,
"itemVersion": {
"Digits": [
1
],
"Label": "text"
},
"layout": [
{
"forceRange": true,
"h": 1,
"i": "text",
"id": "text",
"reflectDimensions": true,
"w": 1,
"widget": {
"Cache": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"accounts": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"cacheVersn": 1,
"category": "text",
"commitMessage": "text",
"created": "2026-01-01T00:00:00.000Z",
"dataType": "text",
"dateRange": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"toDate": "2026-01-01T00:00:00.000Z"
},
"definition": {
"auditable": true,
"cacheVersn": 1,
"commitMessage": "text",
"created": "2026-01-01T00:00:00.000Z",
"definitionId": "text",
"fromServerVersion": {
"Digits": [
1
],
"Label": "text"
},
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"itemVersion": {
"Digits": [
1
],
"Label": "text"
},
"locked": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"packID": "text",
"packName": "text",
"packPropagationLabels": [
"text"
],
"partitioned": true,
"pluralName": "text",
"prevName": "text",
"primaryTerm": 1,
"propagationLabels": [
"text"
],
"rbacSupport": true,
"remote": true,
"sequenceNumber": 1,
"shouldCommit": true,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"system": true,
"toServerVersion": {
"Digits": [
1
],
"Label": "text"
},
"vcShouldIgnore": true,
"vcShouldKeepItemLegacyProdMachine": true,
"version": 1
},
"definitionId": "text",
"description": "text",
"fromServerVersion": {
"Digits": [
1
],
"Label": "text"
},
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"ignoreWorkers": true,
"indexName": "text",
"isPredefined": true,
"itemVersion": {
"Digits": [
1
],
"Label": "text"
},
"locked": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"packID": "text",
"packName": "text",
"packPropagationLabels": [
"text"
],
"page": 1,
"params": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"prevName": "text",
"primaryTerm": 1,
"propagationLabels": [
"text"
],
"query": "text",
"remote": true,
"searchAfter": [
"text"
],
"searchAfterElastic": [
"text"
],
"searchAfterMap": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"searchAfterMapOrder": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"searchBefore": [
"text"
],
"searchBeforeElastic": [
"text"
],
"sequenceNumber": 1,
"shouldCommit": true,
"size": 1,
"sizeInBytes": 1,
"skipAggregateAccounts": true,
"sort": [
{
"asc": true,
"field": "text",
"fieldType": "text"
}
],
"sortValues": [
"text"
],
"syncHash": "text",
"toServerVersion": {
"Digits": [
1
],
"Label": "text"
},
"vcShouldIgnore": true,
"vcShouldKeepItemLegacyProdMachine": true,
"version": 1,
"widgetType": "text"
},
"x": 1,
"y": 1
}
],
"locked": true,
"modified": "2026-01-01T00:00:00.000Z",
"modulePage": true,
"name": "text",
"numericId": 1,
"owner": "text",
"packID": "text",
"packName": "text",
"packPropagationLabels": [
"text"
],
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"prevName": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"propagationLabels": [
"text"
],
"remote": true,
"roles": [
"text"
],
"sequenceNumber": 1,
"shouldCommit": true,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"system": true,
"toDate": "2026-01-01T00:00:00.000Z",
"toServerVersion": {
"Digits": [
1
],
"Label": "text"
},
"vcShouldIgnore": true,
"vcShouldKeepItemLegacyProdMachine": true,
"version": 1,
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
},
"decoder": {
"ANY_ADDITIONAL_PROPERTY": {
"type": "text",
"value": "text"
}
},
"definitionId": "text",
"description": "text",
"disableHeader": true,
"endingDate": "2026-01-01T00:00:00.000Z",
"endingType": "text",
"fromServerVersion": {
"Digits": [
1
],
"Label": "text"
},
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"humanCron": {
"atTimeHour": "text",
"atTimeMinute": "text",
"days": [
"text"
],
"schedulingType": "text",
"timePeriod": 1,
"timePeriodType": "text"
},
"id": "text",
"indexName": "text",
"itemVersion": {
"Digits": [
1
],
"Label": "text"
},
"latestReportName": "text",
"latestReportTime": "2026-01-01T00:00:00.000Z",
"latestReportUsername": "text",
"latestScheduledReportTime": "2026-01-01T00:00:00.000Z",
"locked": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"nextScheduledTime": "2026-01-01T00:00:00.000Z",
"numericId": 1,
"orientation": "text",
"packID": "text",
"packName": "text",
"packPropagationLabels": [
"text"
],
"paperSize": "text",
"prevName": "text",
"prevType": "text",
"primaryTerm": 1,
"propagationLabels": [
"text"
],
"recipients": [
"text"
],
"recurrent": true,
"remote": true,
"reportType": "text",
"runOnce": true,
"runningRoles": [
"text"
],
"runningUser": "text",
"scheduled": true,
"sections": [
{
"autoPageBreak": true,
"automation": {
"args": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"id": "text",
"name": "text",
"noEvent": true
},
"data": {},
"description": "text",
"displayType": "text",
"emptyNotification": "text",
"fromDate": "text",
"hideItemTitleOnlyOne": true,
"layout": {},
"query": {
"customGroupBy": [
{
"ANY_ADDITIONAL_PROPERTY": {
"conditions": [
[
{
"field": "text",
"operator": "text",
"right": "text",
"type": "text"
}
]
],
"name": "text"
}
}
],
"filter": {},
"groupBy": [
"text"
],
"keys": [
"text"
],
"type": "text",
"valuesFormat": "text"
},
"title": "text",
"titleStyle": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"toDate": "text",
"type": "text"
}
],
"sensitive": true,
"sequenceNumber": 1,
"shouldCommit": true,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"syncHash": "text",
"system": true,
"tags": [
"text"
],
"times": 1,
"timezone": "text",
"timezoneOffset": 1,
"toServerVersion": {
"Digits": [
1
],
"Label": "text"
},
"type": "text",
"userAPIKey": "text",
"userAPIKeyID": "text",
"vcShouldIgnore": true,
"vcShouldKeepItemLegacyProdMachine": true,
"version": 1
}
]Upload a report to Cortex XSOAR
Authorizations
AuthorizationstringRequired
Body
filestringOptional
The report file to upload
Responses
200
A list of all the reports in the instance
application/json
Report - represents report
cacheVersninteger · int64Optional
commitMessagestringOptional
createdstring · date-timeOptional
createdBystringOptional
cronstringOptional
cronViewbooleanOptional
definitionIdstringOptional
descriptionstringOptional
disableHeaderbooleanOptional
endingDatestring · date-timeOptional
endingTypestringOptional
EndingType holds the type of schedule Ending
idstringOptional
indexNamestringOptional
latestReportNamestringOptional
latestReportTimestring · date-timeOptional
latestReportUsernamestringOptional
latestScheduledReportTimestring · date-timeOptional
lockedbooleanOptional
modifiedstring · date-timeOptional
namestringOptional
nextScheduledTimestring · date-timeOptional
numericIdinteger · int64Optional
orientationstringOptional
packIDstringOptional
packNamestringOptional
packPropagationLabelsstring[]Optional
paperSizestringOptional
prevNamestringOptional
prevTypestringOptional
primaryTerminteger · int64Optional
propagationLabelsstring[]Optional
recipientsstring[]Optional
recurrentbooleanOptional
remotebooleanOptional
reportTypestringOptional
runOncebooleanOptional
runningRolesstring[]Optional
runningUserstringOptional
scheduledbooleanOptional
is it scheduled
sensitivebooleanOptional
sequenceNumberinteger · int64Optional
shouldCommitbooleanOptional
sizeInBytesinteger · int64Optional
sortValuesstring[]Optional
startDatestring · date-timeOptional
syncHashstringOptional
systembooleanOptional
tagsstring[]Optional
timesinteger · int64Optional
timezonestringOptional
timezoneOffsetinteger · int64Optional
typestringOptional
userAPIKeystringOptional
userAPIKeyIDstringOptional
vcShouldIgnorebooleanOptional
vcShouldKeepItemLegacyProdMachinebooleanOptional
versioninteger · int64Optional
post/reports/upload
POST /reports/upload HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 15
{
"file": "text"
}200
A list of all the reports in the instance
[
{
"cacheVersn": 1,
"commitMessage": "text",
"created": "2026-01-01T00:00:00.000Z",
"createdBy": "text",
"cron": "text",
"cronView": true,
"dashboard": {
"accounts": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"allRead": true,
"allReadWrite": true,
"cacheVersn": 1,
"commitMessage": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"definitionId": "text",
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"fromServerVersion": {
"Digits": [
1
],
"Label": "text"
},
"hasRole": true,
"hidePivot": true,
"hideSearch": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"isCommon": true,
"itemVersion": {
"Digits": [
1
],
"Label": "text"
},
"layout": [
{
"forceRange": true,
"h": 1,
"i": "text",
"id": "text",
"reflectDimensions": true,
"w": 1,
"widget": {
"Cache": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"accounts": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"cacheVersn": 1,
"category": "text",
"commitMessage": "text",
"created": "2026-01-01T00:00:00.000Z",
"dataType": "text",
"dateRange": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"toDate": "2026-01-01T00:00:00.000Z"
},
"definition": {
"auditable": true,
"cacheVersn": 1,
"commitMessage": "text",
"created": "2026-01-01T00:00:00.000Z",
"definitionId": "text",
"fromServerVersion": {
"Digits": [
1
],
"Label": "text"
},
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"itemVersion": {
"Digits": [
1
],
"Label": "text"
},
"locked": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"packID": "text",
"packName": "text",
"packPropagationLabels": [
"text"
],
"partitioned": true,
"pluralName": "text",
"prevName": "text",
"primaryTerm": 1,
"propagationLabels": [
"text"
],
"rbacSupport": true,
"remote": true,
"sequenceNumber": 1,
"shouldCommit": true,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"system": true,
"toServerVersion": {
"Digits": [
1
],
"Label": "text"
},
"vcShouldIgnore": true,
"vcShouldKeepItemLegacyProdMachine": true,
"version": 1
},
"definitionId": "text",
"description": "text",
"fromServerVersion": {
"Digits": [
1
],
"Label": "text"
},
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"ignoreWorkers": true,
"indexName": "text",
"isPredefined": true,
"itemVersion": {
"Digits": [
1
],
"Label": "text"
},
"locked": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"packID": "text",
"packName": "text",
"packPropagationLabels": [
"text"
],
"page": 1,
"params": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"prevName": "text",
"primaryTerm": 1,
"propagationLabels": [
"text"
],
"query": "text",
"remote": true,
"searchAfter": [
"text"
],
"searchAfterElastic": [
"text"
],
"searchAfterMap": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"searchAfterMapOrder": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"searchBefore": [
"text"
],
"searchBeforeElastic": [
"text"
],
"sequenceNumber": 1,
"shouldCommit": true,
"size": 1,
"sizeInBytes": 1,
"skipAggregateAccounts": true,
"sort": [
{
"asc": true,
"field": "text",
"fieldType": "text"
}
],
"sortValues": [
"text"
],
"syncHash": "text",
"toServerVersion": {
"Digits": [
1
],
"Label": "text"
},
"vcShouldIgnore": true,
"vcShouldKeepItemLegacyProdMachine": true,
"version": 1,
"widgetType": "text"
},
"x": 1,
"y": 1
}
],
"locked": true,
"modified": "2026-01-01T00:00:00.000Z",
"modulePage": true,
"name": "text",
"numericId": 1,
"owner": "text",
"packID": "text",
"packName": "text",
"packPropagationLabels": [
"text"
],
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"prevName": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"propagationLabels": [
"text"
],
"remote": true,
"roles": [
"text"
],
"sequenceNumber": 1,
"shouldCommit": true,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"system": true,
"toDate": "2026-01-01T00:00:00.000Z",
"toServerVersion": {
"Digits": [
1
],
"Label": "text"
},
"vcShouldIgnore": true,
"vcShouldKeepItemLegacyProdMachine": true,
"version": 1,
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
},
"decoder": {
"ANY_ADDITIONAL_PROPERTY": {
"type": "text",
"value": "text"
}
},
"definitionId": "text",
"description": "text",
"disableHeader": true,
"endingDate": "2026-01-01T00:00:00.000Z",
"endingType": "text",
"fromServerVersion": {
"Digits": [
1
],
"Label": "text"
},
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"humanCron": {
"atTimeHour": "text",
"atTimeMinute": "text",
"days": [
"text"
],
"schedulingType": "text",
"timePeriod": 1,
"timePeriodType": "text"
},
"id": "text",
"indexName": "text",
"itemVersion": {
"Digits": [
1
],
"Label": "text"
},
"latestReportName": "text",
"latestReportTime": "2026-01-01T00:00:00.000Z",
"latestReportUsername": "text",
"latestScheduledReportTime": "2026-01-01T00:00:00.000Z",
"locked": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"nextScheduledTime": "2026-01-01T00:00:00.000Z",
"numericId": 1,
"orientation": "text",
"packID": "text",
"packName": "text",
"packPropagationLabels": [
"text"
],
"paperSize": "text",
"prevName": "text",
"prevType": "text",
"primaryTerm": 1,
"propagationLabels": [
"text"
],
"recipients": [
"text"
],
"recurrent": true,
"remote": true,
"reportType": "text",
"runOnce": true,
"runningRoles": [
"text"
],
"runningUser": "text",
"scheduled": true,
"sections": [
{
"autoPageBreak": true,
"automation": {
"args": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"id": "text",
"name": "text",
"noEvent": true
},
"data": {},
"description": "text",
"displayType": "text",
"emptyNotification": "text",
"fromDate": "text",
"hideItemTitleOnlyOne": true,
"layout": {},
"query": {
"customGroupBy": [
{
"ANY_ADDITIONAL_PROPERTY": {
"conditions": [
[
{
"field": "text",
"operator": "text",
"right": "text",
"type": "text"
}
]
],
"name": "text"
}
}
],
"filter": {},
"groupBy": [
"text"
],
"keys": [
"text"
],
"type": "text",
"valuesFormat": "text"
},
"title": "text",
"titleStyle": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"toDate": "text",
"type": "text"
}
],
"sensitive": true,
"sequenceNumber": 1,
"shouldCommit": true,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"syncHash": "text",
"system": true,
"tags": [
"text"
],
"times": 1,
"timezone": "text",
"timezoneOffset": 1,
"toServerVersion": {
"Digits": [
1
],
"Label": "text"
},
"type": "text",
"userAPIKey": "text",
"userAPIKeyID": "text",
"vcShouldIgnore": true,
"vcShouldKeepItemLegacyProdMachine": true,
"version": 1
}
]Get a report by its ID
Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
the ID of the report to get
Responses
200
Return a report
application/json
Report - represents report
cacheVersninteger · int64Optional
commitMessagestringOptional
createdstring · date-timeOptional
createdBystringOptional
cronstringOptional
cronViewbooleanOptional
definitionIdstringOptional
descriptionstringOptional
disableHeaderbooleanOptional
endingDatestring · date-timeOptional
endingTypestringOptional
EndingType holds the type of schedule Ending
idstringOptional
indexNamestringOptional
latestReportNamestringOptional
latestReportTimestring · date-timeOptional
latestReportUsernamestringOptional
latestScheduledReportTimestring · date-timeOptional
lockedbooleanOptional
modifiedstring · date-timeOptional
namestringOptional
nextScheduledTimestring · date-timeOptional
numericIdinteger · int64Optional
orientationstringOptional
packIDstringOptional
packNamestringOptional
packPropagationLabelsstring[]Optional
paperSizestringOptional
prevNamestringOptional
prevTypestringOptional
primaryTerminteger · int64Optional
propagationLabelsstring[]Optional
recipientsstring[]Optional
recurrentbooleanOptional
remotebooleanOptional
reportTypestringOptional
runOncebooleanOptional
runningRolesstring[]Optional
runningUserstringOptional
scheduledbooleanOptional
is it scheduled
sensitivebooleanOptional
sequenceNumberinteger · int64Optional
shouldCommitbooleanOptional
sizeInBytesinteger · int64Optional
sortValuesstring[]Optional
startDatestring · date-timeOptional
syncHashstringOptional
systembooleanOptional
tagsstring[]Optional
timesinteger · int64Optional
timezonestringOptional
timezoneOffsetinteger · int64Optional
typestringOptional
userAPIKeystringOptional
userAPIKeyIDstringOptional
vcShouldIgnorebooleanOptional
vcShouldKeepItemLegacyProdMachinebooleanOptional
versioninteger · int64Optional
get/reports/{id}
GET /reports/{id} HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Accept: */*
200
Return a report
{
"cacheVersn": 1,
"commitMessage": "text",
"created": "2026-01-01T00:00:00.000Z",
"createdBy": "text",
"cron": "text",
"cronView": true,
"dashboard": {
"accounts": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"allRead": true,
"allReadWrite": true,
"cacheVersn": 1,
"commitMessage": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"definitionId": "text",
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"fromServerVersion": {
"Digits": [
1
],
"Label": "text"
},
"hasRole": true,
"hidePivot": true,
"hideSearch": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"isCommon": true,
"itemVersion": {
"Digits": [
1
],
"Label": "text"
},
"layout": [
{
"forceRange": true,
"h": 1,
"i": "text",
"id": "text",
"reflectDimensions": true,
"w": 1,
"widget": {
"Cache": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"accounts": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"cacheVersn": 1,
"category": "text",
"commitMessage": "text",
"created": "2026-01-01T00:00:00.000Z",
"dataType": "text",
"dateRange": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"toDate": "2026-01-01T00:00:00.000Z"
},
"definition": {
"auditable": true,
"cacheVersn": 1,
"commitMessage": "text",
"created": "2026-01-01T00:00:00.000Z",
"definitionId": "text",
"fromServerVersion": {
"Digits": [
1
],
"Label": "text"
},
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"itemVersion": {
"Digits": [
1
],
"Label": "text"
},
"locked": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"packID": "text",
"packName": "text",
"packPropagationLabels": [
"text"
],
"partitioned": true,
"pluralName": "text",
"prevName": "text",
"primaryTerm": 1,
"propagationLabels": [
"text"
],
"rbacSupport": true,
"remote": true,
"sequenceNumber": 1,
"shouldCommit": true,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"system": true,
"toServerVersion": {
"Digits": [
1
],
"Label": "text"
},
"vcShouldIgnore": true,
"vcShouldKeepItemLegacyProdMachine": true,
"version": 1
},
"definitionId": "text",
"description": "text",
"fromServerVersion": {
"Digits": [
1
],
"Label": "text"
},
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"ignoreWorkers": true,
"indexName": "text",
"isPredefined": true,
"itemVersion": {
"Digits": [
1
],
"Label": "text"
},
"locked": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"packID": "text",
"packName": "text",
"packPropagationLabels": [
"text"
],
"page": 1,
"params": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"prevName": "text",
"primaryTerm": 1,
"propagationLabels": [
"text"
],
"query": "text",
"remote": true,
"searchAfter": [
"text"
],
"searchAfterElastic": [
"text"
],
"searchAfterMap": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"searchAfterMapOrder": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"searchBefore": [
"text"
],
"searchBeforeElastic": [
"text"
],
"sequenceNumber": 1,
"shouldCommit": true,
"size": 1,
"sizeInBytes": 1,
"skipAggregateAccounts": true,
"sort": [
{
"asc": true,
"field": "text",
"fieldType": "text"
}
],
"sortValues": [
"text"
],
"syncHash": "text",
"toServerVersion": {
"Digits": [
1
],
"Label": "text"
},
"vcShouldIgnore": true,
"vcShouldKeepItemLegacyProdMachine": true,
"version": 1,
"widgetType": "text"
},
"x": 1,
"y": 1
}
],
"locked": true,
"modified": "2026-01-01T00:00:00.000Z",
"modulePage": true,
"name": "text",
"numericId": 1,
"owner": "text",
"packID": "text",
"packName": "text",
"packPropagationLabels": [
"text"
],
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"prevName": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"propagationLabels": [
"text"
],
"remote": true,
"roles": [
"text"
],
"sequenceNumber": 1,
"shouldCommit": true,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"system": true,
"toDate": "2026-01-01T00:00:00.000Z",
"toServerVersion": {
"Digits": [
1
],
"Label": "text"
},
"vcShouldIgnore": true,
"vcShouldKeepItemLegacyProdMachine": true,
"version": 1,
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
},
"decoder": {
"ANY_ADDITIONAL_PROPERTY": {
"type": "text",
"value": "text"
}
},
"definitionId": "text",
"description": "text",
"disableHeader": true,
"endingDate": "2026-01-01T00:00:00.000Z",
"endingType": "text",
"fromServerVersion": {
"Digits": [
1
],
"Label": "text"
},
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"humanCron": {
"atTimeHour": "text",
"atTimeMinute": "text",
"days": [
"text"
],
"schedulingType": "text",
"timePeriod": 1,
"timePeriodType": "text"
},
"id": "text",
"indexName": "text",
"itemVersion": {
"Digits": [
1
],
"Label": "text"
},
"latestReportName": "text",
"latestReportTime": "2026-01-01T00:00:00.000Z",
"latestReportUsername": "text",
"latestScheduledReportTime": "2026-01-01T00:00:00.000Z",
"locked": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"nextScheduledTime": "2026-01-01T00:00:00.000Z",
"numericId": 1,
"orientation": "text",
"packID": "text",
"packName": "text",
"packPropagationLabels": [
"text"
],
"paperSize": "text",
"prevName": "text",
"prevType": "text",
"primaryTerm": 1,
"propagationLabels": [
"text"
],
"recipients": [
"text"
],
"recurrent": true,
"remote": true,
"reportType": "text",
"runOnce": true,
"runningRoles": [
"text"
],
"runningUser": "text",
"scheduled": true,
"sections": [
{
"autoPageBreak": true,
"automation": {
"args": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"id": "text",
"name": "text",
"noEvent": true
},
"data": {},
"description": "text",
"displayType": "text",
"emptyNotification": "text",
"fromDate": "text",
"hideItemTitleOnlyOne": true,
"layout": {},
"query": {
"customGroupBy": [
{
"ANY_ADDITIONAL_PROPERTY": {
"conditions": [
[
{
"field": "text",
"operator": "text",
"right": "text",
"type": "text"
}
]
],
"name": "text"
}
}
],
"filter": {},
"groupBy": [
"text"
],
"keys": [
"text"
],
"type": "text",
"valuesFormat": "text"
},
"title": "text",
"titleStyle": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"toDate": "text",
"type": "text"
}
],
"sensitive": true,
"sequenceNumber": 1,
"shouldCommit": true,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"syncHash": "text",
"system": true,
"tags": [
"text"
],
"times": 1,
"timezone": "text",
"timezoneOffset": 1,
"toServerVersion": {
"Digits": [
1
],
"Label": "text"
},
"type": "text",
"userAPIKey": "text",
"userAPIKeyID": "text",
"vcShouldIgnore": true,
"vcShouldKeepItemLegacyProdMachine": true,
"version": 1
}Last updated
Was this helpful?