VerifyIntegrationHealth

Checks for existing errors in a given integration.

python · Developer Tools

Details

IDVerifyIntegrationHealth
Languagepython
From Version6.0.0
Docker Imagedemisto/python3:3.12.8.3296088
Tagsbasescript

README

Checks for existing errors in a given integration.

Script Data


Name Description
Script Type python3
Tags basescript
Cortex XSOAR Version 6.0.0

Inputs


Argument Name Description
integration_name Integration name to check its health status.

Outputs


Path Description Type
IntegrationHealth.isHealthy Determines the health status of the integration. Boolean
IntegrationHealth.fetchDone Determines whether the fetch-indicators command completed. Boolean
IntegrationHealth.integrationName Requested integration name. String

Script Example

!VerifyIntegrationHealth integration_name="AutoFocus Daily Feed"

Context Example

{
    "IntegrationHealth": {
        "fetchDone": true,
        "integrationName": "AutoFocus Daily Feed",
        "isHealthy": true
    }
}

Human Readable Output

Results

fetchDone integrationName isHealthy
true AutoFocus Daily Feed true

Troubleshooting

Multi-tenant environments should be configured with the Cortex Rest API instance when using this
automation. Make sure the Use tenant parameter (in the Cortex Rest API integration) is checked
to ensure that API calls are made to the current tenant instead of the master tenant.

args:
- description: Integration name to check its health status.
  name: integration_name
  required: true
comment: Checks for existing errors in a given integration.
commonfields:
  id: VerifyIntegrationHealth
  version: -1
name: VerifyIntegrationHealth
outputs:
- contextPath: IntegrationHealth.isHealthy
  description: Determines the health status of the integration.
  type: Boolean
- contextPath: IntegrationHealth.fetchDone
  description: Determines whether the fetch-indicators command completed.
  type: Boolean
- contextPath: IntegrationHealth.integrationName
  description: Requested integration name.
  type: String
script: '-'
tags:
- basescript
timeout: '0'
type: python
subtype: python3
dockerimage: demisto/python3:3.12.8.3296088
fromversion: 6.0.0
tests:
- No test