Skip to content

displague/packet-rs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Rust API client for openapi

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

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder and add the following to Cargo.toml under [dependencies]:

    openapi = { path = "./generated" }

Documentation for API Endpoints

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

Class Method HTTP request Description
BGPApi create_bgp_session post /devices/{id}/bgp/sessions Create a BGP session
BGPApi delete_bgp_session delete /bgp/sessions/{id} Delete the BGP session
BGPApi find_bgp_config_by_project get /projects/{id}/bgp-config Retrieve a bgp config
BGPApi find_bgp_session_by_id get /bgp/sessions/{id} Retrieve a BGP session
BGPApi find_bgp_sessions get /devices/{id}/bgp/sessions Retrieve all BGP sessions
BGPApi find_project_bgp_sessions get /projects/{id}/bgp/sessions Retrieve all BGP sessions for project
BGPApi get_bgp_neighbor_data get /devices/{id}/bgp/neighbors Retrieve BGP neighbor data for this device
BGPApi request_bgp_config post /projects/{id}/bgp-configs Requesting bgp config
BGPApi update_bgp_session put /bgp/sessions/{id} Update the BGP session
BatchesApi create_device_batch post /projects/{id}/devices/batch Create a devices batch
BatchesApi delete_batch delete /batches/{id} Delete the Batch
BatchesApi find_batch_by_id get /batches/{id} Retrieve a Batch
BatchesApi find_batches_by_project get /projects/{id}/batches Retrieve all batches by project
CapacityApi check_capacity post /capacity Check capacity
CapacityApi find_capacity get /capacity View capacity
ConnectionsApi create_organization_interconnection post /organizations/{organization_id}/connections Request a new connection for the organization
ConnectionsApi create_project_interconnection post /projects/{project_id}/connections Request a new connection for the project's organization
ConnectionsApi delete_interconnection delete /connections/{id} Delete connection
ConnectionsApi get_connection_port get /connections/{connection_id}/ports/{id} Get a connection port
ConnectionsApi get_interconnection get /connections/{id} Get connection
ConnectionsApi get_virtual_circuit get /virtual-circuits/{id} Get a virtual circuit
ConnectionsApi list_connection_port_virtual_circuits get /connections/{connection_id}/ports/{port_id}/virtual-circuits List a connection port's virtual circuits
ConnectionsApi list_connection_ports get /connections/{connection_id}/ports List a connection's ports
ConnectionsApi organization_list_interconnections get /organizations/{organization_id}/connections List organization connections
ConnectionsApi project_list_interconnections get /projects/{project_id}/connections List project connections
ConnectionsApi update_interconnection put /connections/{id} Update connection
ConnectionsApi update_virtual_circuit put /virtual-circuits/{id} Update a virtual circuit
DevicesApi create_bgp_session post /devices/{id}/bgp/sessions Create a BGP session
DevicesApi create_device post /projects/{id}/devices Create a device
DevicesApi create_device_batch post /projects/{id}/devices/batch Create a devices batch
DevicesApi create_ip_assignment post /devices/{id}/ips Create a ip assignment
DevicesApi delete_device delete /devices/{id} Delete the device
DevicesApi find_bgp_sessions get /devices/{id}/bgp/sessions Retrieve all BGP sessions
DevicesApi find_device_by_id get /devices/{id} Retrieve a device
DevicesApi find_device_customdata get /devices/{id}/customdata Retrieve the custom metadata of an instance
DevicesApi find_device_events get /devices/{id}/events Retrieve device's events
DevicesApi find_device_usages get /devices/{id}/usages Retrieve all usages for device
DevicesApi find_instance_bandwidth get /devices/{id}/bandwidth Retrieve an instance bandwidth
DevicesApi find_ip_assignment_customdata get /devices/{instance_id}/ips/{id}/customdata Retrieve the custom metadata of an IP Assignment
DevicesApi find_ip_assignments get /devices/{id}/ips Retrieve all ip assignments
DevicesApi find_organization_devices get /organizations/{id}/devices Retrieve all devices of an organization
DevicesApi find_project_devices get /projects/{id}/devices Retrieve all devices of a project
DevicesApi find_project_usage get /projects/{id}/usages Retrieve all usages for project
DevicesApi find_traffic get /devices/{id}/traffic Retrieve device traffic
DevicesApi get_bgp_neighbor_data get /devices/{id}/bgp/neighbors Retrieve BGP neighbor data for this device
DevicesApi perform_action post /devices/{id}/actions Perform an action
DevicesApi update_device put /devices/{id} Update the device
EmailsApi create_email post /emails Create an email
EmailsApi delete_email delete /emails/{id} Delete the email
EmailsApi find_email_by_id get /emails/{id} Retrieve an email
EmailsApi update_email put /emails/{id} Update the email
EventsApi find_device_events get /devices/{id}/events Retrieve device's events
EventsApi find_event_by_id get /events/{id} Retrieve an event
EventsApi find_events get /events Retrieve current user's events
EventsApi find_organization_events get /organizations/{id}/events Retrieve organization's events
EventsApi find_project_events get /projects/{id}/events Retrieve project's events
EventsApi find_volume_events get /volumes/{id}/events Retrieve volume's events
FacilitiesApi find_facilities get /facilities Retrieve all facilities
FacilitiesApi find_facilities_by_organization get /organizations/{id}/facilities Retrieve all facilities visible by the organization
FacilitiesApi find_facilities_by_project get /projects/{id}/facilities Retrieve all facilities visible by the project
HardwareReservationsApi find_hardware_reservation_by_id get /hardware-reservations/{id} Retrieve a hardware reservation
HardwareReservationsApi find_project_hardware_reservations get /projects/{id}/hardware-reservations Retrieve all hardware reservations for a given project
HardwareReservationsApi hardware_reservations_id_move_post post /hardware-reservations/{id}/move Move a hardware reservation
IPAddressesApi create_ip_assignment post /devices/{id}/ips Create a ip assignment
IPAddressesApi delete_ip_address delete /ips/{id} Unassign an ip address
IPAddressesApi find_ip_address_by_id get /ips/{id} Retrieve an ip address
IPAddressesApi find_ip_address_customdata get /ips/{id}/customdata Retrieve the custom metadata of an IP Reservation or IP Assignment
IPAddressesApi find_ip_assignments get /devices/{id}/ips Retrieve all ip assignments
IPAddressesApi find_ip_availabilities get /ips/{id}/available Retrieve all available subnets of a particular reservation
IPAddressesApi find_ip_reservations get /projects/{id}/ips Retrieve all ip reservations
IPAddressesApi request_ip_reservation post /projects/{id}/ips Requesting IP reservations
IncidentsApi incidents_get get /incidents Retrieve the number of incidents
InternetGatewaysApi create_internet_gateway post /virtual-networks/{id}/internet-gateways Create an internet gateway
InvitationsApi accept_invitation put /invitations/{id} Accept an invitation
InvitationsApi create_organization_invitation post /organizations/{id}/invitations Create an invitation for an organization
InvitationsApi create_project_invitation post /projects/{project_id}/invitations Create an invitation for a project
InvitationsApi decline_invitation delete /invitations/{id} Decline an invitation
InvitationsApi find_invitation_by_id get /invitations/{id} View an invitation
InvitationsApi find_invitations get /invitations Retrieve current user invitations
InvitationsApi find_organization_invitations get /organizations/{id}/invitations Retrieve organization invitations
InvitationsApi find_project_invitations get /projects/{project_id}/invitations Retrieve project invitations
LicensesApi create_license post /projects/{id}/licenses Create a License
LicensesApi delete_license delete /licenses/{id} Delete the license
LicensesApi find_license_by_id get /licenses/{id} Retrieve a license
LicensesApi find_project_licenses get /projects/{id}/licenses Retrieve all licenses
LicensesApi update_license put /licenses/{id} Update the license
MarketApi find_spot_market_prices get /market/spot/prices Get current spot market prices
MarketApi find_spot_market_prices_history get /market/spot/prices/history Get spot market prices for a given period of time
MembershipsApi delete_membership delete /memberships/{id} Delete the membership
MembershipsApi find_membership_by_id get /memberships/{id} Retrieve a membership
MembershipsApi find_project_memberships get /projects/{project_id}/memberships Retrieve project memberships
MembershipsApi update_membership put /memberships/{id} Update the membership
NotificationsApi find_notifications get /notifications Retrieve all notifications
OperatingSystemVersionsApi find_operating_system_version get /operating-system-versions Retrieve all operating system versions
OperatingSystemsApi find_operating_systems get /operating-systems Retrieve all operating systems
OperatingSystemsApi find_operating_systems_by_organization get /organizations/{id}/operating-systems Retrieve all operating systems visible by the organization
OrganizationsApi create_organization post /organizations Create an organization
OrganizationsApi create_organization_invitation post /organizations/{id}/invitations Create an invitation for an organization
OrganizationsApi create_organization_project post /organizations/{id}/projects Create a project for the organization
OrganizationsApi create_payment_method post /organizations/{id}/payment-methods Create a payment method for the given organization
OrganizationsApi delete_organization delete /organizations/{id} Delete the organization
OrganizationsApi find_facilities_by_organization get /organizations/{id}/facilities Retrieve all facilities visible by the organization
OrganizationsApi find_operating_systems_by_organization get /organizations/{id}/operating-systems Retrieve all operating systems visible by the organization
OrganizationsApi find_organization_by_id get /organizations/{id} Retrieve an organization's details
OrganizationsApi find_organization_customdata get /organizations/{id}/customdata Retrieve the custom metadata of an organization
OrganizationsApi find_organization_devices get /organizations/{id}/devices Retrieve all devices of an organization
OrganizationsApi find_organization_events get /organizations/{id}/events Retrieve organization's events
OrganizationsApi find_organization_invitations get /organizations/{id}/invitations Retrieve organization invitations
OrganizationsApi find_organization_payment_methods get /organizations/{id}/payment-methods Retrieve all payment methods of an organization
OrganizationsApi find_organization_projects get /organizations/{id}/projects Retrieve all projects of an organization
OrganizationsApi find_organization_transfers get /organizations/{id}/transfers Retrieve all project transfer requests from or to an organization
OrganizationsApi find_organizations get /organizations Retrieve all organizations
OrganizationsApi find_plans_by_organization get /organizations/{id}/plans Retrieve all plans visible by the organization
OrganizationsApi update_organization put /organizations/{id} Update the organization
OtpsApi find_ensure_otp post /user/otp/verify/{otp} Verify user by providing an OTP
OtpsApi find_recovery_codes get /user/otp/recovery-codes Retrieve my recovery codes
OtpsApi receive_codes post /user/otp/sms/receive Receive an OTP per sms
OtpsApi regenerate_codes post /user/otp/recovery-codes Generate new recovery codes
PasswordResetTokensApi create_password_reset_token post /reset-password Create a password reset token
PasswordResetTokensApi reset_password delete /reset-password Reset current user password
PaymentMethodsApi create_payment_method post /organizations/{id}/payment-methods Create a payment method for the given organization
PaymentMethodsApi delete_payment_method delete /payment-methods/{id} Delete the payment method
PaymentMethodsApi find_organization_payment_methods get /organizations/{id}/payment-methods Retrieve all payment methods of an organization
PaymentMethodsApi find_payment_method_by_id get /payment-methods/{id} Retrieve a payment method
PaymentMethodsApi update_payment_method put /payment-methods/{id} Update the payment method
PlansApi find_plans get /plans Retrieve all plans
PlansApi find_plans_by_organization get /organizations/{id}/plans Retrieve all plans visible by the organization
PlansApi find_plans_by_project get /projects/{id}/plans Retrieve all plans visible by the project
PortsApi assign_native_vlan post /ports/{id}/native-vlan Assign a native VLAN
PortsApi assign_port post /ports/{id}/assign Assign a port to virtual network
PortsApi bond_port post /ports/{id}/bond Enabling bonding
PortsApi convert_layer2 post /ports/{id}/convert/layer-2 Convert to Layer 2
PortsApi convert_layer3 post /ports/{id}/convert/layer-3 Convert to Layer 3
PortsApi delete_native_vlan delete /ports/{id}/native-vlan Remove native VLAN
PortsApi disbond_port post /ports/{id}/disbond Disabling bonding
PortsApi unassign_port post /ports/{id}/unassign Unassign a port
ProjectsApi create_device post /projects/{id}/devices Create a device
ProjectsApi create_license post /projects/{id}/licenses Create a License
ProjectsApi create_organization_project post /organizations/{id}/projects Create a project for the organization
ProjectsApi create_project post /projects Create a project
ProjectsApi create_project_invitation post /projects/{project_id}/invitations Create an invitation for a project
ProjectsApi create_project_ssh_key post /projects/{id}/ssh-keys Create a ssh key for the given project
ProjectsApi create_spot_market_request post /projects/{id}/spot-market-requests Create a spot market request
ProjectsApi create_transfer_request post /projects/{id}/transfers Create a transfer request
ProjectsApi create_virtual_network post /projects/{id}/virtual-networks Create an virtual network
ProjectsApi delete_project delete /projects/{id} Delete the project
ProjectsApi find_batches_by_project get /projects/{id}/batches Retrieve all batches by project
ProjectsApi find_bgp_config_by_project get /projects/{id}/bgp-config Retrieve a bgp config
ProjectsApi find_device_ssh_keys get /devices/{id}/ssh-keys Retrieve a device's ssh keys
ProjectsApi find_facilities_by_project get /projects/{id}/facilities Retrieve all facilities visible by the project
ProjectsApi find_ip_reservation_customdata get /projects/{project_id}/ips/{id}/customdata Retrieve the custom metadata of an IP Reservation
ProjectsApi find_ip_reservations get /projects/{id}/ips Retrieve all ip reservations
ProjectsApi find_organization_projects get /organizations/{id}/projects Retrieve all projects of an organization
ProjectsApi find_plans_by_project get /projects/{id}/plans Retrieve all plans visible by the project
ProjectsApi find_project_bgp_sessions get /projects/{id}/bgp/sessions Retrieve all BGP sessions for project
ProjectsApi find_project_by_id get /projects/{id} Retrieve a project
ProjectsApi find_project_customdata get /projects/{id}/customdata Retrieve the custom metadata of a project
ProjectsApi find_project_devices get /projects/{id}/devices Retrieve all devices of a project
ProjectsApi find_project_events get /projects/{id}/events Retrieve project's events
ProjectsApi find_project_hardware_reservations get /projects/{id}/hardware-reservations Retrieve all hardware reservations for a given project
ProjectsApi find_project_invitations get /projects/{project_id}/invitations Retrieve project invitations
ProjectsApi find_project_licenses get /projects/{id}/licenses Retrieve all licenses
ProjectsApi find_project_memberships get /projects/{project_id}/memberships Retrieve project memberships
ProjectsApi find_project_ssh_keys get /projects/{id}/ssh-keys Retrieve a project's ssh keys
ProjectsApi find_projects get /projects Retrieve all projects
ProjectsApi find_virtual_networks get /projects/{id}/virtual-networks Retrieve all virtual networks
ProjectsApi list_spot_market_requests get /projects/{id}/spot-market-requests List spot market requests
ProjectsApi request_bgp_config post /projects/{id}/bgp-configs Requesting bgp config
ProjectsApi request_ip_reservation post /projects/{id}/ips Requesting IP reservations
ProjectsApi update_project put /projects/{id} Update the project
RegionsApi find_regions get /regions Retrieve all regions
SSHKeysApi create_project_ssh_key post /projects/{id}/ssh-keys Create a ssh key for the given project
SSHKeysApi create_ssh_key post /ssh-keys Create a ssh key for the current user
SSHKeysApi delete_ssh_key delete /ssh-keys/{id} Delete the ssh key
SSHKeysApi find_device_ssh_keys get /devices/{id}/ssh-keys Retrieve a device's ssh keys
SSHKeysApi find_project_ssh_keys get /projects/{id}/ssh-keys Retrieve a project's ssh keys
SSHKeysApi find_ssh_key_by_id get /ssh-keys/{id} Retrieve a ssh key
SSHKeysApi find_ssh_keys get /ssh-keys Retrieve all ssh keys
SSHKeysApi update_ssh_key put /ssh-keys/{id} Update the ssh key
SpotMarketRequestApi create_spot_market_request post /projects/{id}/spot-market-requests Create a spot market request
SpotMarketRequestApi delete_spot_market_request delete /spot-market-requests/{id} Delete the spot market request
SpotMarketRequestApi find_spot_market_request_by_id get /spot-market-requests/{id} Retrieve a spot market request
SpotMarketRequestApi list_spot_market_requests get /projects/{id}/spot-market-requests List spot market requests
TransferRequestsApi accept_transfer_request put /transfers/{id} Accept a transfer request
TransferRequestsApi create_transfer_request post /projects/{id}/transfers Create a transfer request
TransferRequestsApi decline_transfer_request delete /transfers/{id} Decline a transfer request
TransferRequestsApi find_organization_transfers get /organizations/{id}/transfers Retrieve all project transfer requests from or to an organization
TransferRequestsApi find_transfer_request_by_id get /transfers/{id} View a transfer request
TwoFactorAuthApi disable_tfa_app delete /user/otp/app Disable two factor authentication
TwoFactorAuthApi disable_tfa_sms delete /user/otp/sms Disable two factor authentication
TwoFactorAuthApi enable_tfa_app post /user/otp/app Enable two factor auth using app
TwoFactorAuthApi enable_tfa_sms post /user/otp/sms Enable two factor auth using sms
UsagesApi find_device_usages get /devices/{id}/usages Retrieve all usages for device
UsagesApi find_project_usage get /projects/{id}/usages Retrieve all usages for project
UserVerificationTokensApi consume_verification_request put /verify-email Verify a user using an email verification token
UserVerificationTokensApi create_validation_request post /verify-email Create an email verification request
UserdataApi validate_userdata post /userdata/validate Validate user data
UsersApi find_current_user get /user Retrieve the current user
UsersApi find_invitations get /invitations Retrieve current user invitations
UsersApi find_user_by_id get /users/{id} Retrieve a user
UsersApi find_user_customdata get /users/{id}/customdata Retrieve the custom metadata of a user
UsersApi find_users get /users Retrieve all users
UsersApi update_current_user put /user Update the current user
VLANsApi assign_native_vlan post /ports/{id}/native-vlan Assign a native VLAN
VLANsApi create_internet_gateway post /virtual-networks/{id}/internet-gateways Create an internet gateway
VLANsApi create_virtual_network post /projects/{id}/virtual-networks Create an virtual network
VLANsApi delete_native_vlan delete /ports/{id}/native-vlan Remove native VLAN
VLANsApi delete_virtual_network delete /virtual-networks/{id} Delete a virtual network
VLANsApi find_virtual_networks get /projects/{id}/virtual-networks Retrieve all virtual networks
VLANsApi get_virtual_network get /virtual-networks/{id} Get a virtual network
VPNApi find_current_user_vpn_config get /user/vpn Retrieve the client vpn config for current user
VPNApi turn_off_current_user_vpn delete /user/vpn Turn off vpn for the current user
VPNApi turn_on_current_user_vpn post /user/vpn Turn on vpn for the current user
VolumesApi clone_volume post /storage/{id}/clone Clone volume/snapshot
VolumesApi create_volume post /projects/{id}/storage Create a volume
VolumesApi create_volume_attachment post /storage/{id}/attachments Attach your volume
VolumesApi create_volume_snapshot_policy post /storage/{id}/snapshot-policies Create a volume snapshot policy
VolumesApi delete_volume delete /storage/{id} Delete the volume
VolumesApi delete_volume_attachment delete /storage/attachments/{id} Detach volume
VolumesApi delete_volume_snapshot delete /storage/{volume_id}/snapshots/{id} Delete volume snapshot
VolumesApi delete_volume_snapshot_policy delete /storage/snapshot-policies/{id} Delete the volume snapshot policy
VolumesApi find_volume_attachment_by_id get /storage/attachments/{id} Retrieve an attachment
VolumesApi find_volume_attachments get /storage/{id}/attachments Retrieve all volume attachment
VolumesApi find_volume_by_id get /storage/{id} Retrieve a volume
VolumesApi find_volume_customdata get /storage/{id}/customdata Retrieve the custom metadata of a storage volume
VolumesApi find_volume_events get /volumes/{id}/events Retrieve volume's events
VolumesApi find_volume_snapshots get /storage/{id}/snapshots Retrieve all volume snapshot
VolumesApi find_volumes get /projects/{id}/storage Retrieve all volumes
VolumesApi restore_volume post /storage/{id}/restore Restore volume
VolumesApi update_volume put /storage/{id} Update the volume
VolumesApi update_volume_snapshot_policy put /storage/snapshot-policies/{id} Update the volume snapshot policy

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

support@equinixmetal.com

About

EXPERIMENTAL / GENERATED Rust client from Swagger2 spec

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published