OpsGenie REST API

v0.1.1

OpsGenie REST API

OpsGenie REST API v0.1.1 OpsGenieRESTAPI.Connection

Handle Tesla connections for OpsGenieRESTAPI.

Link to this section Summary

Types

option()

Functions

delete(url)

Perform a DELETE request. See request/1 or request/2 for options definition

delete(client, url)

Perform a DELETE request. See request/1 or request/2 for options definition

delete(client, url, options)

Perform a DELETE request. See request/1 or request/2 for options definition

get(url)

Perform a GET request. See request/1 or request/2 for options definition

get(client, url)

Perform a GET request. See request/1 or request/2 for options definition

get(client, url, options)

Perform a GET request. See request/1 or request/2 for options definition

head(url)

Perform a HEAD request. See request/1 or request/2 for options definition

head(client, url)

Perform a HEAD request. See request/1 or request/2 for options definition

head(client, url, options)

Perform a HEAD request. See request/1 or request/2 for options definition

new()

Configure an authless client connection

new(api_key)

Configure a client connection with authorization

options(url)

Perform a OPTIONS request. See request/1 or request/2 for options definition

options(client, url)

Perform a OPTIONS request. See request/1 or request/2 for options definition

options(client, url, options)

Perform a OPTIONS request. See request/1 or request/2 for options definition

patch(url, body)

Perform a PATCH request. See request/1 or request/2 for options definition

patch(client, url, body)

Perform a PATCH request. See request/1 or request/2 for options definition

patch(client, url, body, options)

Perform a PATCH request. See request/1 or request/2 for options definition

post(url, body)

Perform a POST request. See request/1 or request/2 for options definition

post(client, url, body)

Perform a POST request. See request/1 or request/2 for options definition

post(client, url, body, options)

Perform a POST request. See request/1 or request/2 for options definition

put(url, body)

Perform a PUT request. See request/1 or request/2 for options definition

put(client, url, body)

Perform a PUT request. See request/1 or request/2 for options definition

put(client, url, body, options)

Perform a PUT request. See request/1 or request/2 for options definition

request(options)

Perform a request. See request/2 for available options

request(client, options)

Perform a request using client function

trace(url)

Perform a TRACE request. See request/1 or request/2 for options definition

trace(client, url)

Perform a TRACE request. See request/1 or request/2 for options definition

trace(client, url, options)

Perform a TRACE request. See request/1 or request/2 for options definition

Link to this section Types

Link to this type option() 
option() ::
  {:method, Tesla.Env.method()}
  | {:url, Tesla.Env.url()}
  | {:query, Tesla.Env.query()}
  | {:headers, Tesla.Env.headers()}
  | {:body, Tesla.Env.body()}
  | {:opts, Tesla.Env.opts()}

Link to this section Functions

Link to this function delete(url) 
delete(Tesla.Env.url()) :: Tesla.Env.t()

Perform a DELETE request. See request/1 or request/2 for options definition.

Example

ExampleApi.delete("/users")
Link to this function delete(client, url) 
delete(Tesla.Env.client(), Tesla.Env.url()) :: Tesla.Env.t()
delete(Tesla.Env.url(), [option()]) :: Tesla.Env.t()

Perform a DELETE request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.delete("/users")
ExampleApi.delete("/users", query: [page: 1])
Link to this function delete(client, url, options) 
delete(Tesla.Env.client(), Tesla.Env.url(), [option()]) :: Tesla.Env.t()

Perform a DELETE request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.delete("/users", query: [page: 1])
Link to this function get(url) 
get(Tesla.Env.url()) :: Tesla.Env.t()

Perform a GET request. See request/1 or request/2 for options definition.

Example

ExampleApi.get("/users")
Link to this function get(client, url) 
get(Tesla.Env.client(), Tesla.Env.url()) :: Tesla.Env.t()
get(Tesla.Env.url(), [option()]) :: Tesla.Env.t()

Perform a GET request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.get("/users")
ExampleApi.get("/users", query: [page: 1])
Link to this function get(client, url, options) 
get(Tesla.Env.client(), Tesla.Env.url(), [option()]) :: Tesla.Env.t()

Perform a GET request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.get("/users", query: [page: 1])
Link to this function head(url) 
head(Tesla.Env.url()) :: Tesla.Env.t()

Perform a HEAD request. See request/1 or request/2 for options definition.

Example

ExampleApi.head("/users")
Link to this function head(client, url) 
head(Tesla.Env.client(), Tesla.Env.url()) :: Tesla.Env.t()
head(Tesla.Env.url(), [option()]) :: Tesla.Env.t()

Perform a HEAD request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.head("/users")
ExampleApi.head("/users", query: [page: 1])
Link to this function head(client, url, options) 
head(Tesla.Env.client(), Tesla.Env.url(), [option()]) :: Tesla.Env.t()

Perform a HEAD request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.head("/users", query: [page: 1])
Link to this function new() 
new() :: Tesla.Env.client()

Configure an authless client connection

Returns

Tesla.Env.client

Link to this function new(api_key) 
new(String.t()) :: Tesla.Env.client()

Configure a client connection with authorization

Returns

Tesla.Env.client

Link to this function options(url) 
options(Tesla.Env.url()) :: Tesla.Env.t()

Perform a OPTIONS request. See request/1 or request/2 for options definition.

