package equinoxe-hlc
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=53a77e52522f4ddc271678c5a2b3639b59519bcc7d05dc55e751f854c9f25cdb
sha512=7169e110005c3bc9baa43632705f02fa75c9f04e6133b668b7a56870b69571eddfad9c649bc8d87672b8be560c9ed57c284c0fa659ce2eac4f8ff0c098c5a890
README.md.html
README.md
Equinoxe
An Equinix API client library for OCamlAbout
Equinoxe is a library to interact with the Equinix API (formerly known as Packet) in OCaml. Users can use it to gather information, deploy machines or manage your organization within an OCaml program. It comes with a CLI, equinoxe-cli
, that packs most of the functionalities of the API.
:warning: This repository is based on the official API but is not an official work from Equinix. This work is still in active development so the API might not be stable.
Getting started
Installation
To install the Equinoxe via opam
:
$ opam install equinoxe
To install the dev
version of Equinoxe, you have to install it via pinning:
$ opam pin add equinoxe.dev git@github.com:maiste/equinoxe
$ opam install equinoxe
Usage
The goal is to provide a minimal set of functions to interact with Equinix API. To run the the actions available with Equinoxe
you have to install a specific backend (http request client). There are currently two backends: equinoxe-hlc
which relies on Httpaf
and equinoxe-cohttp
which relies on Cohttp
. You can also provide your own custom backend:
module My_Backend : Equinoxe.Backend
module Api = Equinoxe.Make (My_Backend)
Issues
Report issues using the GitHub bugtracker
License
This project is under the MIT License