Skip to main content

Get Integration By ID

GET 
/integration/:id

Returns integration details for the specified ID.

This request supports integrations with only the following:

  • Okta
  • Qualys
  • Tenable

To get the integration ID, list the metadata for all integrations.

Request​

Path Parameters

    id stringrequired

    Integration ID

Responses​

successful operation

Schema
    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...