package equinoxe

You can search for identifiers within the package.

in-package search v0.2.0

equinoxe
- Equinoxe
  - API
    
    Auth
    
    Devices
    
    Ip
    
    Orga
    
    Projects
    
    Users
  - Default_api
  - Json
    
    Infix
    
    Private
  - Make
    
    Auth
    
    C
    
    Devices
    
    Ip
    
    Orga
    
    Projects
    
    Users
  - S

Legend:
Library
Module
Module type
Parameter
Class
Class type

It is the signature that matches the API of the website.

type t

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

val create : 
  ?address:string ->
  ?token:[ `Default | `Str of string | `Path of 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/.

module Auth : sig ... end

This module manages API parts related to authentification.

module Devices : sig ... end

This module manages API parts related to devices.

module Ip : sig ... end

This module manages API parts related to ips.

module Orga : sig ... end

This module manages API parts related to organizations.

module Projects : sig ... end

This module manages API parts related to projects.

module Users : sig ... end

This module manages API parts related to users.