Example

ExampleApi.options("/users")
Link to this function options(client, url) 
options(Tesla.Env.client(), Tesla.Env.url()) :: Tesla.Env.t()
options(Tesla.Env.url(), [option()]) :: Tesla.Env.t()

Perform a OPTIONS request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.options("/users")
ExampleApi.options("/users", query: [page: 1])
Link to this function options(client, url, options) 
options(Tesla.Env.client(), Tesla.Env.url(), [option()]) :: Tesla.Env.t()

Perform a OPTIONS request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.options("/users", query: [page: 1])
Link to this function patch(url, body) 
patch(Tesla.Env.url(), Tesla.Env.body()) :: Tesla.Env.t()

Perform a PATCH request. See request/1 or request/2 for options definition.

Example

ExampleApi.patch("/users", %{name: "Jon"})
Link to this function patch(client, url, body) 
patch(Tesla.Env.client(), Tesla.Env.url(), Tesla.Env.body()) :: Tesla.Env.t()
patch(Tesla.Env.url(), Tesla.Env.body(), [option()]) :: Tesla.Env.t()

Perform a PATCH request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.patch("/users", %{name: "Jon"})
ExampleApi.patch("/users", %{name: "Jon"}, query: [scope: "admin"])
Link to this function patch(client, url, body, options) 
patch(Tesla.Env.client(), Tesla.Env.url(), Tesla.Env.body(), [option()]) ::
  Tesla.Env.t()

Perform a PATCH request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.patch("/users", %{name: "Jon"}, query: [scope: "admin"])
Link to this function post(url, body) 
post(Tesla.Env.url(), Tesla.Env.body()) :: Tesla.Env.t()

Perform a POST request. See request/1 or request/2 for options definition.

Example

ExampleApi.post("/users", %{name: "Jon"})
Link to this function post(client, url, body) 
post(Tesla.Env.client(), Tesla.Env.url(), Tesla.Env.body()) :: Tesla.Env.t()
post(Tesla.Env.url(), Tesla.Env.body(), [option()]) :: Tesla.Env.t()

Perform a POST request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.post("/users", %{name: "Jon"})
ExampleApi.post("/users", %{name: "Jon"}, query: [scope: "admin"])
Link to this function post(client, url, body, options) 
post(Tesla.Env.client(), Tesla.Env.url(), Tesla.Env.body(), [option()]) ::
  Tesla.Env.t()

Perform a POST request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.post("/users", %{name: "Jon"}, query: [scope: "admin"])
Link to this function put(url, body) 
put(Tesla.Env.url(), Tesla.Env.body()) :: Tesla.Env.t()

Perform a PUT request. See request/1 or request/2 for options definition.

Example

ExampleApi.put("/users", %{name: "Jon"})
Link to this function put(client, url, body) 
put(Tesla.Env.client(), Tesla.Env.url(), Tesla.Env.body()) :: Tesla.Env.t()
put(Tesla.Env.url(), Tesla.Env.body(), [option()]) :: Tesla.Env.t()

Perform a PUT request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.put("/users", %{name: "Jon"})
ExampleApi.put("/users", %{name: "Jon"}, query: [scope: "admin"])
Link to this function put(client, url, body, options) 
put(Tesla.Env.client(), Tesla.Env.url(), Tesla.Env.body(), [option()]) ::
  Tesla.Env.t()

Perform a PUT request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.put("/users", %{name: "Jon"}, query: [scope: "admin"])
Link to this function request(options) 
request([option()]) :: Tesla.Env.t()

Perform a request. See request/2 for available options.

Link to this function request(client, options) 
request(Tesla.Env.client(), [option()]) :: Tesla.Env.t()

Perform a request using client function

Options:

  • :method - the request method, one of [:head, :get, :delete, :trace, :options, :post, :put, :patch]
  • :url - either full url e.g. “http://example.com/some/path” or just “/some/path” if using Tesla.Middleware.BaseUrl
  • :query - a keyword list of query params, e.g. [page: 1, per_page: 100]
  • :headers - a keyworld list of headers, e.g. [{"content-type", "text/plain"}]

  • :body - depends on used middleware:

    • by default it can be a binary
    • if using e.g. JSON encoding middleware it can be a nested map
    • if adapter supports it it can be a Stream with any of the above
  • :opts - custom, per-request middleware or adapter options

Examples:

ExampleApi.request(method: :get, url: "/users/path")

You can also use shortcut methods like:

ExampleApi.get("/users/1")

or

myclient |> ExampleApi.post("/users", %{name: "Jon"})
Link to this function trace(url) 
trace(Tesla.Env.url()) :: Tesla.Env.t()

Perform a TRACE request. See request/1 or request/2 for options definition.

Example

ExampleApi.trace("/users")
Link to this function trace(client, url) 
trace(Tesla.Env.client(), Tesla.Env.url()) :: Tesla.Env.t()
trace(Tesla.Env.url(), [option()]) :: Tesla.Env.t()

Perform a TRACE request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.trace("/users")
ExampleApi.trace("/users", query: [page: 1])
Link to this function trace(client, url, options) 
trace(Tesla.Env.client(), Tesla.Env.url(), [option()]) :: Tesla.Env.t()

Perform a TRACE request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.trace("/users", query: [page: 1])