TRtraversal
integrations-v3

Create

Changed on

Create a new named integration instance and start a health check.

Credentials are encrypted and stored in AWS Secrets Manager. Only metadata (name, type, id, timestamps, environment labels) is stored in the database.

After the instance is created, a health check workflow runs in the background against the supplied credentials. The workflow updates last_health_check asynchronously.

Permissions: org admin (own org) or platform admin (any org). organization_id defaults to the caller's own org; platform admins may supply a different org to create integrations on its behalf.

Returns HTTP 201 with the created instance metadata.

post/v3/integrations

Request

  • Base URL
    https://api.traversal.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.traversal.com/v3/integrations
  • Auth
    none declared

Query parameters

organization_idstring nullable

Request body

namestring required

Human-readable display name for this integration instance. Must be unique within the organization for a given type. Examples: 'datadog-prod', 'opensearch-us-east', 'github-main-org'.

descriptionstring nullable

Optional description of this integration instance. This description is surfaced directly to Traversal's AI during incident investigations, so include context that helps the AI understand when and how to use this integration — such as which environment it covers, which services or teams own it, and any relevant scope or access limitations. Examples: 'Primary account for US-East production — covers all API and worker services owned by the platform team', 'Read-only OpenSearch cluster for production log analysis — indexes rotate daily, retain 30 days'.

network_accessstring nullable

Name of the network this integration should connect through (e.g. an internal VPN). Omit or set to null to connect over the public internet.

environment_labelsstring[] nullable

The customer's own names for the environments this integration's data covers, e.g. ["prod", "staging"]. Lowercased, trimmed and deduped on the way in, so PROD and prod are one environment. At most 10 labels of 20 characters each. Use the reserved "unscoped" alone when the data is not split by environment at all — it cannot be combined with any other label. Omit or leave null to store none; every dataset this instance owns inherits the labels at population time.

Response

Successful Response

idstring required

Stable UUID for this integration instance. Use this in PUT /v3/integrations/{id} and DELETE /v3/integrations/{id}.

organization_idstring required

UUID of the organization that owns this integration instance.

namestring required

Human-readable display name set at creation time.

descriptionstring nullable

Optional free-text description of this integration instance. Surfaced to Traversal's AI during investigations to help it understand when and how to use this integration.

type'anthropic' | 'openai' | 'gradient_ai' | 'datadog' | 'elasticsearch' | 'prometheus' | 'mimir' | 'victoria_metrics' | 'grafana' | 'appdynamics' | 'servicenow' | 'github' | 'github_webhook' | 'gitlab' | 'thousandeyes' | 'linear' | 'notion' | 'loki' | 'opensearch' | 'splunk' | 'gcp' | 'motherduck' | 'confluence' | 'coralogix' | 'firehydrant' | 'pagerduty' | 'slack' | 'teams' | 'jira' | 'kubernetes' | 'traversal' | 'traversal_webhook' | 'traversal_api_key' | 'incident_io' | 'sentry' | 'tempo' | 'alexandria' | 'honeycomb' | 'alertmanager' | 'emim' | 'trailblazer' | 'dynatrace' | 'cribl' | 'mcp' | 'aws_cli' | 'artifactory' | 'spinnaker' | 'amex_webex_captions' | 'deptracker' | 'do_service_catalog' | 'cloudwatch' | 'azure_devops' | 'azure' required

Canonical integration platform types.

Represents the platform or system where data originates from. Used to determine appropriate connectors, authentication, and API clients.

third_party_idstring nullable

Optional opaque identifier from the third-party system (e.g. a Log Store instance ID). Populated automatically from the integration payload when present.

enabled_data_typesstring[] required

List of data-type capabilities enabled for this integration (e.g. ["logs", "metrics"]). Controlled by the integration payload.

metadataobject

Non-secret integration-specific metadata stored with this instance.

created_atstring date-time nullable

ISO-8601 timestamp of when this integration instance was created.

updated_atstring date-time nullable

ISO-8601 timestamp of the most recent update to this instance.

created_bystring nullable

UUID of the user who created this integration instance, if known.

connector_idstring nullable

UUID of the org connector this instance routes through. Null when the instance connects over the public internet.

network_accessstring nullable

Name of the network this integration connects through (e.g. an internal VPN). Null when the integration connects over the public internet.

environment_labelsstring[]

The customer's own names for the environments this integration's data covers, e.g. ["prod", "staging"], normalized to lowercase. Empty when the instance has none. The single reserved value "unscoped" means the data is deliberately not split by environment, which is distinct from the empty list meaning nobody has labelled it yet.

Changes

  • 31e1a8b7cf89Revision changes
    • warning

      added the new azure enum value to the response property for the response status

    • info

      the request property default value changed from logs metrics to metrics logs

    • info

      the request property default value changed from logs traces metrics to metrics logs traces

    • info

      added azure discriminator mapping keys to the request property

    • info

      added to the request property oneOf list

  • 88beb50883b9Revision changes
    • info

      the request property default value changed from metrics logs to logs metrics

    • info

      the request property default value changed from metrics traces logs to logs traces metrics