Dashboards

APIs for managing dashboards

Get all dashboards details

get

Retrieve details of all the dashboards in the system. Only dashboards the user has view access to are returned.

Responses

200

OK

application/json

get/xsoar/public/v1/dashboards

GET /xsoar/public/v1/dashboards HTTP/1.1
Host: api-yourfqdn
Accept: */*

200

OK

{
  "dashboard": {
    "ANY_ADDITIONAL_PROPERTY": {
      "id": "text",
      "version": 1,
      "cacheVersn": 1
    }
  }
}

Get dashboard details for the specified dashboard

get

Use the dashboard ID to specify the dashboard you want to get details about.

Path parameters

dashboard_idstringRequired

Responses

200

OK

application/json

idstringOptional

Dashboard ID

versionintegerOptional

cacheVersnintegerOptional

sequenceNumberintegerOptional

primaryTermintegerOptional

modifiedstringOptional

sizeInBytesintegerOptional

packIDstringOptional

packNamestringOptional

itemVersionstringOptional

fromServerVersionstringOptional

toServerVersionstringOptional

propagationLabelsobject[]Optional

packPropagationLabelsstring[]Optional

definitionIdstringOptional

vcShouldIgnorebooleanOptional

vcShouldKeepItemLegacyProdMachinebooleanOptional

commitMessagestringOptional

shouldCommitbooleanOptional

fromDatestringOptional

toDatestringOptional

fromDateLicensestringOptional

namestringOptional

prevNamestringOptional

systembooleanOptional

isCommonbooleanOptional

ownerstringOptional

lockedbooleanOptional

hidePivotbooleanOptional

hideSearchbooleanOptional

modulePagebooleanOptional

get/xsoar/public/v1/dashboards/{dashboard_id}

GET /xsoar/public/v1/dashboards/{dashboard_id} HTTP/1.1
Host: api-yourfqdn
Accept: */*

200

OK

{
  "id": "string",
  "version": 0,
  "cacheVersn": 0,
  "sequenceNumber": 0,
  "primaryTerm": 0,
  "modified": "string",
  "sizeInBytes": 0,
  "packID": "string",
  "packName": "string",
  "itemVersion": "string",
  "fromServerVersion": "string",
  "toServerVersion": "string",
  "propagationLabels": [
    {}
  ],
  "packPropagationLabels": [
    "string"
  ],
  "definitionId": "string",
  "vcShouldIgnore": true,
  "vcShouldKeepItemLegacyProdMachine": true,
  "commitMessage": "string",
  "shouldCommit": true,
  "fromDate": "string",
  "toDate": "string",
  "period": {
    "by": "string",
    "byTo": "string",
    "byFrom": "string",
    "toValue": {},
    "fromValue": 0,
    "field": "string"
  },
  "fromDateLicense": "string",
  "name": "string",
  "prevName": "string",
  "layout": [
    {
      "id": "string",
      "forceRange": true,
      "x": 0,
      "y": 0,
      "i": "string",
      "w": 0,
      "h": 0,
      "widget": {
        "id": "string",
        "version": 0,
        "cacheVersn": 0,
        "modified": "string",
        "sizeInBytes": 0,
        "packID": "string",
        "packName": "string",
        "itemVersion": "string",
        "fromServerVersion": "string",
        "toServerVersion": "string",
        "definitionId": "string",
        "vcShouldIgnore": true,
        "vcShouldKeepItemLegacyProdMachine": true,
        "commitMessage": "string",
        "shouldCommit": true,
        "Cache": {},
        "name": "string",
        "prevName": "string",
        "dataType": "string",
        "widgetType": "string",
        "query": "string",
        "isPredefined": true,
        "dateRange": {
          "fromDate": "string",
          "toDate": "string",
          "period": {
            "by": "string",
            "byTo": "string",
            "byFrom": "string",
            "toValue": {},
            "fromValue": 0,
            "field": "string"
          },
          "fromDateLicense": "string"
        },
        "params": {
          "groupBy": [
            "string"
          ],
          "hideLegend": true,
          "colors": {
            "isEnabled": true,
            "items": {
              "#00CD33": {
                "value": 0
              },
              "#FAC100": {
                "value": 0
              },
              "#FF1B15": {
                "value": 0
              }
            },
            "type": "string"
          }
        },
        "category": "string"
      },
      "reflectDimensions": true
    }
  ],
  "system": true,
  "isCommon": true,
  "owner": "string",
  "locked": true,
  "hidePivot": true,
  "hideSearch": true,
  "modulePage": true
}