Use this API to interact with metric images for alerts.
Additional endpoints are available with the GraphQL API.
List all metric images
GET /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images
Lists all metric images for a specified alert.
Parameters
| Name | Type | Description |
|---|---|---|
idPath, | String or integer | The ID or URL- Example: 17 |
alert_Path, | Integer | The IID of the Alert Example: 23 |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIEntities |
400 | Bad Request | — |
404 | Not found | — |
Upload a metric image
POST /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images
Uploads a metric image for a specified alert.
Parameters
| Name | Type | Description |
|---|---|---|
idPath, | String or integer | The ID or URL- Example: 17 |
alert_Path, | Integer | The IID of the Alert Example: 23 |
Request body (multipart/form-data)
| Property | Type | Description |
|---|---|---|
fileRequired | String (binary) | The image file to be uploaded |
url | String | The url to view more metric info Example: https: |
url_ | String | A description of the image or URL Example: An example metric |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIEntities |
400 | Bad Request | — |
403 | Forbidden | — |
404 | Not Found | — |
Workhorse authorize metric image file upload
POST /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/authorize
Parameters
| Name | Type | Description |
|---|---|---|
idPath, | String or integer | The ID or URL- Example: 17 |
alert_Path, | Integer | The IID of the Alert Example: 23 |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | — |
400 | Bad Request | — |
403 | Forbidden | — |
404 | Not Found | — |
Update a metric image
PUT /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id}
Updates a specified metric image for an alert.
Parameters
| Name | Type | Description |
|---|---|---|
idPath, | String or integer | The ID or URL- Example: 17 |
alert_Path, | Integer | The IID of the Alert Example: 23 |
metric_Path, | Integer | The ID of metric image Example: 42 |
Request body (multipart/form-data)
| Property | Type | Description |
|---|---|---|
url | String | The url to view more metric info Example: https: |
url_ | String | A description of the image or URL Example: An example metric |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIEntities |
400 | Bad Request | — |
403 | Forbidden | — |
404 | Not Found | — |
422 | Unprocessable entity | — |
Delete a metric image
DELETE /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id}
Deletes a specified metric image for an alert.
Parameters
| Name | Type | Description |
|---|---|---|
idPath, | String or integer | The ID or URL- Example: 17 |
alert_Path, | Integer | The IID of the Alert Example: 23 |
metric_Path, | Integer | The ID of metric image Example: 42 |
Responses
| Code | Description | Schema |
|---|---|---|
204 | No Content | APIEntities |
400 | Bad Request | — |
403 | Forbidden | — |
404 | Not Found | — |
422 | Unprocessable entity | — |
Schemas
Objects returned by the operations above and objects nested in their request bodies.
APIEntitiesMetricImage
| Property | Type | Description |
|---|---|---|
created_ | String (date- | Example:2020- |
file_ | String | Example:/ |
filename | String | Example:file. |
id | Integer (int64) | Example:23 |
url | String | Example:https: |
url_ | String | Example:An example metric |