package equinoxe

  1. Overview
  2. Docs

Module Equinoxe.MakeSource

Factory to build a system to communicate with Equinix API in a strongly-typed way using the Backend gathering system.

It offers OCaml types to manipulate the Equinix API.

Parameters

module B : Backend

Signature

Sourcetype 'a io = 'a B.io
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.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct