Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/displague/metal-ruby

EXPERIMENTAL GENERATED Ruby client
https://github.com/displague/metal-ruby
Last synced: 25 days ago
JSON representation
EXPERIMENTAL GENERATED Ruby client
Host: GitHub
URL: https://github.com/displague/metal-ruby
Owner: displague
License: mit
Created: 2021-03-12T21:50:34.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2021-03-12T21:51:04.000Z (almost 4 years ago)
Last Synced: 2024-12-13T06:35:19.149Z (27 days ago)
Language: Ruby
Size: 9.5 MB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
- Support: docs/SupportRequestInput.md
Awesome Lists containing this project

README

        # openapi_client

OpenapiClient - the Ruby gem for the Metal API

This is the API for Equinix Metal Product. Interact with your devices, user account, and projects.

This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0

- Package version: 1.0.0

- Build package: org.openapitools.codegen.languages.RubyClientCodegen

## Installation

### Build a gem

To build the Ruby code into a gem:

```shell

gem build openapi_client.gemspec

```

Then either install the gem locally:

```shell

gem install ./openapi_client-1.0.0.gem

```

(for development, run `gem install --dev ./openapi_client-1.0.0.gem` to install the development dependencies)

or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).

Finally add this to the Gemfile:

    gem 'openapi_client', '~> 1.0.0'

### Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/displague/metal-ruby, then add the following in the Gemfile:

    gem 'openapi_client', :git => 'https://github.com/displague/metal-ruby.git'

### Include the Ruby code directly

Include the Ruby code directly using `-I` as follows:

```shell

ruby -Ilib script.rb

```

## Getting Started

