debian-mirror-gitlab/doc/api/error_tracking.md

71 lines
2.5 KiB
Markdown
Raw Normal View History

2020-07-28 23:09:34 +05:30
---
stage: Monitor
2021-04-29 21:17:54 +05:30
group: Monitor
2021-02-22 17:27:13 +05:30
info: 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
2020-07-28 23:09:34 +05:30
---
2021-03-11 19:13:27 +05:30
# Error Tracking settings API **(FREE)**
2020-03-13 15:44:24 +05:30
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/34940) in GitLab 12.7.
2020-03-13 15:44:24 +05:30
## Error Tracking project settings
2020-10-24 23:57:45 +05:30
The project settings API allows you to retrieve the [Error Tracking](../operations/error_tracking.md)
settings for a project. Only for project maintainers.
2020-03-13 15:44:24 +05:30
### Get Error Tracking settings
2020-04-08 14:13:33 +05:30
```plaintext
2020-03-13 15:44:24 +05:30
GET /projects/:id/error_tracking/settings
```
| Attribute | Type | Required | Description |
| --------- | ------- | -------- | --------------------- |
2021-09-30 23:02:18 +05:30
| `id` | integer | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user |
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/error_tracking/settings"
2020-03-13 15:44:24 +05:30
```
Example response:
```json
{
"active": true,
"project_name": "sample sentry project",
"sentry_external_url": "https://sentry.io/myawesomeproject/project",
2021-10-27 15:23:28 +05:30
"api_url": "https://sentry.io/api/0/projects/myawesomeproject/project",
"integrated": false
2020-03-13 15:44:24 +05:30
}
```
### 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.
2020-04-08 14:13:33 +05:30
```plaintext
2020-03-13 15:44:24 +05:30
PATCH /projects/:id/error_tracking/settings
```
2021-10-27 15:23:28 +05:30
| Attribute | Type | Required | Description |
| ------------ | ------- | -------- | --------------------- |
| `id` | integer | yes | The ID or [URL-encoded path of the project](index.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. |
| `integrated` | boolean | no | Pass `true` to enable the integrated error tracking backend. Available in [GitLab 14.2](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68260) and later. |
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/error_tracking/settings?active=true"
2020-03-13 15:44:24 +05:30
```
Example response:
```json
{
"active": true,
"project_name": "sample sentry project",
"sentry_external_url": "https://sentry.io/myawesomeproject/project",
2021-10-27 15:23:28 +05:30
"api_url": "https://sentry.io/api/0/projects/myawesomeproject/project",
"integrated": false
2020-03-13 15:44:24 +05:30
}
```