2.5 KiB

Raw Blame History

stage	group	info
Monitor	Monitor	To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments

Error Tracking settings API (FREE)

Introduced in GitLab 12.7.

Error Tracking project settings

The project settings API allows you to retrieve the Error Tracking settings for a project. Only for project maintainers.

Get Error Tracking settings

GET /projects/:id/error_tracking/settings

Attribute	Type	Required	Description
`id`	integer	yes	The ID or URL-encoded path of the project owned by the authenticated user

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/error_tracking/settings"

Example response:

{
  "active": true,
  "project_name": "sample sentry project",
  "sentry_external_url": "https://sentry.io/myawesomeproject/project",
  "api_url": "https://sentry.io/api/0/projects/myawesomeproject/project",
  "integrated": false
}

Enable or disable the Error Tracking project settings

The API allows you to enable or disable the Error Tracking settings for a project. Only for project maintainers.

PATCH /projects/:id/error_tracking/settings

Attribute	Type	Required	Description
`id`	integer	yes	The ID or URL-encoded path of the project owned by the authenticated user.
`active`	boolean	yes	Pass `true` to enable the already configured error tracking settings or `false` to disable it.
`integrated`	boolean	no	Pass `true` to enable the integrated error tracking backend. Available in GitLab 14.2 and later.

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/error_tracking/settings?active=true"