Error Tracking settings API
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
Error Tracking project settings
The project settings API allows you to retrieve the Error Tracking settings for a project. Only for users with Maintainer role for the project.
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 |
curl --header "PRIVATE-TOKEN: <your_access_token>" \
--url "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
}
Create Error Tracking settings
The API allows you to create Error Tracking settings for a project. Only for users with Maintainer role for the project.
This API is only available when used with integrated error tracking.
PUT /projects/:id/error_tracking/settings
Supported attributes:
Attribute | Type | Required | Description |
---|---|---|---|
id | integer | yes | The ID or URL-encoded path of the project. |
active | boolean | yes | Pass true to enable the error tracking setting configuration or false to disable it. |
integrated | boolean | yes | Pass true to enable the integrated error tracking backend. |
Example request:
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/1/error_tracking/settings?active=true&integrated=true"
Example response:
{
"active": true,
"project_name": null,
"sentry_external_url": null,
"api_url": null,
"integrated": true
}
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 users with the Maintainer role for the project.
PATCH /projects/:id/error_tracking/settings
Attribute | Type | Required | Description |
---|---|---|---|
id | integer | yes | The ID or URL-encoded path of the project. |
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. |
curl --request PATCH --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/1/error_tracking/settings?active=true"
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
}
Error Tracking client keys
For integrated error tracking feature. Only for users with the Maintainer role for the project.
List project client keys
GET /projects/:id/error_tracking/client_keys
Attribute | Type | Required | Description |
---|---|---|---|
id | integer/string | yes | The ID or URL-encoded path of the project. |
curl --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/5/error_tracking/client_keys"
Example response:
[
{
"id": 1,
"active": true,
"public_key": "glet_aa77551d849c083f76d0bc545ed053a3",
"sentry_dsn": "https://glet_aa77551d849c083f76d0bc545ed053a3@example.com/errortracking/api/v1/projects/5"
},
{
"id": 3,
"active": true,
"public_key": "glet_0ff98b1d849c083f76d0bc545ed053a3",
"sentry_dsn": "https://glet_aa77551d849c083f76d0bc545ed053a3@example.com/errortracking/api/v1/projects/5"
}
]
Create a client key
Creates a new client key for a project. The public key attribute is generated automatically.
POST /projects/:id/error_tracking/client_keys
Attribute | Type | Required | Description |
---|---|---|---|
id | integer/string | yes | The ID or URL-encoded path of the project. |
curl --request POST \
--header "PRIVATE-TOKEN: <your_access_token>" \
--header "Content-Type: application/json" \
--url "https://gitlab.example.com/api/v4/projects/5/error_tracking/client_keys"
Example response:
{
"id": 3,
"active": true,
"public_key": "glet_0ff98b1d849c083f76d0bc545ed053a3",
"sentry_dsn": "https://glet_aa77551d849c083f76d0bc545ed053a3@example.com/errortracking/api/v1/projects/5"
}
Delete a client key
Removes a client key from the project.
DELETE /projects/:id/error_tracking/client_keys/:key_id
Attribute | Type | Required | Description |
---|---|---|---|
id | integer/string | yes | The ID or URL-encoded path of the project. |
key_id | integer | yes | The ID of the client key. |
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/5/error_tracking/client_keys/13"
Docs
Edit this page to fix an error or add an improvement in a merge request.
Create an issue to suggest an improvement to this page.
Product
Create an issue if there's something you don't like about this feature.
Propose functionality by submitting a feature request.
Feature availability and product trials
View pricing to see all GitLab tiers and features, or to upgrade.
Try GitLab for free with access to all features for 30 days.
Get help
If you didn't find what you were looking for, search the docs.
If you want help with something specific and could use community support, post on the GitLab forum.
For problems setting up or using this feature (depending on your GitLab subscription).
Request support