All URIs are relative to https://api.mux.com
| Method | HTTP request | Description |
|---|---|---|
| GetIncident | Get /data/v1/incidents/{INCIDENT_ID} | Get an Incident |
| ListIncidents | Get /data/v1/incidents | List Incidents |
| ListRelatedIncidents | Get /data/v1/incidents/{INCIDENT_ID}/related | List Related Incidents |
IncidentResponse GetIncident(ctx, iNCIDENTID) Get an Incident
Returns the details of an incident.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| iNCIDENTID | string | ID of the Incident |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListIncidentsResponse ListIncidents(ctx, optional) List Incidents
Returns a list of incidents.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *ListIncidentsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ListIncidentsOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | optional.Int32 | Number of items to include in the response | [default to 25] |
| page | optional.Int32 | Offset by this many pages, of the size of `limit` | [default to 1] |
| orderBy | optional.String | Value to order the results by | |
| orderDirection | optional.String | Sort order. | |
| status | optional.String | Status to filter incidents by | |
| severity | optional.String | Severity to filter incidents by |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListRelatedIncidentsResponse ListRelatedIncidents(ctx, iNCIDENTID, optional) List Related Incidents
Returns all the incidents that seem related to a specific incident.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| iNCIDENTID | string | ID of the Incident | |
| optional | *ListRelatedIncidentsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ListRelatedIncidentsOpts struct
| Name | Type | Description | Notes |
|---|
limit | optional.Int32| Number of items to include in the response | [default to 25] page | optional.Int32| Offset by this many pages, of the size of `limit` | [default to 1] orderBy | optional.String| Value to order the results by | orderDirection | optional.String| Sort order. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]