Skip to content

Create or update the Datadog integration

PUT
/api/v4/projects/{id}/services/datadog

Creates or updates the Datadog integration.

id
required
One of:
string

The ID or URL-encoded path of the project

Example
1
Media type application/json
object
datadog_site

Datadog site to send data to. Learn more about Datadog sites in the documentation.

string
nullable
api_url

Full URL of your Datadog site. Only required if you do not use a standard Datadog site.

string
nullable
api_key
required

API key used for authentication with Datadog.

string
nullable
datadog_ci_visibility

Enable CI Visibility

boolean
nullable
archive_trace_events

When enabled, job logs are collected by Datadog and displayed along with pipeline execution traces.

boolean
nullable
datadog_service

Tag all pipeline data from this GitLab instance in Datadog. Can be used when managing several self-managed deployments.

string
nullable
datadog_env

For self-managed deployments, env tag for all the data sent to Datadog.

string
nullable
datadog_tags

Custom tags in Datadog. Specify one tag per line in the format key:value\nkey2:value2.

string
nullable
pipeline_events

Trigger event when a pipeline status changes.

boolean
nullable
build_events

Trigger event when a build is created.

boolean
nullable
push_events

Trigger event for pushes to the repository.

boolean
nullable
merge_requests_events

Trigger event when a merge request is created, updated, or merged.

boolean
nullable
note_events

Trigger event for new comments.

boolean
nullable
tag_push_events

Trigger event for new tags pushed to the repository.

boolean
nullable
subgroup_events
boolean
nullable
project_events
boolean
nullable
use_inherited_settings

Indicates whether to inherit the default settings. Defaults to false.

boolean
nullable
Example generated
{
"datadog_site": "example",
"api_url": "example",
"api_key": "example",
"datadog_ci_visibility": true,
"archive_trace_events": true,
"datadog_service": "example",
"datadog_env": "example",
"datadog_tags": "example",
"pipeline_events": true,
"build_events": true,
"push_events": true,
"merge_requests_events": true,
"note_events": true,
"tag_push_events": true,
"subgroup_events": true,
"project_events": true,
"use_inherited_settings": true
}

OK

Media type application/json
object
id
integer format: int64
title
string
slug
string
created_at
string format: date-time
updated_at
string format: date-time
active
boolean
commit_events
boolean
push_events
boolean
issues_events
boolean
incident_events
boolean
alert_events
boolean
confidential_issues_events
boolean
merge_requests_events
boolean
tag_push_events
boolean
deployment_events
boolean
note_events
boolean
confidential_note_events
boolean
pipeline_events
boolean
wiki_page_events
boolean
job_events
boolean
comment_on_event_enabled
boolean
inherited
boolean
vulnerability_events
boolean
Example
{
"id": 75,
"title": "Jenkins CI",
"slug": "jenkins",
"created_at": "2019-11-20T11:20:25.297Z",
"updated_at": "2019-11-20T12:24:37.498Z"
}

Bad request

Unauthorized

Not found

Unprocessable entity