package equinoxe-hlc

  1. Overview
  2. Docs

Module Equinoxe_hlcSource

It provides an API call system relying on Http_lwt_client.

Sourcemodule Backend : Equinoxe.Backend with type 'a io = ('a, [ `Msg of string ]) Lwt_result.t

This module gathers all the methods you need to be able to execute HTTP requests to contact an API server. It must send application/json request.

Sourcetype 'a io = ('a, [ `Msg of string ]) Lwt_result.t
Sourcetype t

Abstract type t represents the information known by the API system.

Sourceval create : ?address:string -> ?token:string -> unit -> t

create ~address ~token () returns an t object, you need to manipulate when executing requests. Default address is https://api.equinix.com/metal/v1/ and default token is empty.

Sourceexception Unknown_value of string * string

This exception represents an error when parsing works but the value received is unknown.

Sourcemodule Orga : sig ... end

A module to interact with Equinix organization.

Sourcemodule User : sig ... end

A module to interact with Equinix user.

Sourcemodule Auth : sig ... end

This module manages API parts related to authentification.

Sourcemodule Ip : sig ... end

This module manages API parts related to ips.

Sourcemodule Project : sig ... end

This module manages API parts related to projects.

Sourcemodule State : sig ... end

This module represents the state of a Device in the Equinix API.

Sourcemodule Event : sig ... end

This module deals with events that occure in Equinix.

Sourcemodule Device : sig ... end

This module manages API parts related to devices.