Please follow the [installation](#installation) procedure and then run the following code:

```ruby

# Load the gem

require 'openapi_client'

# Setup authorization

OpenapiClient.configure do |config|

  # Configure API key authorization: x_auth_token

  config.api_key['x_auth_token'] = 'YOUR API KEY'

  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)

  # config.api_key_prefix['x_auth_token'] = 'Bearer'

end

api_instance = OpenapiClient::BGPApi.new

id = TODO # String | Device UUID

bgp_session = OpenapiClient::BGPSessionInput.new # BGPSessionInput | BGP session to create

begin

  #Create a BGP session

  result = api_instance.create_bgp_session(id, bgp_session)

  p result

rescue OpenapiClient::ApiError => e

  puts "Exception when calling BGPApi->create_bgp_session: #{e}"

end

```

## Documentation for API Endpoints

All URIs are relative to *https://api.equinix.com/metal/v1*

Class | Method | HTTP request | Description

------------ | ------------- | ------------- | -------------

*OpenapiClient::BGPApi* | [**create_bgp_session**](docs/BGPApi.md#create_bgp_session) | **POST** /devices/{id}/bgp/sessions | Create a BGP session

*OpenapiClient::BGPApi* | [**delete_bgp_session**](docs/BGPApi.md#delete_bgp_session) | **DELETE** /bgp/sessions/{id} | Delete the BGP session

*OpenapiClient::BGPApi* | [**find_bgp_config_by_project**](docs/BGPApi.md#find_bgp_config_by_project) | **GET** /projects/{id}/bgp-config | Retrieve a bgp config

*OpenapiClient::BGPApi* | [**find_bgp_session_by_id**](docs/BGPApi.md#find_bgp_session_by_id) | **GET** /bgp/sessions/{id} | Retrieve a BGP session

*OpenapiClient::BGPApi* | [**find_bgp_sessions**](docs/BGPApi.md#find_bgp_sessions) | **GET** /devices/{id}/bgp/sessions | Retrieve all BGP sessions

*OpenapiClient::BGPApi* | [**find_project_bgp_sessions**](docs/BGPApi.md#find_project_bgp_sessions) | **GET** /projects/{id}/bgp/sessions | Retrieve all BGP sessions for project

*OpenapiClient::BGPApi* | [**get_bgp_neighbor_data**](docs/BGPApi.md#get_bgp_neighbor_data) | **GET** /devices/{id}/bgp/neighbors | Retrieve BGP neighbor data for this device

*OpenapiClient::BGPApi* | [**request_bgp_config**](docs/BGPApi.md#request_bgp_config) | **POST** /projects/{id}/bgp-configs | Requesting bgp config

*OpenapiClient::BGPApi* | [**update_bgp_session**](docs/BGPApi.md#update_bgp_session) | **PUT** /bgp/sessions/{id} | Update the BGP session

*OpenapiClient::BatchesApi* | [**create_device_batch**](docs/BatchesApi.md#create_device_batch) | **POST** /projects/{id}/devices/batch | Create a devices batch

*OpenapiClient::BatchesApi* | [**delete_batch**](docs/BatchesApi.md#delete_batch) | **DELETE** /batches/{id} | Delete the Batch

*OpenapiClient::BatchesApi* | [**find_batch_by_id**](docs/BatchesApi.md#find_batch_by_id) | **GET** /batches/{id} | Retrieve a Batch

*OpenapiClient::BatchesApi* | [**find_batches_by_project**](docs/BatchesApi.md#find_batches_by_project) | **GET** /projects/{id}/batches | Retrieve all batches by project

*OpenapiClient::CapacityApi* | [**check_capacity_for_facility**](docs/CapacityApi.md#check_capacity_for_facility) | **POST** /capacity | Check capacity

*OpenapiClient::CapacityApi* | [**find_capacity_for_facility**](docs/CapacityApi.md#find_capacity_for_facility) | **GET** /capacity | View capacity

*OpenapiClient::ConnectionsApi* | [**create_connection_port_virtual_circuit**](docs/ConnectionsApi.md#create_connection_port_virtual_circuit) | **POST** /connections/{connection_id}/ports/{port_id}/virtual-circuits | Create a new Virtual Circuit

*OpenapiClient::ConnectionsApi* | [**create_organization_interconnection**](docs/ConnectionsApi.md#create_organization_interconnection) | **POST** /organizations/{organization_id}/connections | Request a new connection for the organization

*OpenapiClient::ConnectionsApi* | [**create_project_interconnection**](docs/ConnectionsApi.md#create_project_interconnection) | **POST** /projects/{project_id}/connections | Request a new connection for the project's organization

*OpenapiClient::ConnectionsApi* | [**delete_interconnection**](docs/ConnectionsApi.md#delete_interconnection) | **DELETE** /connections/{connection_id} | Delete connection

*OpenapiClient::ConnectionsApi* | [**delete_virtual_circuit**](docs/ConnectionsApi.md#delete_virtual_circuit) | **DELETE** /virtual-circuits/{id} | Delete a virtual circuit

*OpenapiClient::ConnectionsApi* | [**find_connection_events**](docs/ConnectionsApi.md#find_connection_events) | **GET** /connections/{connection_id}/events | Retrieve connection events

*OpenapiClient::ConnectionsApi* | [**find_connection_port_events**](docs/ConnectionsApi.md#find_connection_port_events) | **GET** /connections/{connection_id}/ports/{id}/events | Retrieve connection port events

*OpenapiClient::ConnectionsApi* | [**find_virtual_circuit_events**](docs/ConnectionsApi.md#find_virtual_circuit_events) | **GET** /virtual-circuit/{id}/events | Retrieve connection events

*OpenapiClient::ConnectionsApi* | [**get_connection_port**](docs/ConnectionsApi.md#get_connection_port) | **GET** /connections/{connection_id}/ports/{id} | Get a connection port

*OpenapiClient::ConnectionsApi* | [**get_interconnection**](docs/ConnectionsApi.md#get_interconnection) | **GET** /connections/{connection_id} | Get connection

*OpenapiClient::ConnectionsApi* | [**get_virtual_circuit**](docs/ConnectionsApi.md#get_virtual_circuit) | **GET** /virtual-circuits/{id} | Get a virtual circuit

*OpenapiClient::ConnectionsApi* | [**list_connection_port_virtual_circuits**](docs/ConnectionsApi.md#list_connection_port_virtual_circuits) | **GET** /connections/{connection_id}/ports/{port_id}/virtual-circuits | List a connection port's virtual circuits

*OpenapiClient::ConnectionsApi* | [**list_connection_ports**](docs/ConnectionsApi.md#list_connection_ports) | **GET** /connections/{connection_id}/ports | List a connection's ports

*OpenapiClient::ConnectionsApi* | [**organization_list_interconnections**](docs/ConnectionsApi.md#organization_list_interconnections) | **GET** /organizations/{organization_id}/connections | List organization connections

*OpenapiClient::ConnectionsApi* | [**project_list_interconnections**](docs/ConnectionsApi.md#project_list_interconnections) | **GET** /projects/{project_id}/connections | List project connections

*OpenapiClient::ConnectionsApi* | [**update_interconnection**](docs/ConnectionsApi.md#update_interconnection) | **PUT** /connections/{connection_id} | Update connection

*OpenapiClient::ConnectionsApi* | [**update_virtual_circuit**](docs/ConnectionsApi.md#update_virtual_circuit) | **PUT** /virtual-circuits/{id} | Update a virtual circuit

*OpenapiClient::DevicesApi* | [**create_bgp_session**](docs/DevicesApi.md#create_bgp_session) | **POST** /devices/{id}/bgp/sessions | Create a BGP session

*OpenapiClient::DevicesApi* | [**create_device**](docs/DevicesApi.md#create_device) | **POST** /projects/{id}/devices | Create a device

*OpenapiClient::DevicesApi* | [**create_device_batch**](docs/DevicesApi.md#create_device_batch) | **POST** /projects/{id}/devices/batch | Create a devices batch

*OpenapiClient::DevicesApi* | [**create_ip_assignment**](docs/DevicesApi.md#create_ip_assignment) | **POST** /devices/{id}/ips | Create a ip assignment

*OpenapiClient::DevicesApi* | [**delete_device**](docs/DevicesApi.md#delete_device) | **DELETE** /devices/{id} | Delete the device

*OpenapiClient::DevicesApi* | [**find_bgp_sessions**](docs/DevicesApi.md#find_bgp_sessions) | **GET** /devices/{id}/bgp/sessions | Retrieve all BGP sessions

*OpenapiClient::DevicesApi* | [**find_device_by_id**](docs/DevicesApi.md#find_device_by_id) | **GET** /devices/{id} | Retrieve a device

*OpenapiClient::DevicesApi* | [**find_device_customdata**](docs/DevicesApi.md#find_device_customdata) | **GET** /devices/{id}/customdata | Retrieve the custom metadata of an instance

*OpenapiClient::DevicesApi* | [**find_device_events**](docs/DevicesApi.md#find_device_events) | **GET** /devices/{id}/events | Retrieve device's events

*OpenapiClient::DevicesApi* | [**find_device_usages**](docs/DevicesApi.md#find_device_usages) | **GET** /devices/{id}/usages | Retrieve all usages for device

*OpenapiClient::DevicesApi* | [**find_instance_bandwidth**](docs/DevicesApi.md#find_instance_bandwidth) | **GET** /devices/{id}/bandwidth | Retrieve an instance bandwidth

*OpenapiClient::DevicesApi* | [**find_ip_assignment_customdata**](docs/DevicesApi.md#find_ip_assignment_customdata) | **GET** /devices/{instance_id}/ips/{id}/customdata | Retrieve the custom metadata of an IP Assignment

*OpenapiClient::DevicesApi* | [**find_ip_assignments**](docs/DevicesApi.md#find_ip_assignments) | **GET** /devices/{id}/ips | Retrieve all ip assignments

*OpenapiClient::DevicesApi* | [**find_organization_devices**](docs/DevicesApi.md#find_organization_devices) | **GET** /organizations/{id}/devices | Retrieve all devices of an organization

*OpenapiClient::DevicesApi* | [**find_project_devices**](docs/DevicesApi.md#find_project_devices) | **GET** /projects/{id}/devices | Retrieve all devices of a project

*OpenapiClient::DevicesApi* | [**find_project_usage**](docs/DevicesApi.md#find_project_usage) | **GET** /projects/{id}/usages | Retrieve all usages for project

*OpenapiClient::DevicesApi* | [**find_traffic**](docs/DevicesApi.md#find_traffic) | **GET** /devices/{id}/traffic | Retrieve device traffic

*OpenapiClient::DevicesApi* | [**get_bgp_neighbor_data**](docs/DevicesApi.md#get_bgp_neighbor_data) | **GET** /devices/{id}/bgp/neighbors | Retrieve BGP neighbor data for this device

*OpenapiClient::DevicesApi* | [**perform_action**](docs/DevicesApi.md#perform_action) | **POST** /devices/{id}/actions | Perform an action

*OpenapiClient::DevicesApi* | [**update_device**](docs/DevicesApi.md#update_device) | **PUT** /devices/{id} | Update the device

*OpenapiClient::EmailsApi* | [**create_email**](docs/EmailsApi.md#create_email) | **POST** /emails | Create an email

*OpenapiClient::EmailsApi* | [**delete_email**](docs/EmailsApi.md#delete_email) | **DELETE** /emails/{id} | Delete the email

*OpenapiClient::EmailsApi* | [**find_email_by_id**](docs/EmailsApi.md#find_email_by_id) | **GET** /emails/{id} | Retrieve an email

*OpenapiClient::EmailsApi* | [**update_email**](docs/EmailsApi.md#update_email) | **PUT** /emails/{id} | Update the email

*OpenapiClient::EventsApi* | [**find_connection_events**](docs/EventsApi.md#find_connection_events) | **GET** /connections/{connection_id}/events | Retrieve connection events

*OpenapiClient::EventsApi* | [**find_connection_port_events**](docs/EventsApi.md#find_connection_port_events) | **GET** /connections/{connection_id}/ports/{id}/events | Retrieve connection port events

*OpenapiClient::EventsApi* | [**find_device_events**](docs/EventsApi.md#find_device_events) | **GET** /devices/{id}/events | Retrieve device's events

*OpenapiClient::EventsApi* | [**find_event_by_id**](docs/EventsApi.md#find_event_by_id) | **GET** /events/{id} | Retrieve an event

*OpenapiClient::EventsApi* | [**find_events**](docs/EventsApi.md#find_events) | **GET** /events | Retrieve current user's events

*OpenapiClient::EventsApi* | [**find_organization_events**](docs/EventsApi.md#find_organization_events) | **GET** /organizations/{id}/events | Retrieve organization's events

*OpenapiClient::EventsApi* | [**find_project_events**](docs/EventsApi.md#find_project_events) | **GET** /projects/{id}/events | Retrieve project's events

*OpenapiClient::EventsApi* | [**find_virtual_circuit_events**](docs/EventsApi.md#find_virtual_circuit_events) | **GET** /virtual-circuit/{id}/events | Retrieve connection events

*OpenapiClient::EventsApi* | [**find_volume_events**](docs/EventsApi.md#find_volume_events) | **GET** /volumes/{id}/events | Retrieve volume's events

*OpenapiClient::FacilitiesApi* | [**find_facilities**](docs/FacilitiesApi.md#find_facilities) | **GET** /facilities | Retrieve all facilities

*OpenapiClient::FacilitiesApi* | [**find_facilities_by_organization**](docs/FacilitiesApi.md#find_facilities_by_organization) | **GET** /organizations/{id}/facilities | Retrieve all facilities visible by the organization

*OpenapiClient::FacilitiesApi* | [**find_facilities_by_project**](docs/FacilitiesApi.md#find_facilities_by_project) | **GET** /projects/{id}/facilities | Retrieve all facilities visible by the project

*OpenapiClient::HardwareReservationsApi* | [**find_hardware_reservation_by_id**](docs/HardwareReservationsApi.md#find_hardware_reservation_by_id) | **GET** /hardware-reservations/{id} | Retrieve a hardware reservation

*OpenapiClient::HardwareReservationsApi* | [**find_project_hardware_reservations**](docs/HardwareReservationsApi.md#find_project_hardware_reservations) | **GET** /projects/{id}/hardware-reservations | Retrieve all hardware reservations for a given project

*OpenapiClient::HardwareReservationsApi* | [**hardware_reservations_id_move_post**](docs/HardwareReservationsApi.md#hardware_reservations_id_move_post) | **POST** /hardware-reservations/{id}/move | Move a hardware reservation

*OpenapiClient::IPAddressesApi* | [**create_ip_assignment**](docs/IPAddressesApi.md#create_ip_assignment) | **POST** /devices/{id}/ips | Create a ip assignment

*OpenapiClient::IPAddressesApi* | [**delete_ip_address**](docs/IPAddressesApi.md#delete_ip_address) | **DELETE** /ips/{id} | Unassign an ip address

*OpenapiClient::IPAddressesApi* | [**find_ip_address_by_id**](docs/IPAddressesApi.md#find_ip_address_by_id) | **GET** /ips/{id} | Retrieve an ip address

*OpenapiClient::IPAddressesApi* | [**find_ip_address_customdata**](docs/IPAddressesApi.md#find_ip_address_customdata) | **GET** /ips/{id}/customdata | Retrieve the custom metadata of an IP Reservation or IP Assignment

*OpenapiClient::IPAddressesApi* | [**find_ip_assignments**](docs/IPAddressesApi.md#find_ip_assignments) | **GET** /devices/{id}/ips | Retrieve all ip assignments

*OpenapiClient::IPAddressesApi* | [**find_ip_availabilities**](docs/IPAddressesApi.md#find_ip_availabilities) | **GET** /ips/{id}/available | Retrieve all available subnets of a particular reservation

*OpenapiClient::IPAddressesApi* | [**find_ip_reservations**](docs/IPAddressesApi.md#find_ip_reservations) | **GET** /projects/{id}/ips | Retrieve all ip reservations

*OpenapiClient::IPAddressesApi* | [**request_ip_reservation**](docs/IPAddressesApi.md#request_ip_reservation) | **POST** /projects/{id}/ips | Requesting IP reservations

*OpenapiClient::IncidentsApi* | [**incidents_get**](docs/IncidentsApi.md#incidents_get) | **GET** /incidents | Retrieve the number of incidents

*OpenapiClient::InternetGatewaysApi* | [**create_internet_gateway**](docs/InternetGatewaysApi.md#create_internet_gateway) | **POST** /virtual-networks/{id}/internet-gateways | Create an internet gateway

*OpenapiClient::InvitationsApi* | [**accept_invitation**](docs/InvitationsApi.md#accept_invitation) | **PUT** /invitations/{id} | Accept an invitation

*OpenapiClient::InvitationsApi* | [**create_organization_invitation**](docs/InvitationsApi.md#create_organization_invitation) | **POST** /organizations/{id}/invitations | Create an invitation for an organization

*OpenapiClient::InvitationsApi* | [**create_project_invitation**](docs/InvitationsApi.md#create_project_invitation) | **POST** /projects/{project_id}/invitations | Create an invitation for a project

*OpenapiClient::InvitationsApi* | [**decline_invitation**](docs/InvitationsApi.md#decline_invitation) | **DELETE** /invitations/{id} | Decline an invitation

*OpenapiClient::InvitationsApi* | [**find_invitation_by_id**](docs/InvitationsApi.md#find_invitation_by_id) | **GET** /invitations/{id} | View an invitation

*OpenapiClient::InvitationsApi* | [**find_invitations**](docs/InvitationsApi.md#find_invitations) | **GET** /invitations | Retrieve current user invitations

*OpenapiClient::InvitationsApi* | [**find_organization_invitations**](docs/InvitationsApi.md#find_organization_invitations) | **GET** /organizations/{id}/invitations | Retrieve organization invitations

*OpenapiClient::InvitationsApi* | [**find_project_invitations**](docs/InvitationsApi.md#find_project_invitations) | **GET** /projects/{project_id}/invitations | Retrieve project invitations

*OpenapiClient::LicensesApi* | [**create_license**](docs/LicensesApi.md#create_license) | **POST** /projects/{id}/licenses | Create a License

*OpenapiClient::LicensesApi* | [**delete_license**](docs/LicensesApi.md#delete_license) | **DELETE** /licenses/{id} | Delete the license

*OpenapiClient::LicensesApi* | [**find_license_by_id**](docs/LicensesApi.md#find_license_by_id) | **GET** /licenses/{id} | Retrieve a license

*OpenapiClient::LicensesApi* | [**find_project_licenses**](docs/LicensesApi.md#find_project_licenses) | **GET** /projects/{id}/licenses | Retrieve all licenses

*OpenapiClient::LicensesApi* | [**update_license**](docs/LicensesApi.md#update_license) | **PUT** /licenses/{id} | Update the license

*OpenapiClient::MarketApi* | [**find_spot_market_prices**](docs/MarketApi.md#find_spot_market_prices) | **GET** /market/spot/prices | Get current spot market prices

*OpenapiClient::MarketApi* | [**find_spot_market_prices_history**](docs/MarketApi.md#find_spot_market_prices_history) | **GET** /market/spot/prices/history | Get spot market prices for a given period of time

*OpenapiClient::MembershipsApi* | [**delete_membership**](docs/MembershipsApi.md#delete_membership) | **DELETE** /memberships/{id} | Delete the membership

*OpenapiClient::MembershipsApi* | [**find_membership_by_id**](docs/MembershipsApi.md#find_membership_by_id) | **GET** /memberships/{id} | Retrieve a membership

*OpenapiClient::MembershipsApi* | [**find_project_memberships**](docs/MembershipsApi.md#find_project_memberships) | **GET** /projects/{project_id}/memberships | Retrieve project memberships

*OpenapiClient::MembershipsApi* | [**update_membership**](docs/MembershipsApi.md#update_membership) | **PUT** /memberships/{id} | Update the membership

*OpenapiClient::OperatingSystemVersionsApi* | [**find_operating_system_version**](docs/OperatingSystemVersionsApi.md#find_operating_system_version) | **GET** /operating-system-versions | Retrieve all operating system versions

*OpenapiClient::OperatingSystemsApi* | [**find_operating_systems**](docs/OperatingSystemsApi.md#find_operating_systems) | **GET** /operating-systems | Retrieve all operating systems

*OpenapiClient::OperatingSystemsApi* | [**find_operating_systems_by_organization**](docs/OperatingSystemsApi.md#find_operating_systems_by_organization) | **GET** /organizations/{id}/operating-systems | Retrieve all operating systems visible by the organization

*OpenapiClient::OrganizationsApi* | [**create_organization**](docs/OrganizationsApi.md#create_organization) | **POST** /organizations | Create an organization

*OpenapiClient::OrganizationsApi* | [**create_organization_invitation**](docs/OrganizationsApi.md#create_organization_invitation) | **POST** /organizations/{id}/invitations | Create an invitation for an organization

*OpenapiClient::OrganizationsApi* | [**create_organization_project**](docs/OrganizationsApi.md#create_organization_project) | **POST** /organizations/{id}/projects | Create a project for the organization

*OpenapiClient::OrganizationsApi* | [**create_payment_method**](docs/OrganizationsApi.md#create_payment_method) | **POST** /organizations/{id}/payment-methods | Create a payment method for the given organization

*OpenapiClient::OrganizationsApi* | [**delete_organization**](docs/OrganizationsApi.md#delete_organization) | **DELETE** /organizations/{id} | Delete the organization

*OpenapiClient::OrganizationsApi* | [**find_facilities_by_organization**](docs/OrganizationsApi.md#find_facilities_by_organization) | **GET** /organizations/{id}/facilities | Retrieve all facilities visible by the organization

*OpenapiClient::OrganizationsApi* | [**find_operating_systems_by_organization**](docs/OrganizationsApi.md#find_operating_systems_by_organization) | **GET** /organizations/{id}/operating-systems | Retrieve all operating systems visible by the organization

*OpenapiClient::OrganizationsApi* | [**find_organization_by_id**](docs/OrganizationsApi.md#find_organization_by_id) | **GET** /organizations/{id} | Retrieve an organization's details

*OpenapiClient::OrganizationsApi* | [**find_organization_customdata**](docs/OrganizationsApi.md#find_organization_customdata) | **GET** /organizations/{id}/customdata | Retrieve the custom metadata of an organization

*OpenapiClient::OrganizationsApi* | [**find_organization_devices**](docs/OrganizationsApi.md#find_organization_devices) | **GET** /organizations/{id}/devices | Retrieve all devices of an organization

*OpenapiClient::OrganizationsApi* | [**find_organization_events**](docs/OrganizationsApi.md#find_organization_events) | **GET** /organizations/{id}/events | Retrieve organization's events

*OpenapiClient::OrganizationsApi* | [**find_organization_invitations**](docs/OrganizationsApi.md#find_organization_invitations) | **GET** /organizations/{id}/invitations | Retrieve organization invitations

*OpenapiClient::OrganizationsApi* | [**find_organization_payment_methods**](docs/OrganizationsApi.md#find_organization_payment_methods) | **GET** /organizations/{id}/payment-methods | Retrieve all payment methods of an organization

*OpenapiClient::OrganizationsApi* | [**find_organization_projects**](docs/OrganizationsApi.md#find_organization_projects) | **GET** /organizations/{id}/projects | Retrieve all projects of an organization

*OpenapiClient::OrganizationsApi* | [**find_organization_transfers**](docs/OrganizationsApi.md#find_organization_transfers) | **GET** /organizations/{id}/transfers | Retrieve all project transfer requests from or to an organization

*OpenapiClient::OrganizationsApi* | [**find_organizations**](docs/OrganizationsApi.md#find_organizations) | **GET** /organizations | Retrieve all organizations

*OpenapiClient::OrganizationsApi* | [**find_plans_by_organization**](docs/OrganizationsApi.md#find_plans_by_organization) | **GET** /organizations/{id}/plans | Retrieve all plans visible by the organization

*OpenapiClient::OrganizationsApi* | [**update_organization**](docs/OrganizationsApi.md#update_organization) | **PUT** /organizations/{id} | Update the organization

*OpenapiClient::OtpsApi* | [**find_ensure_otp**](docs/OtpsApi.md#find_ensure_otp) | **POST** /user/otp/verify/{otp} | Verify user by providing an OTP

*OpenapiClient::OtpsApi* | [**find_recovery_codes**](docs/OtpsApi.md#find_recovery_codes) | **GET** /user/otp/recovery-codes | Retrieve my recovery codes

*OpenapiClient::OtpsApi* | [**receive_codes**](docs/OtpsApi.md#receive_codes) | **POST** /user/otp/sms/receive | Receive an OTP per sms

*OpenapiClient::OtpsApi* | [**regenerate_codes**](docs/OtpsApi.md#regenerate_codes) | **POST** /user/otp/recovery-codes | Generate new recovery codes

*OpenapiClient::PasswordResetTokensApi* | [**create_password_reset_token**](docs/PasswordResetTokensApi.md#create_password_reset_token) | **POST** /reset-password | Create a password reset token

*OpenapiClient::PasswordResetTokensApi* | [**reset_password**](docs/PasswordResetTokensApi.md#reset_password) | **DELETE** /reset-password | Reset current user password

*OpenapiClient::PaymentMethodsApi* | [**create_payment_method**](docs/PaymentMethodsApi.md#create_payment_method) | **POST** /organizations/{id}/payment-methods | Create a payment method for the given organization

*OpenapiClient::PaymentMethodsApi* | [**delete_payment_method**](docs/PaymentMethodsApi.md#delete_payment_method) | **DELETE** /payment-methods/{id} | Delete the payment method

*OpenapiClient::PaymentMethodsApi* | [**find_organization_payment_methods**](docs/PaymentMethodsApi.md#find_organization_payment_methods) | **GET** /organizations/{id}/payment-methods | Retrieve all payment methods of an organization

*OpenapiClient::PaymentMethodsApi* | [**find_payment_method_by_id**](docs/PaymentMethodsApi.md#find_payment_method_by_id) | **GET** /payment-methods/{id} | Retrieve a payment method

*OpenapiClient::PaymentMethodsApi* | [**update_payment_method**](docs/PaymentMethodsApi.md#update_payment_method) | **PUT** /payment-methods/{id} | Update the payment method

*OpenapiClient::PlansApi* | [**find_plans**](docs/PlansApi.md#find_plans) | **GET** /plans | Retrieve all plans

*OpenapiClient::PlansApi* | [**find_plans_by_organization**](docs/PlansApi.md#find_plans_by_organization) | **GET** /organizations/{id}/plans | Retrieve all plans visible by the organization

*OpenapiClient::PlansApi* | [**find_plans_by_project**](docs/PlansApi.md#find_plans_by_project) | **GET** /projects/{id}/plans | Retrieve all plans visible by the project

*OpenapiClient::PortsApi* | [**assign_native_vlan**](docs/PortsApi.md#assign_native_vlan) | **POST** /ports/{id}/native-vlan | Assign a native VLAN

*OpenapiClient::PortsApi* | [**assign_port**](docs/PortsApi.md#assign_port) | **POST** /ports/{id}/assign | Assign a port to virtual network

*OpenapiClient::PortsApi* | [**bond_port**](docs/PortsApi.md#bond_port) | **POST** /ports/{id}/bond | Enabling bonding

*OpenapiClient::PortsApi* | [**convert_layer2**](docs/PortsApi.md#convert_layer2) | **POST** /ports/{id}/convert/layer-2 | Convert to Layer 2

*OpenapiClient::PortsApi* | [**convert_layer3**](docs/PortsApi.md#convert_layer3) | **POST** /ports/{id}/convert/layer-3 | Convert to Layer 3

*OpenapiClient::PortsApi* | [**delete_native_vlan**](docs/PortsApi.md#delete_native_vlan) | **DELETE** /ports/{id}/native-vlan | Remove native VLAN

*OpenapiClient::PortsApi* | [**disbond_port**](docs/PortsApi.md#disbond_port) | **POST** /ports/{id}/disbond | Disabling bonding

*OpenapiClient::PortsApi* | [**find_port_by_id**](docs/PortsApi.md#find_port_by_id) | **GET** /ports/{id} | Retrieve a port

*OpenapiClient::PortsApi* | [**unassign_port**](docs/PortsApi.md#unassign_port) | **POST** /ports/{id}/unassign | Unassign a port

*OpenapiClient::ProjectsApi* | [**create_device**](docs/ProjectsApi.md#create_device) | **POST** /projects/{id}/devices | Create a device

*OpenapiClient::ProjectsApi* | [**create_license**](docs/ProjectsApi.md#create_license) | **POST** /projects/{id}/licenses | Create a License

*OpenapiClient::ProjectsApi* | [**create_organization_project**](docs/ProjectsApi.md#create_organization_project) | **POST** /organizations/{id}/projects | Create a project for the organization

*OpenapiClient::ProjectsApi* | [**create_project**](docs/ProjectsApi.md#create_project) | **POST** /projects | Create a project

*OpenapiClient::ProjectsApi* | [**create_project_invitation**](docs/ProjectsApi.md#create_project_invitation) | **POST** /projects/{project_id}/invitations | Create an invitation for a project

*OpenapiClient::ProjectsApi* | [**create_project_ssh_key**](docs/ProjectsApi.md#create_project_ssh_key) | **POST** /projects/{id}/ssh-keys | Create a ssh key for the given project

*OpenapiClient::ProjectsApi* | [**create_spot_market_request**](docs/ProjectsApi.md#create_spot_market_request) | **POST** /projects/{id}/spot-market-requests | Create a spot market request

*OpenapiClient::ProjectsApi* | [**create_transfer_request**](docs/ProjectsApi.md#create_transfer_request) | **POST** /projects/{id}/transfers | Create a transfer request

*OpenapiClient::ProjectsApi* | [**create_virtual_network**](docs/ProjectsApi.md#create_virtual_network) | **POST** /projects/{id}/virtual-networks | Create an virtual network

*OpenapiClient::ProjectsApi* | [**delete_project**](docs/ProjectsApi.md#delete_project) | **DELETE** /projects/{id} | Delete the project

*OpenapiClient::ProjectsApi* | [**find_batches_by_project**](docs/ProjectsApi.md#find_batches_by_project) | **GET** /projects/{id}/batches | Retrieve all batches by project

*OpenapiClient::ProjectsApi* | [**find_bgp_config_by_project**](docs/ProjectsApi.md#find_bgp_config_by_project) | **GET** /projects/{id}/bgp-config | Retrieve a bgp config

*OpenapiClient::ProjectsApi* | [**find_device_ssh_keys**](docs/ProjectsApi.md#find_device_ssh_keys) | **GET** /devices/{id}/ssh-keys | Retrieve a device's ssh keys

*OpenapiClient::ProjectsApi* | [**find_facilities_by_project**](docs/ProjectsApi.md#find_facilities_by_project) | **GET** /projects/{id}/facilities | Retrieve all facilities visible by the project

*OpenapiClient::ProjectsApi* | [**find_ip_reservation_customdata**](docs/ProjectsApi.md#find_ip_reservation_customdata) | **GET** /projects/{project_id}/ips/{id}/customdata | Retrieve the custom metadata of an IP Reservation

*OpenapiClient::ProjectsApi* | [**find_ip_reservations**](docs/ProjectsApi.md#find_ip_reservations) | **GET** /projects/{id}/ips | Retrieve all ip reservations

*OpenapiClient::ProjectsApi* | [**find_organization_projects**](docs/ProjectsApi.md#find_organization_projects) | **GET** /organizations/{id}/projects | Retrieve all projects of an organization

*OpenapiClient::ProjectsApi* | [**find_plans_by_project**](docs/ProjectsApi.md#find_plans_by_project) | **GET** /projects/{id}/plans | Retrieve all plans visible by the project

*OpenapiClient::ProjectsApi* | [**find_project_bgp_sessions**](docs/ProjectsApi.md#find_project_bgp_sessions) | **GET** /projects/{id}/bgp/sessions | Retrieve all BGP sessions for project

*OpenapiClient::ProjectsApi* | [**find_project_by_id**](docs/ProjectsApi.md#find_project_by_id) | **GET** /projects/{id} | Retrieve a project

*OpenapiClient::ProjectsApi* | [**find_project_customdata**](docs/ProjectsApi.md#find_project_customdata) | **GET** /projects/{id}/customdata | Retrieve the custom metadata of a project

*OpenapiClient::ProjectsApi* | [**find_project_devices**](docs/ProjectsApi.md#find_project_devices) | **GET** /projects/{id}/devices | Retrieve all devices of a project

*OpenapiClient::ProjectsApi* | [**find_project_events**](docs/ProjectsApi.md#find_project_events) | **GET** /projects/{id}/events | Retrieve project's events

*OpenapiClient::ProjectsApi* | [**find_project_hardware_reservations**](docs/ProjectsApi.md#find_project_hardware_reservations) | **GET** /projects/{id}/hardware-reservations | Retrieve all hardware reservations for a given project

*OpenapiClient::ProjectsApi* | [**find_project_invitations**](docs/ProjectsApi.md#find_project_invitations) | **GET** /projects/{project_id}/invitations | Retrieve project invitations

*OpenapiClient::ProjectsApi* | [**find_project_licenses**](docs/ProjectsApi.md#find_project_licenses) | **GET** /projects/{id}/licenses | Retrieve all licenses

*OpenapiClient::ProjectsApi* | [**find_project_memberships**](docs/ProjectsApi.md#find_project_memberships) | **GET** /projects/{project_id}/memberships | Retrieve project memberships

*OpenapiClient::ProjectsApi* | [**find_project_ssh_keys**](docs/ProjectsApi.md#find_project_ssh_keys) | **GET** /projects/{id}/ssh-keys | Retrieve a project's ssh keys

*OpenapiClient::ProjectsApi* | [**find_projects**](docs/ProjectsApi.md#find_projects) | **GET** /projects | Retrieve all projects

*OpenapiClient::ProjectsApi* | [**find_virtual_networks**](docs/ProjectsApi.md#find_virtual_networks) | **GET** /projects/{id}/virtual-networks | Retrieve all virtual networks

*OpenapiClient::ProjectsApi* | [**list_spot_market_requests**](docs/ProjectsApi.md#list_spot_market_requests) | **GET** /projects/{id}/spot-market-requests | List spot market requests

*OpenapiClient::ProjectsApi* | [**request_bgp_config**](docs/ProjectsApi.md#request_bgp_config) | **POST** /projects/{id}/bgp-configs | Requesting bgp config

*OpenapiClient::ProjectsApi* | [**request_ip_reservation**](docs/ProjectsApi.md#request_ip_reservation) | **POST** /projects/{id}/ips | Requesting IP reservations

*OpenapiClient::ProjectsApi* | [**update_project**](docs/ProjectsApi.md#update_project) | **PUT** /projects/{id} | Update the project

*OpenapiClient::RegionsApi* | [**find_regions**](docs/RegionsApi.md#find_regions) | **GET** /regions | Retrieve all regions

*OpenapiClient::SSHKeysApi* | [**create_project_ssh_key**](docs/SSHKeysApi.md#create_project_ssh_key) | **POST** /projects/{id}/ssh-keys | Create a ssh key for the given project

*OpenapiClient::SSHKeysApi* | [**create_ssh_key**](docs/SSHKeysApi.md#create_ssh_key) | **POST** /ssh-keys | Create a ssh key for the current user

*OpenapiClient::SSHKeysApi* | [**delete_ssh_key**](docs/SSHKeysApi.md#delete_ssh_key) | **DELETE** /ssh-keys/{id} | Delete the ssh key

*OpenapiClient::SSHKeysApi* | [**find_device_ssh_keys**](docs/SSHKeysApi.md#find_device_ssh_keys) | **GET** /devices/{id}/ssh-keys | Retrieve a device's ssh keys

*OpenapiClient::SSHKeysApi* | [**find_project_ssh_keys**](docs/SSHKeysApi.md#find_project_ssh_keys) | **GET** /projects/{id}/ssh-keys | Retrieve a project's ssh keys

*OpenapiClient::SSHKeysApi* | [**find_ssh_key_by_id**](docs/SSHKeysApi.md#find_ssh_key_by_id) | **GET** /ssh-keys/{id} | Retrieve a ssh key

*OpenapiClient::SSHKeysApi* | [**find_ssh_keys**](docs/SSHKeysApi.md#find_ssh_keys) | **GET** /ssh-keys | Retrieve all ssh keys

*OpenapiClient::SSHKeysApi* | [**update_ssh_key**](docs/SSHKeysApi.md#update_ssh_key) | **PUT** /ssh-keys/{id} | Update the ssh key

*OpenapiClient::SpotMarketRequestApi* | [**create_spot_market_request**](docs/SpotMarketRequestApi.md#create_spot_market_request) | **POST** /projects/{id}/spot-market-requests | Create a spot market request

*OpenapiClient::SpotMarketRequestApi* | [**delete_spot_market_request**](docs/SpotMarketRequestApi.md#delete_spot_market_request) | **DELETE** /spot-market-requests/{id} | Delete the spot market request

*OpenapiClient::SpotMarketRequestApi* | [**find_spot_market_request_by_id**](docs/SpotMarketRequestApi.md#find_spot_market_request_by_id) | **GET** /spot-market-requests/{id} | Retrieve a spot market request

*OpenapiClient::SpotMarketRequestApi* | [**list_spot_market_requests**](docs/SpotMarketRequestApi.md#list_spot_market_requests) | **GET** /projects/{id}/spot-market-requests | List spot market requests

*OpenapiClient::TransferRequestsApi* | [**accept_transfer_request**](docs/TransferRequestsApi.md#accept_transfer_request) | **PUT** /transfers/{id} | Accept a transfer request

*OpenapiClient::TransferRequestsApi* | [**create_transfer_request**](docs/TransferRequestsApi.md#create_transfer_request) | **POST** /projects/{id}/transfers | Create a transfer request

*OpenapiClient::TransferRequestsApi* | [**decline_transfer_request**](docs/TransferRequestsApi.md#decline_transfer_request) | **DELETE** /transfers/{id} | Decline a transfer request

*OpenapiClient::TransferRequestsApi* | [**find_organization_transfers**](docs/TransferRequestsApi.md#find_organization_transfers) | **GET** /organizations/{id}/transfers | Retrieve all project transfer requests from or to an organization

*OpenapiClient::TransferRequestsApi* | [**find_transfer_request_by_id**](docs/TransferRequestsApi.md#find_transfer_request_by_id) | **GET** /transfers/{id} | View a transfer request

*OpenapiClient::TwoFactorAuthApi* | [**disable_tfa_app**](docs/TwoFactorAuthApi.md#disable_tfa_app) | **DELETE** /user/otp/app | Disable two factor authentication

*OpenapiClient::TwoFactorAuthApi* | [**disable_tfa_sms**](docs/TwoFactorAuthApi.md#disable_tfa_sms) | **DELETE** /user/otp/sms | Disable two factor authentication

*OpenapiClient::TwoFactorAuthApi* | [**enable_tfa_app**](docs/TwoFactorAuthApi.md#enable_tfa_app) | **POST** /user/otp/app | Enable two factor auth using app

*OpenapiClient::TwoFactorAuthApi* | [**enable_tfa_sms**](docs/TwoFactorAuthApi.md#enable_tfa_sms) | **POST** /user/otp/sms | Enable two factor auth using sms

*OpenapiClient::UsagesApi* | [**find_device_usages**](docs/UsagesApi.md#find_device_usages) | **GET** /devices/{id}/usages | Retrieve all usages for device

*OpenapiClient::UsagesApi* | [**find_project_usage**](docs/UsagesApi.md#find_project_usage) | **GET** /projects/{id}/usages | Retrieve all usages for project

*OpenapiClient::UserVerificationTokensApi* | [**consume_verification_request**](docs/UserVerificationTokensApi.md#consume_verification_request) | **PUT** /verify-email | Verify a user using an email verification token

*OpenapiClient::UserVerificationTokensApi* | [**create_validation_request**](docs/UserVerificationTokensApi.md#create_validation_request) | **POST** /verify-email | Create an email verification request

*OpenapiClient::UserdataApi* | [**validate_userdata**](docs/UserdataApi.md#validate_userdata) | **POST** /userdata/validate | Validate user data

*OpenapiClient::UsersApi* | [**find_current_user**](docs/UsersApi.md#find_current_user) | **GET** /user | Retrieve the current user

*OpenapiClient::UsersApi* | [**find_invitations**](docs/UsersApi.md#find_invitations) | **GET** /invitations | Retrieve current user invitations

*OpenapiClient::UsersApi* | [**find_user_by_id**](docs/UsersApi.md#find_user_by_id) | **GET** /users/{id} | Retrieve a user

*OpenapiClient::UsersApi* | [**find_user_customdata**](docs/UsersApi.md#find_user_customdata) | **GET** /users/{id}/customdata | Retrieve the custom metadata of a user

*OpenapiClient::UsersApi* | [**find_users**](docs/UsersApi.md#find_users) | **GET** /users | Retrieve all users

*OpenapiClient::UsersApi* | [**update_current_user**](docs/UsersApi.md#update_current_user) | **PUT** /user | Update the current user

*OpenapiClient::VLANsApi* | [**assign_native_vlan**](docs/VLANsApi.md#assign_native_vlan) | **POST** /ports/{id}/native-vlan | Assign a native VLAN

*OpenapiClient::VLANsApi* | [**create_internet_gateway**](docs/VLANsApi.md#create_internet_gateway) | **POST** /virtual-networks/{id}/internet-gateways | Create an internet gateway

*OpenapiClient::VLANsApi* | [**create_virtual_network**](docs/VLANsApi.md#create_virtual_network) | **POST** /projects/{id}/virtual-networks | Create an virtual network

*OpenapiClient::VLANsApi* | [**delete_native_vlan**](docs/VLANsApi.md#delete_native_vlan) | **DELETE** /ports/{id}/native-vlan | Remove native VLAN

*OpenapiClient::VLANsApi* | [**delete_virtual_network**](docs/VLANsApi.md#delete_virtual_network) | **DELETE** /virtual-networks/{id} | Delete a virtual network

*OpenapiClient::VLANsApi* | [**find_virtual_networks**](docs/VLANsApi.md#find_virtual_networks) | **GET** /projects/{id}/virtual-networks | Retrieve all virtual networks

*OpenapiClient::VLANsApi* | [**get_virtual_network**](docs/VLANsApi.md#get_virtual_network) | **GET** /virtual-networks/{id} | Get a virtual network

*OpenapiClient::VPNApi* | [**find_current_user_vpn_config**](docs/VPNApi.md#find_current_user_vpn_config) | **GET** /user/vpn | Retrieve the client vpn config for current user

*OpenapiClient::VPNApi* | [**turn_off_current_user_vpn**](docs/VPNApi.md#turn_off_current_user_vpn) | **DELETE** /user/vpn | Turn off vpn for the current user

*OpenapiClient::VPNApi* | [**turn_on_current_user_vpn**](docs/VPNApi.md#turn_on_current_user_vpn) | **POST** /user/vpn | Turn on vpn for the current user

*OpenapiClient::VolumesApi* | [**clone_volume**](docs/VolumesApi.md#clone_volume) | **POST** /storage/{id}/clone | Clone volume/snapshot

*OpenapiClient::VolumesApi* | [**create_volume**](docs/VolumesApi.md#create_volume) | **POST** /projects/{id}/storage | Create a volume

*OpenapiClient::VolumesApi* | [**create_volume_attachment**](docs/VolumesApi.md#create_volume_attachment) | **POST** /storage/{id}/attachments | Attach your volume

*OpenapiClient::VolumesApi* | [**create_volume_snapshot_policy**](docs/VolumesApi.md#create_volume_snapshot_policy) | **POST** /storage/{id}/snapshot-policies | Create a volume snapshot policy

*OpenapiClient::VolumesApi* | [**delete_volume**](docs/VolumesApi.md#delete_volume) | **DELETE** /storage/{id} | Delete the volume

*OpenapiClient::VolumesApi* | [**delete_volume_attachment**](docs/VolumesApi.md#delete_volume_attachment) | **DELETE** /storage/attachments/{id} | Detach volume

*OpenapiClient::VolumesApi* | [**delete_volume_snapshot**](docs/VolumesApi.md#delete_volume_snapshot) | **DELETE** /storage/{volume_id}/snapshots/{id} | Delete volume snapshot

*OpenapiClient::VolumesApi* | [**delete_volume_snapshot_policy**](docs/VolumesApi.md#delete_volume_snapshot_policy) | **DELETE** /storage/snapshot-policies/{id} | Delete the volume snapshot policy

*OpenapiClient::VolumesApi* | [**find_volume_attachment_by_id**](docs/VolumesApi.md#find_volume_attachment_by_id) | **GET** /storage/attachments/{id} | Retrieve an attachment

*OpenapiClient::VolumesApi* | [**find_volume_attachments**](docs/VolumesApi.md#find_volume_attachments) | **GET** /storage/{id}/attachments | Retrieve all volume attachment

*OpenapiClient::VolumesApi* | [**find_volume_by_id**](docs/VolumesApi.md#find_volume_by_id) | **GET** /storage/{id} | Retrieve a volume

*OpenapiClient::VolumesApi* | [**find_volume_customdata**](docs/VolumesApi.md#find_volume_customdata) | **GET** /storage/{id}/customdata | Retrieve the custom metadata of a storage volume

*OpenapiClient::VolumesApi* | [**find_volume_events**](docs/VolumesApi.md#find_volume_events) | **GET** /volumes/{id}/events | Retrieve volume's events

*OpenapiClient::VolumesApi* | [**find_volume_snapshots**](docs/VolumesApi.md#find_volume_snapshots) | **GET** /storage/{id}/snapshots | Retrieve all volume snapshot

*OpenapiClient::VolumesApi* | [**find_volumes**](docs/VolumesApi.md#find_volumes) | **GET** /projects/{id}/storage | Retrieve all volumes

*OpenapiClient::VolumesApi* | [**restore_volume**](docs/VolumesApi.md#restore_volume) | **POST** /storage/{id}/restore | Restore volume

*OpenapiClient::VolumesApi* | [**update_volume**](docs/VolumesApi.md#update_volume) | **PUT** /storage/{id} | Update the volume

*OpenapiClient::VolumesApi* | [**update_volume_snapshot_policy**](docs/VolumesApi.md#update_volume_snapshot_policy) | **PUT** /storage/snapshot-policies/{id} | Update the volume snapshot policy

## Documentation for Models

 - [OpenapiClient::Address](docs/Address.md)

 - [OpenapiClient::BGPSessionInput](docs/BGPSessionInput.md)

 - [OpenapiClient::Batch](docs/Batch.md)

 - [OpenapiClient::BatchesList](docs/BatchesList.md)

 - [OpenapiClient::BgpConfig](docs/BgpConfig.md)

 - [OpenapiClient::BgpConfigRequestInput](docs/BgpConfigRequestInput.md)

 - [OpenapiClient::BgpNeighborData](docs/BgpNeighborData.md)

 - [OpenapiClient::BgpNeighborDataRoutesIn](docs/BgpNeighborDataRoutesIn.md)

 - [OpenapiClient::BgpNeighborDataRoutesOut](docs/BgpNeighborDataRoutesOut.md)

 - [OpenapiClient::BgpSession](docs/BgpSession.md)

 - [OpenapiClient::BgpSessionList](docs/BgpSessionList.md)

 - [OpenapiClient::BgpSessionNeighbors](docs/BgpSessionNeighbors.md)

 - [OpenapiClient::CapacityCheckPerFacilityInfo](docs/CapacityCheckPerFacilityInfo.md)

 - [OpenapiClient::CapacityCheckPerFacilityList](docs/CapacityCheckPerFacilityList.md)

 - [OpenapiClient::CapacityInput](docs/CapacityInput.md)

 - [OpenapiClient::CapacityLevelPerBaremetal](docs/CapacityLevelPerBaremetal.md)

 - [OpenapiClient::CapacityList](docs/CapacityList.md)

 - [OpenapiClient::CapacityPerBaremetal](docs/CapacityPerBaremetal.md)

 - [OpenapiClient::CapacityPerFacility](docs/CapacityPerFacility.md)

 - [OpenapiClient::CapacityPerNewFacility](docs/CapacityPerNewFacility.md)

 - [OpenapiClient::CapacityReport](docs/CapacityReport.md)

 - [OpenapiClient::Coordinates](docs/Coordinates.md)

 - [OpenapiClient::CreateEmailInput](docs/CreateEmailInput.md)

 - [OpenapiClient::Device](docs/Device.md)

 - [OpenapiClient::DeviceCreateInput](docs/DeviceCreateInput.md)

 - [OpenapiClient::DeviceCreateInputIpAddresses](docs/DeviceCreateInputIpAddresses.md)

 - [OpenapiClient::DeviceList](docs/DeviceList.md)

 - [OpenapiClient::DeviceUpdateInput](docs/DeviceUpdateInput.md)

 - [OpenapiClient::DeviceUsage](docs/DeviceUsage.md)

 - [OpenapiClient::DeviceUsageList](docs/DeviceUsageList.md)

 - [OpenapiClient::Email](docs/Email.md)

 - [OpenapiClient::EmailInput](docs/EmailInput.md)

 - [OpenapiClient::Entitlement](docs/Entitlement.md)

 - [OpenapiClient::EntitlementInput](docs/EntitlementInput.md)

 - [OpenapiClient::EntitlementList](docs/EntitlementList.md)

 - [OpenapiClient::Event](docs/Event.md)

 - [OpenapiClient::EventInput](docs/EventInput.md)

 - [OpenapiClient::EventList](docs/EventList.md)

 - [OpenapiClient::EventType](docs/EventType.md)

 - [OpenapiClient::EventTypeList](docs/EventTypeList.md)

 - [OpenapiClient::Facility](docs/Facility.md)

 - [OpenapiClient::FacilityList](docs/FacilityList.md)

 - [OpenapiClient::GlobalBgpRange](docs/GlobalBgpRange.md)

 - [OpenapiClient::GlobalBgpRangeList](docs/GlobalBgpRangeList.md)

 - [OpenapiClient::HardwareLocation](docs/HardwareLocation.md)

 - [OpenapiClient::HardwareReservation](docs/HardwareReservation.md)

 - [OpenapiClient::HardwareReservationList](docs/HardwareReservationList.md)

 - [OpenapiClient::Href](docs/Href.md)

 - [OpenapiClient::IPAssignment](docs/IPAssignment.md)

 - [OpenapiClient::IPAssignmentInput](docs/IPAssignmentInput.md)

 - [OpenapiClient::IPAssignmentList](docs/IPAssignmentList.md)

 - [OpenapiClient::IPAvailabilitiesList](docs/IPAvailabilitiesList.md)

 - [OpenapiClient::IPReservation](docs/IPReservation.md)

 - [OpenapiClient::IPReservationList](docs/IPReservationList.md)

 - [OpenapiClient::IPReservationRequestInput](docs/IPReservationRequestInput.md)

 - [OpenapiClient::InstancesBatchCreateInput](docs/InstancesBatchCreateInput.md)

 - [OpenapiClient::InstancesBatchCreateInputBatches](docs/InstancesBatchCreateInputBatches.md)

 - [OpenapiClient::InstancesBatchCreateInputIpAddresses](docs/InstancesBatchCreateInputIpAddresses.md)

 - [OpenapiClient::Interconnection](docs/Interconnection.md)

 - [OpenapiClient::InterconnectionCreateInput](docs/InterconnectionCreateInput.md)

 - [OpenapiClient::InterconnectionList](docs/InterconnectionList.md)

 - [OpenapiClient::InterconnectionPort](docs/InterconnectionPort.md)

 - [OpenapiClient::InterconnectionPortList](docs/InterconnectionPortList.md)

 - [OpenapiClient::InterconnectionUpdateInput](docs/InterconnectionUpdateInput.md)

 - [OpenapiClient::InternetGateway](docs/InternetGateway.md)

 - [OpenapiClient::Invitation](docs/Invitation.md)

 - [OpenapiClient::InvitationInput](docs/InvitationInput.md)

 - [OpenapiClient::InvitationList](docs/InvitationList.md)

 - [OpenapiClient::IpAddressInput](docs/IpAddressInput.md)

 - [OpenapiClient::License](docs/License.md)

 - [OpenapiClient::LicenseCreateInput](docs/LicenseCreateInput.md)

 - [OpenapiClient::LicenseList](docs/LicenseList.md)

 - [OpenapiClient::LicenseUpdateInput](docs/LicenseUpdateInput.md)

 - [OpenapiClient::Membership](docs/Membership.md)

 - [OpenapiClient::MembershipInput](docs/MembershipInput.md)

 - [OpenapiClient::MembershipList](docs/MembershipList.md)

 - [OpenapiClient::Meta](docs/Meta.md)

 - [OpenapiClient::NewPassword](docs/NewPassword.md)

 - [OpenapiClient::OperatingSystem](docs/OperatingSystem.md)

 - [OpenapiClient::Organization](docs/Organization.md)

 - [OpenapiClient::OrganizationInput](docs/OrganizationInput.md)

 - [OpenapiClient::OrganizationList](docs/OrganizationList.md)

 - [OpenapiClient::ParentBlock](docs/ParentBlock.md)

 - [OpenapiClient::PaymentMethod](docs/PaymentMethod.md)

 - [OpenapiClient::PaymentMethodBillingAddress](docs/PaymentMethodBillingAddress.md)

 - [OpenapiClient::PaymentMethodCreateInput](docs/PaymentMethodCreateInput.md)

 - [OpenapiClient::PaymentMethodList](docs/PaymentMethodList.md)

 - [OpenapiClient::PaymentMethodUpdateInput](docs/PaymentMethodUpdateInput.md)

 - [OpenapiClient::Plan](docs/Plan.md)

 - [OpenapiClient::PlanList](docs/PlanList.md)

 - [OpenapiClient::PlanVersion](docs/PlanVersion.md)

 - [OpenapiClient::Port](docs/Port.md)

 - [OpenapiClient::PortAssignInput](docs/PortAssignInput.md)

 - [OpenapiClient::PortConvertLayer3Input](docs/PortConvertLayer3Input.md)

 - [OpenapiClient::PortConvertLayer3InputRequestIps](docs/PortConvertLayer3InputRequestIps.md)

 - [OpenapiClient::PortList](docs/PortList.md)

 - [OpenapiClient::Project](docs/Project.md)

 - [OpenapiClient::ProjectCreateFromRootInput](docs/ProjectCreateFromRootInput.md)

 - [OpenapiClient::ProjectCreateInput](docs/ProjectCreateInput.md)

 - [OpenapiClient::ProjectList](docs/ProjectList.md)

 - [OpenapiClient::ProjectUpdateInput](docs/ProjectUpdateInput.md)

 - [OpenapiClient::ProjectUsage](docs/ProjectUsage.md)

 - [OpenapiClient::ProjectUsageList](docs/ProjectUsageList.md)

 - [OpenapiClient::RecoveryCodeList](docs/RecoveryCodeList.md)

 - [OpenapiClient::Region](docs/Region.md)

 - [OpenapiClient::RegionsList](docs/RegionsList.md)

 - [OpenapiClient::SSHKey](docs/SSHKey.md)

 - [OpenapiClient::SSHKeyInput](docs/SSHKeyInput.md)

 - [OpenapiClient::SSHKeyList](docs/SSHKeyList.md)

 - [OpenapiClient::ServerInfo](docs/ServerInfo.md)

 - [OpenapiClient::SnapshotPolicy](docs/SnapshotPolicy.md)

 - [OpenapiClient::SnapshotPolicyInput](docs/SnapshotPolicyInput.md)

 - [OpenapiClient::SpotMarketPricesList](docs/SpotMarketPricesList.md)

 - [OpenapiClient::SpotMarketRequest](docs/SpotMarketRequest.md)

 - [OpenapiClient::SpotMarketRequestCreateInput](docs/SpotMarketRequestCreateInput.md)

 - [OpenapiClient::SpotMarketRequestCreateInputInstanceAttributes](docs/SpotMarketRequestCreateInputInstanceAttributes.md)

 - [OpenapiClient::SpotMarketRequestList](docs/SpotMarketRequestList.md)

 - [OpenapiClient::SpotPricesDatapoints](docs/SpotPricesDatapoints.md)

 - [OpenapiClient::SpotPricesHistoryReport](docs/SpotPricesHistoryReport.md)

 - [OpenapiClient::SpotPricesPerBaremetal](docs/SpotPricesPerBaremetal.md)

 - [OpenapiClient::SpotPricesPerFacility](docs/SpotPricesPerFacility.md)

 - [OpenapiClient::SpotPricesPerNewFacility](docs/SpotPricesPerNewFacility.md)

 - [OpenapiClient::SpotPricesReport](docs/SpotPricesReport.md)

 - [OpenapiClient::SubscribableEvent](docs/SubscribableEvent.md)

 - [OpenapiClient::SubscribableEventsList](docs/SubscribableEventsList.md)

 - [OpenapiClient::SupportRequestInput](docs/SupportRequestInput.md)

 - [OpenapiClient::Timeframe](docs/Timeframe.md)

 - [OpenapiClient::TransferRequest](docs/TransferRequest.md)

 - [OpenapiClient::TransferRequestInput](docs/TransferRequestInput.md)

 - [OpenapiClient::TransferRequestList](docs/TransferRequestList.md)

 - [OpenapiClient::UpdateEmailInput](docs/UpdateEmailInput.md)

 - [OpenapiClient::User](docs/User.md)

 - [OpenapiClient::UserCreateInput](docs/UserCreateInput.md)

 - [OpenapiClient::UserList](docs/UserList.md)

 - [OpenapiClient::UserUpdateInput](docs/UserUpdateInput.md)

 - [OpenapiClient::Userdata](docs/Userdata.md)

 - [OpenapiClient::VPNConfig](docs/VPNConfig.md)

 - [OpenapiClient::VirtualCircuit](docs/VirtualCircuit.md)

 - [OpenapiClient::VirtualCircuitCreateInput](docs/VirtualCircuitCreateInput.md)

 - [OpenapiClient::VirtualCircuitList](docs/VirtualCircuitList.md)

 - [OpenapiClient::VirtualCircuitUpdateInput](docs/VirtualCircuitUpdateInput.md)

 - [OpenapiClient::VirtualNetwork](docs/VirtualNetwork.md)

 - [OpenapiClient::VirtualNetworkCreateInput](docs/VirtualNetworkCreateInput.md)

 - [OpenapiClient::VirtualNetworkList](docs/VirtualNetworkList.md)

 - [OpenapiClient::Volume](docs/Volume.md)

 - [OpenapiClient::VolumeAttachment](docs/VolumeAttachment.md)

 - [OpenapiClient::VolumeAttachmentInput](docs/VolumeAttachmentInput.md)

 - [OpenapiClient::VolumeAttachmentList](docs/VolumeAttachmentList.md)

 - [OpenapiClient::VolumeCreateInput](docs/VolumeCreateInput.md)

 - [OpenapiClient::VolumeList](docs/VolumeList.md)

 - [OpenapiClient::VolumeSnapshot](docs/VolumeSnapshot.md)

 - [OpenapiClient::VolumeSnapshotInput](docs/VolumeSnapshotInput.md)

 - [OpenapiClient::VolumeSnapshotList](docs/VolumeSnapshotList.md)

 - [OpenapiClient::VolumeUpdateInput](docs/VolumeUpdateInput.md)

## Documentation for Authorization

### x_auth_token

- **Type**: API key

- **API key parameter name**: X-Auth-Token

- **Location**: HTTP header