Use this API to manage error tracking settings and client keys for a project.
These endpoints require the Maintainer or Owner role.
List all project client keys
GET /api/v4/projects/{id}/error_tracking/client_keys
Lists all integrated error tracking client keys for a specified project.
Parameters
| Name | Type | Description |
|---|---|---|
idPath, | String or integer | The ID or URL- |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIEntities |
400 | Bad Request | — |
404 | Not Found | — |
Create a client key
POST /api/v4/projects/{id}/error_tracking/client_keys
Creates a client key for integrated error tracking in a specified project. The public key attribute is generated automatically.
Parameters
| Name | Type | Description |
|---|---|---|
idPath, | String or integer | The ID or URL- |
Responses
| Code | Description | Schema |
|---|---|---|
201 | Created | APIEntities |
400 | Bad Request | — |
404 | Not Found | — |
Delete a client key
DELETE /api/v4/projects/{id}/error_tracking/client_keys/{key_id}
Deletes an integrated error tracking client key from a specified project.
Parameters
| Name | Type | Description |
|---|---|---|
idPath, | String or integer | The ID or URL- |
key_Path, | Integer | The ID of the client key |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIEntities |
400 | Bad request | — |
401 | Unauthorized | — |
404 | Not found | — |
Retrieve Error Tracking settings for a project
GET /api/v4/projects/{id}/error_tracking/settings
Retrieves the Error Tracking settings for a specified project.
Parameters
| Name | Type | Description |
|---|---|---|
idPath, | String or integer | The ID or URL- |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIEntities |
400 | Bad Request | — |
404 | Not Found | — |
Create Error Tracking settings for a project
PUT /api/v4/projects/{id}/error_tracking/settings
Creates Error Tracking settings for a specified project. You must have the Maintainer or Owner role for the project.
Parameters
| Name | Type | Description |
|---|---|---|
idPath, | String or integer | The ID or URL- |
Request body (application/json)
| Property | Type | Description |
|---|---|---|
activeRequired | Boolean | Pass true to enable the configured Error Tracking settings or false to disable it |
integratedRequired | Boolean | Pass true to enable the integrated Error Tracking backend |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIEntities |
400 | Bad request | — |
401 | Unauthorized | — |
404 | Not found | — |
Update Error Tracking settings for a project
PATCH /api/v4/projects/{id}/error_tracking/settings
Updates Error Tracking settings for a specified project. You must have the Maintainer or Owner role for the project.
Parameters
| Name | Type | Description |
|---|---|---|
idPath, | String or integer | The ID or URL- |
Request body (application/json)
| Property | Type | Description |
|---|---|---|
activeRequired | Boolean | Pass true to enable the already configured Error Tracking settings or false to disable it |
integrated | Boolean | Pass true to enable the integrated Error Tracking backend. |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIEntities |
400 | Bad request | — |
401 | Unauthorized | — |
404 | Not found | — |
Schemas
Objects returned by the operations above and objects nested in their request bodies.
APIEntitiesErrorTrackingClientKey
| Property | Type | Description |
|---|---|---|
active | Boolean | — |
id | Integer (int64) | Example:1 |
public_ | String | Example:glet_ |
sentry_ | String | Example:https: |
APIEntitiesErrorTrackingProjectSetting
| Property | Type | Description |
|---|---|---|
active | Boolean | — |
api_ | String | Example:https: |
integrated | Boolean | — |
project_ | String | Example:sample sentry project |
sentry_ | String | Example:https: |