Overview

Query for contextual data integration information.

Authentication and permissions

To use the Contextual data integration service API you need to create a personal or team API key. It's recommended to use permission presets, as they are automatically updated with all relevant permissions. Alternatively, you can manually add the following individual permissions.

Presets	Permission	Description
Contextual Data	`contextual-data:ReadConfig`	Grants access to read contextual-data
	`contextual-data:UpdateConfig`	Required to create, update, or delete contextual-data

Common error response codes

Status Code	Description
`400 Bad Request`	Response code 400
`401 Unauthorized`	Response code 401
`500 Internal Server Error`	Response code 500

Constants

TargetDomain

Value
`ACTION`
`ALERT`
`ENRICHMENT`
`GRAFANA_DASHBOARD`
`KIBANA_DASHBOARD`
`PARSING_RULE`
`SAVED_VIEW`
`CX_CUSTOM_DASHBOARD`
`METRICS_RULE_GROUP`
`EVENTS_TO_METRICS`
`ALERT_V3`

BinaryType

Value
`PREVIEW_IMAGE`
`KIBANA_DASHBOARD_DEFINITION`
`GRAFANA_DASHBOARD_DEFINITION`
`ENRICHMENT_CSV`
`CX_CUSTOM_DASHBOARD_DEFINITION`

PermissionResource

Value
`UNKNOWN`
`ACTION`
`ALERT`
`CUSTOM_ENRICHMENT`
`GEO_ENRICHMENT`
`SECURITY_ENRICHMENT`
`RESOURCE_CLOUD_METADATA_ENRICHMENT`
`GRAFANA_DASHBOARD`
`KIBANA_DASHBOARD`
`PARSING_RULE`
`SAVED_VIEW`
`CX_CUSTOM_DASHBOARD`
`METRICS_RULE_GROUP`
`SPAN_EVENTS_TO_METRICS`
`LOGS_EVENTS_TO_METRICS`

BinaryType

Value
`KIBANA_INDEX_PATTERN`

PushBasedPlatform

Value
`UNDEFINED`
`PLATFORM_BITBUCKET`
`PLATFORM_GITHUB`
`PLATFORM_GITLAB`
`PLATFORM_AWS_SNS`
`PLATFORM_OPSGENIE`
`PLATFORM_PAGERDUTY`
`PLATFORM_PROMETHEUS`
`PLATFORM_SLACK`
`PLATFORM_INTERCOM`

ConnectionStatus

Value
`PENDING`
`ACTIVE`
`FAILING`
`STATUS_UNKNOWN`

Variant

Value
`DEFAULT`
`GCP`
`OAUTH`
`CUSTOM`

InputType

Value
`API_KEY`
`TEXT`
`LIST_TEXT`
`MULTIPLE_SELECTION`
`BOOLEAN`
`SELECT`
`JSON`
`NUMBER`
`SENSITIVE_DATA`
`JSON_OBJECT_ARRAY`

ConditionType

Value
`UNKNOWN`
`OR`
`AND`

Language

Value
`UNKNOWN`
`BASH`
`JAVASCRIPT`

WebhookType

Value
`UNKNOWN`
`GENERIC`
`SLACK`
`PAGERDUTY`
`SEND_LOG`
`EMAIL_GROUP`
`MICROSOFT_TEAMS`
`JIRA`
`OPSGENIE`
`DEMISTO`
`AWS_EVENT_BRIDGE`
`IBM_EVENT_NOTIFICATIONS`
`MS_TEAMS_WORKFLOW`

MethodType

Value
`UNKNOWN`
`GET`
`POST`
`PUT`

DigestType

Value
`UNKNOWN`
`ERROR_AND_CRITICAL_LOGS`
`FLOW_ANOMALIES`
`SPIKE_ANOMALIES`
`DATA_USAGE`

AttachmentType

Value
`EMPTY`
`METRIC_SNAPSHOT`
`LOGS`

EndpointType

Value
`ENDPOINT_TYPE_DEFAULT_OR_PUBLIC`
`ENDPOINT_TYPE_PRIVATE`

Authentication and permissions​

Common error response codes​

Constants​

Authentication and permissions

Common error response codes

Constants