OpsGenie REST API v0.1.0 OpsGenieRESTAPI.Api.Maintenance

API calls for all endpoints tagged Maintenance.

Link to this section Summary

Functions

Cancel Maintenance Cancel maintenance with given id

Create Maintenance Creates a new maintenance

Delete Maintenance Delete maintenance with given identifier

Get Maintenance Returns maintenance with given id

List Maintenance List maintenance by type

Update Maintenance Update maintenance with given id

Link to this section Functions

Link to this function cancel_maintenance(connection, id, opts \\ [])
cancel_maintenance(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, OpsGenieRESTAPI.Model.SuccessResponse.t()} | {:error, Tesla.Env.t()}

Cancel Maintenance Cancel maintenance with given id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • id (String.t): Identifier of the maintenance to be searched
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %OpsGenieRESTAPI.Model.SuccessResponse{}} on success {:error, info} on failure

Link to this function create_maintenance(connection, body, opts \\ [])

Create Maintenance Creates a new maintenance

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • body (CreateMaintenancePayload): Request payload of the maintenance object
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %OpsGenieRESTAPI.Model.CreateMaintenanceResponse{}} on success {:error, info} on failure

Link to this function delete_maintenance(connection, id, opts \\ [])
delete_maintenance(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, OpsGenieRESTAPI.Model.SuccessResponse.t()} | {:error, Tesla.Env.t()}

Delete Maintenance Delete maintenance with given identifier

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • id (String.t): Identifier of the maintenance to be searched
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %OpsGenieRESTAPI.Model.SuccessResponse{}} on success {:error, info} on failure

Link to this function get_maintenance(connection, id, opts \\ [])

Get Maintenance Returns maintenance with given id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • id (String.t): Identifier of the maintenance to be searched
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %OpsGenieRESTAPI.Model.GetMaintenanceResponse{}} on success {:error, info} on failure

Link to this function list_maintenance(connection, opts \\ [])
list_maintenance(Tesla.Env.client(), keyword()) ::
  {:ok, OpsGenieRESTAPI.Model.ListMaintenanceResponse.t()}
  | {:error, Tesla.Env.t()}

List Maintenance List maintenance by type

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :type (String.t): Type of the maintenance list to be searched

Returns

{:ok, %OpsGenieRESTAPI.Model.ListMaintenanceResponse{}} on success {:error, info} on failure

Link to this function update_maintenance(connection, id, body, opts \\ [])

Update Maintenance Update maintenance with given id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • id (String.t): Identifier of the maintenance to be searched
  • body (UpdateMaintenancePayload): Request payload of the maintenance object
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %OpsGenieRESTAPI.Model.UpdateMaintenanceResponse{}} on success {:error, info} on failure