OpsGenie REST API v0.1.0 OpsGenieRESTAPI.Api.ForwardingRule

API calls for all endpoints tagged ForwardingRule.

Link to this section Summary

Functions

Create Forwarding Rule Creates a new forwarding rule

Delete Forwarding Rule Deletes forwarding rule with given identifier

Get Forwarding Rule Returns forwarding rule with given id or alias

List Forwarding Rules Returns list of forwarding rules

Update Forwarding Rule Update forwarding rule with given rule id or alias

Link to this section Functions

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

Create Forwarding Rule Creates a new forwarding rule

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • body (CreateForwardingRulePayload): Request payload to created forwarding rule
  • opts (KeywordList): [optional] Optional parameters

Returns

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

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

Delete Forwarding Rule Deletes forwarding rule with given identifier

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the forwarding rule which could be forwarding rule 'id' or 'alias'
  • opts (KeywordList): [optional] Optional parameters

    • :identifier_type (String.t): Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'alias'

Returns

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

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

Get Forwarding Rule Returns forwarding rule with given id or alias

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the forwarding rule which could be forwarding rule 'id' or 'alias'
  • opts (KeywordList): [optional] Optional parameters

    • :identifier_type (String.t): Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'alias'

Returns

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

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

List Forwarding Rules Returns list of forwarding rules

Parameters

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

Returns

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

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

Update Forwarding Rule Update forwarding rule with given rule id or alias

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the forwarding rule which could be forwarding rule 'id' or 'alias'
  • body (UpdateForwardingRulePayload): Request payload of update forwarding rule action
  • opts (KeywordList): [optional] Optional parameters

    • :identifier_type (String.t): Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'alias'

Returns

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