Skip to main content

List All Integrations​

Returns all your integrations, optionally filtered by type.

This request supports integrations with only the following:

  • Okta
  • Qualys
  • Tenable
Query Parameters
  • type string

    Include only Okta, Tenable, and Qualys integrations

Responses

successful operation

Schema
  • Array [
  • alertRules object[]

    Alert Rules

  • Array [
  • alertRuleNotificationConfig object[]

    List of data for notifications to third-party tools

  • Array [
  • dayOfMonth int32

    Day of month

  • daysOfWeek object[]

    Days of week

  • Array [
  • day string

    Possible values: [SU, MO, TU, WE, TH, FR, SA]

  • offset int32
  • ]
  • detailedReport boolean

    Provide csv detailed report

  • enabled boolean

    Scan enabled

  • frequency string

    Possible values: [as_it_happens, daily, weekly, monthly]

  • frequencyFromRRule string

    Frequency from RRule

  • hourOfDay int32

    Hour of day

  • id string

    Alert rule notification config ID

  • includeRemediation boolean

    Include remediation in detailed report

  • lastUpdated int64

    Last Updated

  • last_sent_ts int64

    Time of last notification in milliseconds

  • recipients string[]
    • For email notifications: List of unique email addresses to notify
    • For integrations without notification templates: List of integration ids
    • For integrations with notification templates: List of notification template ids
  • rruleSchedule string
  • templateId string

    Template ID

  • timezone string

    Java time zone ID (e.g. America/Los_Angeles)

  • type string

    Possible values: [email, slack, splunk, amazon_sqs, jira, microsoft_teams, webhook, aws_security_hub, google_cscc, service_now, pager_duty, azure_service_bus_queue, demisto, aws_s3, snowflake]

    Integration type

  • withCompression boolean

    Compress detailed report

  • ]
  • allowAutoRemediate boolean

    Allow Auto-Remediation

  • delayNotificationMs int64

    Delay notifications by the specified milliseconds

  • description string

    Rule/Scan description

  • enabled boolean

    Rule/Scan is enabled

  • lastModifiedBy string

    Last modified by

  • lastModifiedOn int64

    Last modified on this date/time in milliseconds

  • name string required

    Rule/Scan name

  • notifyOnDismissed boolean

    include dismissed alerts in notification

  • notifyOnOpen boolean

    include open alerts in notification

  • notifyOnResolved boolean

    include resolved alerts in notification

  • notifyOnSnoozed boolean

    include snoozed alerts in notification

  • policies string[]

    List of specific policies to scan

  • policyLabels string[]

    Policy labels

  • policyScanConfigId string

    Policy Scan Config ID

  • scanAll boolean

    Scan all policies

  • target object

    Model for Target Filter

  • accountGroups string[]

    List of Account group(s)

  • alertRulePolicyFilter object

    Model for Alert Rule Policy Filter

  • availablePolicyFilters string[]

    List of available Alert Rule Policy Filters

  • cloud.type string[]

    Possible values: [ALL, AWS, AZURE, GCP, ALIBABA_CLOUD, OCI, IBM]

    Cloud Type Filter

  • policy.complianceStandard string[]

    Compliance Standard Filter

  • policy.label string[]

    Policy Label Filter

  • policy.severity string[]

    Policy Severity Filter

  • excludedAccounts string[]

    List of excluded accounts

  • includedResourceLists object

    Model for holding the lists resource list ids by resource list type

  • computeAccessGroupIds string[]
  • regions string[]

    List of regions for which alerts will be triggered for account groups. Alerts not associated with specific regions will be triggered regardless of listed regions. If no regions are specified, then the alerts will be triggered for all regions.

  • tags object[]

    List of TargetTag models (resource tags) for which alerts should be triggered

  • Array [
  • key string

    Resource tag target

  • values string[]

    List of value(s) for resource tag key

  • ]
  • ]
  • createdBy string

    Created by

  • createdTs int64

    Creation timestamp in milliseconds

  • description string

    Integration description

  • enabled boolean

    true = Enabled

  • id string

    Integration ID

  • integrationConfig object

    Integration Configuration. The values depend on the integration type.

  • property name* object
  • integrationType string

    Possible values: [EMAIL, SLACK, SPLUNK, AMAZON_SQS, WEBHOOK, MICROSOFT_TEAMS, AZURE_SERVICE_BUS_QUEUE, JIRA, SERVICE_NOW, PAGER_DUTY, DEMISTO, AWS_S3, SNOWFLAKE, TENABLE, QUALYS, AZURE_SECURITY_CENTER, GOOGLE_CSCC, AWS_SECURITY_HUB, OKTA_IDP]

    Integration type

  • lastModifiedBy string

    Last modified by

  • lastModifiedTs int64

    Last modification timestamp in milliseconds

  • name string

    Integration name

  • reason object

    Model for Integration Status Details

  • details object

    Model for Message Details

  • i18nKey string

    Internationalization key

  • statusCode int32

    Status code

  • subject string

    Subject

  • errorType string

    Possible values: [INVALID_CONFIG, TRANSLATION_EXCEPTION, INVALID_TEMPLATE_CONFIG, HTTP_EXCEPTION, OTHERS, TEST]

    Error type

  • lastUpdated int64

    Last updated

  • message string

    Message

  • status string

    Possible values: [GREEN, RED, YELLOW, NA]

    State of integration

  • valid boolean

    true = Is valid

  • ]
Loading...