ex_victor_ops v0.4.1 ExVictorOps.Config

Stores configuration variables used to communicate with VictorOps’ API.

Summary

Functions

Returns the domain fo the VictorOps API. Defaults api.victorops.com”, but can be overridden in config/config.exs

Returns the API ID for your account. Set it in config/config.exs

Returns the API Key for your account. Set it in config/config.exs

Returns the version of the API that ExVictorOps is going to talk to. Defaults to “v1”, but can be overriden in config/config.exs

Returns the combines base URL for the VictorOps API, using the configuration settings given

Functions

api_domain()

Returns the domain fo the VictorOps API. Defaults api.victorops.com”, but can be overridden in config/config.exs

config :ex_victor_ops, api_domain: "other.victorops.com"

Examples

iex> ExVictorOps.Config.api_domain
"api.victorops.com"
api_id()

Returns the API ID for your account. Set it in config/config.exs:

config :ex_victor_ops, api_id: "YOUR_API_ID"

Examples

iex> ExVictorOps.Config.api_id
"foobar"
api_key()

Returns the API Key for your account. Set it in config/config.exs:

config :ex_victor_ops, api_key: "YOUR_API_KEY"

Examples

iex> ExVictorOps.Config.api_key
"helloworld"
api_version()

Returns the version of the API that ExVictorOps is going to talk to. Defaults to “v1”, but can be overriden in config/config.exs

config :ex_victor_ops, api_version: "vX"

Examples

iex> ExVictorOps.Config.api_version
"v1"
base_url()

Returns the combines base URL for the VictorOps API, using the configuration settings given.

Examples

iex> ExVictorOps.Config.base_url “https://api.victorops.com/api-public/v1/“