diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-02-05 18:09:06 +0000 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-02-05 18:09:06 +0000 |
| commit | b042382bbf5a4977c5b5c6b0a9a33f4e8ca8d16d (patch) | |
| tree | de31671ab7c6ca8c2a3721cbabd1f2a42b3d0194 /doc/api/error_tracking.md | |
| parent | eabf8fd774fef6a54903e5141138f47bdafeb331 (diff) | |
| download | gitlab-ce-b042382bbf5a4977c5b5c6b0a9a33f4e8ca8d16d.tar.gz | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/error_tracking.md')
| -rw-r--r-- | doc/api/error_tracking.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/api/error_tracking.md b/doc/api/error_tracking.md index 6efafd4189a..e20b74d764b 100644 --- a/doc/api/error_tracking.md +++ b/doc/api/error_tracking.md @@ -30,3 +30,31 @@ Example response: "api_url": "https://sentry.io/api/0/projects/myawesomeproject/project" } ``` + +### 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](README.md#namespaced-path-encoding) owned by the authenticated user. | +| `active` | boolean | yes | Pass `true` to enable the already configured error tracking settings or `false` to disable it. | + +```shell +curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/error_tracking/settings?active=true +``` + +Example response: + +```json +{ + "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" +} +``` |