github.com/muxinc/mux-go@v1.1.1/docs/IncidentsApi.md (about)

     1  # \IncidentsApi
     2  
     3  All URIs are relative to *https://api.mux.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**GetIncident**](IncidentsApi.md#GetIncident) | **Get** /data/v1/incidents/{INCIDENT_ID} | Get an Incident
     8  [**ListIncidents**](IncidentsApi.md#ListIncidents) | **Get** /data/v1/incidents | List Incidents
     9  [**ListRelatedIncidents**](IncidentsApi.md#ListRelatedIncidents) | **Get** /data/v1/incidents/{INCIDENT_ID}/related | List Related Incidents
    10  
    11  
    12  # **GetIncident**
    13  > IncidentResponse GetIncident(ctx, iNCIDENTID)
    14  Get an Incident
    15  
    16  Returns the details of an incident.
    17  
    18  ### Required Parameters
    19  
    20  Name | Type | Description  | Notes
    21  ------------- | ------------- | ------------- | -------------
    22   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    23    **iNCIDENTID** | **string**| ID of the Incident | 
    24  
    25  ### Return type
    26  
    27  [**IncidentResponse**](IncidentResponse.md)
    28  
    29  ### Authorization
    30  
    31  [accessToken](../README.md#accessToken)
    32  
    33  ### HTTP request headers
    34  
    35   - **Content-Type**: Not defined
    36   - **Accept**: application/json
    37  
    38  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    39  
    40  # **ListIncidents**
    41  > ListIncidentsResponse ListIncidents(ctx, optional)
    42  List Incidents
    43  
    44  Returns a list of incidents.
    45  
    46  ### Required Parameters
    47  
    48  Name | Type | Description  | Notes
    49  ------------- | ------------- | ------------- | -------------
    50   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    51   **optional** | ***ListIncidentsOpts** | optional parameters | nil if no parameters
    52  
    53  ### Optional Parameters
    54  Optional parameters are passed through a pointer to a ListIncidentsOpts struct
    55  
    56  Name | Type | Description  | Notes
    57  ------------- | ------------- | ------------- | -------------
    58   **limit** | **optional.Int32**| Number of items to include in the response | [default to 25]
    59   **page** | **optional.Int32**| Offset by this many pages, of the size of `limit` | [default to 1]
    60   **orderBy** | **optional.String**| Value to order the results by | 
    61   **orderDirection** | **optional.String**| Sort order. | 
    62   **status** | **optional.String**| Status to filter incidents by | 
    63   **severity** | **optional.String**| Severity to filter incidents by | 
    64  
    65  ### Return type
    66  
    67  [**ListIncidentsResponse**](ListIncidentsResponse.md)
    68  
    69  ### Authorization
    70  
    71  [accessToken](../README.md#accessToken)
    72  
    73  ### HTTP request headers
    74  
    75   - **Content-Type**: Not defined
    76   - **Accept**: application/json
    77  
    78  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    79  
    80  # **ListRelatedIncidents**
    81  > ListRelatedIncidentsResponse ListRelatedIncidents(ctx, iNCIDENTID, optional)
    82  List Related Incidents
    83  
    84  Returns all the incidents that seem related to a specific incident.
    85  
    86  ### Required Parameters
    87  
    88  Name | Type | Description  | Notes
    89  ------------- | ------------- | ------------- | -------------
    90   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    91    **iNCIDENTID** | **string**| ID of the Incident | 
    92   **optional** | ***ListRelatedIncidentsOpts** | optional parameters | nil if no parameters
    93  
    94  ### Optional Parameters
    95  Optional parameters are passed through a pointer to a ListRelatedIncidentsOpts struct
    96  
    97  Name | Type | Description  | Notes
    98  ------------- | ------------- | ------------- | -------------
    99  
   100   **limit** | **optional.Int32**| Number of items to include in the response | [default to 25]
   101   **page** | **optional.Int32**| Offset by this many pages, of the size of `limit` | [default to 1]
   102   **orderBy** | **optional.String**| Value to order the results by | 
   103   **orderDirection** | **optional.String**| Sort order. | 
   104  
   105  ### Return type
   106  
   107  [**ListRelatedIncidentsResponse**](ListRelatedIncidentsResponse.md)
   108  
   109  ### Authorization
   110  
   111  [accessToken](../README.md#accessToken)
   112  
   113  ### HTTP request headers
   114  
   115   - **Content-Type**: Not defined
   116   - **Accept**: application/json
   117  
   118  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   119