Python Client SDK for Latitude API
Project description
The Latitude.sh API gives you programmatic access to all resources available on the platform. With full control over the entire Latitude.sh platform, you can build integrations, custom dashboards, and manage your servers from your own clients.
Please note that the following installation example with pip is illustrative and will not download a package until a publishing token is provided as a github secret. To test out the repo you may clone it locally and run pip install -e ../path/to/local/clone/
.
SDK Installation
pip install latitude-python-sdk
Authentication
To create an API token, go to the Settings & Billing → API Keys page on the dashboard.
The key is shown to your only when it's created. If you lose it, you'll have to roll the key or create a new one.
SDK Example Usage
import latitude
from latitude.models import operations, shared
s = latitude.Latitude()
req = operations.GetRegionRequest(
security=operations.GetRegionSecurity(
bearer="YOUR_API_KEY_HERE",
),
path_params=operations.GetRegionPathParams(
id="unde",
),
)
res = s.regions.get_region(req)
if res.region is not None:
# handle response
SDK Available Operations
api_keys
delete_api_key
- Delete an API Keyget_api_keys
- List all API Keyspost_api_key
- Create an API Keyupdate_api_key
- Regenerate an API Key
api_version
get_current_version
- Get current API versionupdate_current_version
- Update current API version
account
get_user_profile
- Retrieve the User Profileget_user_teams
- List all User Teamspatch_user_profile
- Update the User Profile
bandwidth
get_traffic_consumption
- Retrieve Traffic consumptionget_traffic_quota
- Retrieve Traffic Quota
bandwidth_packages
get_plans_bandwidth
- List all bandwidth packages availableupdate_plans_bandwidth
- Buy or remove bandwidth packages
deploy_config
get_server_deploy_config
- Retrieve the Server Deploy Configupdate_server_deploy_config
- Update the Server Deploy Config
ip_addresses
get_ip
- Retrieve an IPget_ips
- List IPs
ipmi_credentials
create_ipmi_session
- Generate IPMI credentials
members
destroy_team_member
- Remove a Team Memberget_team_members
- List all Team Memberspost_team_members
- Add a Team Member
operating_systems
get_plans_operating_system
- List all operating systems available
plans
get_plan
- Retrieve a Planget_plans
- List all Plans
power_actions
create_server_action
- Run Server Action
projects
create_project
- Create a Projectdelete_project
- Delete a Projectget_project
- Retrieve a Projectget_projects
- List all Projectsupdate_project
- Update a Project
regions
get_region
- Retrieve a Regionget_regions
- List all Regions
rescue_mode
server_exit_rescue_mode
- Exits rescue mode for a Serverserver_start_rescue_mode
- Puts a Server in rescue mode
roles
get_role_id
- Retrieve a Roleget_roles
- List all Roles
ssh_keys
delete_project_ssh_key
- Delete a Project SSH Keyget_project_ssh_key
- Retrieve a Project SSH Keyget_project_ssh_keys
- List all Project SSH Keyspost_project_ssh_key
- Create a Project SSH Keyput_project_ssh_key
- Update a Project SSH Key
server_reinstall
create_server_reinstall
- Run Server Reinstall
servers
create_server
- Deploy a new serverdestroy_server
- Remove a Serverget_server
- Retrieve a Serverget_servers
- List all Serversupdate_server
- Update a Server
teams
get_team
- Retrieve the Current Teampatch_current_team
- Update a Teampost_team
- Create a Team
user_data
delete_project_user_data
- Delete a Project User Dataget_project_user_data
- Retrieve a Project User Dataget_project_users_data
- List all Project User Datapost_project_user_data
- Create a Project User Dataput_project_user_data
- Update a Project User Data
vpn_sessions
delete_vpn_session
- Delete a VPN Sessionget_vpn_sessions
- List all Active VPN Sessionspost_vpn_session
- Create a VPN Sessionput_vpn_session
- Refresh a VPN Session
virtual_network_assignments
assign_server_virtual_network
- Assign a server to a virtual networkdelete_virtual_networks_assignments
- Delete a Virtual Network Assignmentget_virtual_networks_assignments
- List all servers assigned to virtual networks
virtual_networks
create_virtual_network
- Create a Virtual Networkdestroy_virtual_network
- Delete a Virtual Networkget_virtual_network
- Retrieve a Virtual Networkget_virtual_networks
- List all Virtual Networksupdate_virtual_network
- Update a Virtual Network
SDK Generated by Speakeasy
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file latitude-python-sdk-2.6.6.tar.gz
.
File metadata
- Download URL: latitude-python-sdk-2.6.6.tar.gz
- Upload date:
- Size: 42.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c8166369416c362f3084866b653e69443d06dea588c2c8965314cbbab51fd56a |
|
MD5 | 0f6e9093280a9ad77ea34664557f5195 |
|
BLAKE2b-256 | e2b2ca4618b65dec5330826e1b249df60916dafc9aeb7e7f92e5faa60ad850d1 |
File details
Details for the file latitude_python_sdk-2.6.6-py3-none-any.whl
.
File metadata
- Download URL: latitude_python_sdk-2.6.6-py3-none-any.whl
- Upload date:
- Size: 117.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a4c325d41e790b855f5598d02a61c3cd3e5853bbab50ccb87b339c76204f21fa |
|
MD5 | d5f7dcad04ffc456bdd7567e806a15fc |
|
BLAKE2b-256 | c2bcfe4513c42eb6bdcdb045ca8f55f265574d2e893af76abd30636aad69d7dd |