OpsGenie REST API v0.1.0 OpsGenieRESTAPI.Api.DeprecatedPolicy

API calls for all endpoints tagged DeprecatedPolicy.

Link to this section Summary

Functions

Change Alert Policy Order Change execution order of the alert policy with given id

Create Alert Policy Creates a new alert policy

Delete Alert Policy Delete alert policy with given id

Disable Alert Policy Disable the alert policy with given id

Enable Alert Policy Enable the alert policy with given id

Get Alert Policy Used to get details of a single policy with id

List Alert Policies Returns list alert policies

Update Alert Policy Update alert policy with given id

Link to this section Functions

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

Change Alert Policy Order Change execution order of the alert policy with given id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • policy_id (String.t): Id of the requested policy
  • body (DeprecatedChangeAlertPolicyOrderPayload): Change order payload
  • opts (KeywordList): [optional] Optional parameters

Returns

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

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

Create Alert Policy Creates a new alert policy

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • body (DeprecatedAlertPolicy): Payload of created alert policy
  • opts (KeywordList): [optional] Optional parameters

Returns

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

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

Delete Alert Policy Delete alert policy with given id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • policy_id (String.t): Id of the requested policy
  • opts (KeywordList): [optional] Optional parameters

Returns

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

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

Disable Alert Policy Disable the alert policy with given id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • policy_id (String.t): Id of the requested policy
  • opts (KeywordList): [optional] Optional parameters

Returns

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

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

Enable Alert Policy Enable the alert policy with given id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • policy_id (String.t): Id of the requested policy
  • opts (KeywordList): [optional] Optional parameters

Returns

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

Link to this function get_alert_policy(connection, policy_id, opts \\ [])

Get Alert Policy Used to get details of a single policy with id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • policy_id (String.t): Id of the requested policy
  • opts (KeywordList): [optional] Optional parameters

Returns

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

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

List Alert Policies Returns list alert policies

Parameters

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

Returns

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

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

Update Alert Policy Update alert policy with given id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • policy_id (String.t): Id of the requested policy
  • body (DeprecatedAlertPolicy): Payload of updated alert policy
  • opts (KeywordList): [optional] Optional parameters

Returns

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