# Latitude.sh Docs

- [Latitude.sh documentation](https://www.latitude.sh/docs/index.md): Deploy and manage bare metal servers, virtual machines, storage, and networking on Latitude.sh
- [Setting up your account](https://www.latitude.sh/docs/account-setup/sign-up.md)
- [Verifying your account](https://www.latitude.sh/docs/account-setup/verify-account.md)
- [Dashboard](https://www.latitude.sh/docs/dashboard/overview.md): A tour of the Latitude.sh dashboard: the topbar, the sidebar, and how to move between teams and projects.
- [Command menu](https://www.latitude.sh/docs/dashboard/command-menu.md)
- [Regions & Locations](https://www.latitude.sh/docs/regions-locations.md)
- [Referral program](https://www.latitude.sh/docs/referral-program.md)
- [Deploying a server](https://www.latitude.sh/docs/servers/deploying-a-server.md)
- [Instant deployment](https://www.latitude.sh/docs/servers/instant-deployment.md)
- [Logging into your server](https://www.latitude.sh/docs/servers/logging-into-your-server.md)
- [Network bonding](https://www.latitude.sh/docs/servers/network-bonding.md): Join a server's two NICs into one redundant link and place it on a routed network you own — a public network
- [Operating systems](https://www.latitude.sh/docs/servers/operating-systems.md)
- [SSH keys](https://www.latitude.sh/docs/servers/ssh-keys.md)
- [Custom disk layout](https://www.latitude.sh/docs/servers/custom-disk-layout.md): Control how your server's disks are grouped, formatted, and mounted using RAID levels and custom disk layouts.
- [Custom images](https://www.latitude.sh/docs/servers/custom-images.md)
- [User data](https://www.latitude.sh/docs/servers/user-data.md)
- [Instance metadata service](https://www.latitude.sh/docs/servers/metadata-service.md): Access server metadata from within your bare metal servers using the instance metadata service
- [Out-of-band](https://www.latitude.sh/docs/servers/out-of-band.md)
- [Remote access](https://www.latitude.sh/docs/servers/remote-access.md)
- [Rescue mode](https://www.latitude.sh/docs/servers/rescue-mode.md)
- [Reinstalling a server](https://www.latitude.sh/docs/servers/reinstalling-a-server.md)
- [Moving a server to a different project](https://www.latitude.sh/docs/servers/change-project.md)
- [Power management](https://www.latitude.sh/docs/servers/power-management.md)
- [Deleting a server](https://www.latitude.sh/docs/servers/deleting-a-server.md): Learn how to delete a server immediately or schedule it for deletion.
- [Disk sanitization](https://www.latitude.sh/docs/servers/disk-sanitization.md): How Latitude.sh erases and verifies the disks of a server after you delete it.
- [Waitlist](https://www.latitude.sh/docs/dashboard/server-waitlist.md)
- [Virtual machines](https://www.latitude.sh/docs/vms/virtual-machines.md)
- [Backups and restore](https://www.latitude.sh/docs/vms/backups-and-restore.md): Capture point-in-time backups of a virtual machine's disk and restore them into new virtual machines.
- [Monitoring](https://www.latitude.sh/docs/vms/monitoring.md): Track your virtual machine's performance with real-time metrics for CPU, memory, network, and disk.
- [LKS](https://www.latitude.sh/docs/lks.md): Managed Kubernetes on Latitude.sh bare metal
- [Getting started](https://www.latitude.sh/docs/lks/getting-started.md): Create an LKS Cluster, connect with kubectl, and deploy your first Workload
- [Clusters](https://www.latitude.sh/docs/lks/clusters.md): Create, access, upgrade, and delete LKS Clusters from the dashboard
- [Node Pools](https://www.latitude.sh/docs/lks/node-pools.md): Create, scale, label, taint, upgrade, and delete LKS Node Pools on new or existing Servers
- [Exposing Workloads](https://www.latitude.sh/docs/lks/exposing-workloads.md): How LKS exposes Services to the Internet with L4 load balancing over BGP
- [LoadBalancer Services](https://www.latitude.sh/docs/lks/load-balancer-services.md): Required fields and supported annotations for LKS LoadBalancer Services
- [Shared responsibility](https://www.latitude.sh/docs/lks/shared-responsibility.md): How responsibilities split between Latitude.sh and you across the LKS Cluster lifecycle
- [Object storage](https://www.latitude.sh/docs/storage/object-storage.md): S3-compatible object storage for scalable data management
- [Block storage](https://www.latitude.sh/docs/storage/block-storage.md): High performance block volumes you map to a bare metal server and use over NVMe/TCP
- [File storage](https://www.latitude.sh/docs/storage/filesystem.md): Shared NFS filesystems you mount on bare metal servers over the private storage network
- [Egress](https://www.latitude.sh/docs/storage/egress.md): Traffic to and from your Latitude.sh storage is free
- [Managed Databases](https://www.latitude.sh/docs/managed-databases.md)
- [Database Parameters](https://www.latitude.sh/docs/managed-databases/parameters.md): Configure PostgreSQL and PgBouncer parameters for your database.
- [Database Monitoring](https://www.latitude.sh/docs/managed-databases/monitoring.md)
- [Database Backups and Restoration](https://www.latitude.sh/docs/managed-databases/backups-and-restoration.md)
- [Trusted Sources](https://www.latitude.sh/docs/managed-databases/trusted-sources.md)
- [Supabase Addon](https://www.latitude.sh/docs/managed-databases/supabase-addon.md)
- [Private networks](https://www.latitude.sh/docs/networking/private-networks.md): Private networking allows you to group servers within the same location, enabling private communication between them
- [Public networks](https://www.latitude.sh/docs/networking/public-networks.md): A routed IP block scoped to a project, shared by the servers bonded onto it
- [IP addresses](https://www.latitude.sh/docs/networking/ips.md)
- [Elastic IPs](https://www.latitude.sh/docs/networking/elastic-ips.md): Create and manage portable IP addresses that can be moved between servers in your project
- [Elastic IPs via BGP](https://www.latitude.sh/docs/networking/elastic-ips-bgp.md): Announce a portable IP address from one or more of your own servers over BGP for high availability
- [BYOIP](https://www.latitude.sh/docs/networking/byoip.md): Bring your own IPv4 address prefixes to Latitude.sh infrastructure
- [DDoS protection](https://www.latitude.sh/docs/networking/ddos-protection.md)
- [Firewall](https://www.latitude.sh/docs/networking/firewall.md)
- [Cloud Gateway](https://www.latitude.sh/docs/networking/cloud-gateway.md)
- [Global Gateway](https://www.latitude.sh/docs/interconnection/global-gateway.md): Private connections between Latitude.sh locations
- [Projects](https://www.latitude.sh/docs/projects.md)
- [Tags](https://www.latitude.sh/docs/tags.md)
- [Filters and views](https://www.latitude.sh/docs/dashboard/filters-and-views.md)
- [Activity logs](https://www.latitude.sh/docs/events.md)
- [Creating a team](https://www.latitude.sh/docs/teams/create-team.md)
- [Team members](https://www.latitude.sh/docs/teams/members.md)
- [Directory sync (SCIM)](https://www.latitude.sh/docs/teams/directory-sync.md): Keep your team's members and roles in sync with your identity provider.
- [Password authentication](https://www.latitude.sh/docs/account-security/password.md)
- [Multi-factor Authentication (MFA)](https://www.latitude.sh/docs/account-security/mfa.md)
- [SAML Single Sign-On (SSO)](https://www.latitude.sh/docs/teams/sso.md): Let your team members sign in to Latitude.sh through your identity provider.
- [Passkey Authentication](https://www.latitude.sh/docs/account-security/passkeys.md): Sign in without passwords using biometrics or security keys.
- [Bandwidth usage](https://www.latitude.sh/docs/usage/bandwidth.md)
- [Billing](https://www.latitude.sh/docs/billing/overview.md)
- [Payment methods](https://www.latitude.sh/docs/billing/payment-methods.md)
- [On demand vs. Reserved](https://www.latitude.sh/docs/billing/on-demand-vs-reserved.md)
- [Changing the billing method](https://www.latitude.sh/docs/billing/change-billing-method.md): Upgrade a server or virtual machine to monthly or yearly billing.
- [Invoices](https://www.latitude.sh/docs/billing/invoices.md)
- [Resource Limits](https://www.latitude.sh/docs/billing/resource-limits.md)
- [Contact support](https://www.latitude.sh/docs/support/contact-support.md): Get help from the Latitude.sh AI agent or open a support ticket.
- [Support access](https://www.latitude.sh/docs/support/support-access.md): Grant Latitude.sh staff temporary access to your team to help troubleshoot.
- [Service Schedules](https://www.latitude.sh/docs/sla.md)
- [Guides](https://www.latitude.sh/docs/guides.md): Tutorials to help you deploy and manage workloads on Latitude.sh
- [Deploy custom OS via IPMI virtual media](https://www.latitude.sh/docs/guides/ipmi-custom-os-deployment.md): Step-by-step guide for installing custom operating systems using IPMI virtual media mounting
- [Introduction to Kubernetes](https://www.latitude.sh/docs/guides/introduction-to-kubernetes.md): Understanding Kubernetes on bare metal infrastructure and why it's essential for modern application deployment
- [Kubernetes on bare metal with Rancher](https://www.latitude.sh/docs/guides/kubernetes-on-bare-metal.md): A guide to get you started with Kubernetes on bare metal with Rancher RKE2
- [Kubernetes cluster with RKE2](https://www.latitude.sh/docs/guides/kubernetes-cluster-rke2.md): Step-by-step setup for building a reliable Kubernetes environment on bare metal
- [CLASTIX](https://www.latitude.sh/docs/guides/managed-k8s-clastix.md): Setting up managed bare metal nodes in a Kubernetes cluster
- [Load balancing with MetalLB and Cloudflare](https://www.latitude.sh/docs/guides/kubernetes-load-balancing-on-bare-metal.md): Set up a load balancer to distribute incoming traffic to the apps running on your Kubernetes cluster
- [Setting up persistent storage for Kubernetes with Longhorn](https://www.latitude.sh/docs/guides/kubernetes-persistent-storage-longhorn.md): Configure storage to retain application data on your K8s cluster
- [Monitoring a Kubernetes cluster on bare metal with Prometheus and Grafana](https://www.latitude.sh/docs/guides/k8s-monitoring.md): Get real-time visibility into your cluster's health and performance
- [Set up a private cloud on bare metal with Harvester](https://www.latitude.sh/docs/guides/private-cloud-harvester.md): Learn how to build a scalable private cloud on Latitude.sh from setup to deployment
- [Using Terraform with Latitude.sh](https://www.latitude.sh/docs/guides/terraform.md): Use infrastructure as code with Terraform on Latitude.sh for consistent, repeatable deployments
- [Import your infrastructure into Terraform](https://www.latitude.sh/docs/guides/terraform-import.md): Import existing resources into Terraform to manage them with infrastructure as code
- [Terraform Cloud best practices](https://www.latitude.sh/docs/guides/terraform-cloud.md): Collaborate on infrastructure as code with team workflows and security guardrails
- [Nomad and Consul](https://www.latitude.sh/docs/guides/nomad-consul-terraform.md): Deploy a Nomad cluster with Consul service mesh using Terraform on bare metal
- [Rancher RKE2](https://www.latitude.sh/docs/guides/terraform-rancher.md): Deploy Kubernetes clusters using Rancher and Terraform on bare metal servers
- [CLASTIX](https://www.latitude.sh/docs/guides/terraform-clastix.md): Deploy Kubernetes worker nodes to CLASTIX managed clusters using Terraform
- [Summary](https://www.latitude.sh/docs/api-reference/summary.md): Overview of the Latitude.sh API
- [Authentication](https://www.latitude.sh/docs/api-reference/authentication.md): Learn how to authenticate your API requests
- [Rate Limits](https://www.latitude.sh/docs/api-reference/rate-limits.md): API rate limits and how they work
- [Versioning](https://www.latitude.sh/docs/api-reference/versioning.md): API versioning strategy and best practices
- [Instance Metadata Service](https://www.latitude.sh/docs/api-reference/metadata-service.md): Complete reference for the instance metadata service available from within Latitude.sh bare metal servers
- [Object Model](https://www.latitude.sh/docs/api-reference/object-model.md): Understanding the JSON:API object model
- [Encoding](https://www.latitude.sh/docs/api-reference/encoding.md): Character encoding and content types
- [Identifiers and URLs](https://www.latitude.sh/docs/api-reference/identifiers-and-urls.md): Resource identifiers and URL conventions
- [Use of HTTP](https://www.latitude.sh/docs/api-reference/use-of-http.md): HTTP methods, status codes, and headers
- [Pagination](https://www.latitude.sh/docs/api-reference/pagination.md): Paginating through list endpoints
- [Statistics](https://www.latitude.sh/docs/api-reference/statistics.md): Understanding statistics in API responses
- [Sorting](https://www.latitude.sh/docs/api-reference/sorting.md): Sorting results in list endpoints
- [Filtering](https://www.latitude.sh/docs/api-reference/filtering.md): Filtering resources with query parameters
- [Sparse Fieldsets](https://www.latitude.sh/docs/api-reference/sparse-fieldsets.md): Requesting specific fields to reduce payload size
- [Error Objects](https://www.latitude.sh/docs/api-reference/error-objects.md): Structure of error responses
- [Error Codes](https://www.latitude.sh/docs/api-reference/error-codes.md): Common error codes and their meanings
- [HTTP Responses](https://www.latitude.sh/docs/api-reference/http-responses.md): HTTP status codes used by the API
- [List API keys](https://www.latitude.sh/docs/api-reference/get-api-keys.md): Returns a list of all API keys.
- [Create API key](https://www.latitude.sh/docs/api-reference/post-api-key.md): Create a new API Key that is tied to the current user account. The created API key is only listed ONCE upon creation. It can however be regenerated or deleted.
- [Rotate API key](https://www.latitude.sh/docs/api-reference/rotate-api-key.md): Rotate an existing API Key, generating a new token. This invalidates the previous key. Use PATCH to update settings without rotating the token.
- [Delete API key](https://www.latitude.sh/docs/api-reference/delete-api-key.md): Delete an existing API Key. Once deleted, the API Key can no longer be used to access the API.
- [Update API key settings](https://www.latitude.sh/docs/api-reference/update-api-key.md): Update API Key settings (name, read_only, allowed_ips) without rotating the token. Use PUT to rotate the token.
- [List baselines](https://www.latitude.sh/docs/api-reference/get-baselines.md): **Preview.** Available to teams with the `baselines_api` feature flag. The shape of this endpoint may change before general availability.
- [Create baseline](https://www.latitude.sh/docs/api-reference/create-baseline.md): **Preview.** Available to teams with the `baselines_api` feature flag.
- [Retrieve baseline](https://www.latitude.sh/docs/api-reference/get-baseline.md): **Preview.** Available to teams with the `baselines_api` feature flag.
- [Delete baseline](https://www.latitude.sh/docs/api-reference/destroy-baseline.md): **Preview.** Available to teams with the `baselines_api` feature flag.
- [Retrieve billing usage](https://www.latitude.sh/docs/api-reference/get-billing-usage.md): Returns the billing usage of a project
- [List events](https://www.latitude.sh/docs/api-reference/get-events.md): Lists actions performed by users on your account.
- [List firewall assignments](https://www.latitude.sh/docs/api-reference/get-all-firewall-assignments.md): Returns a list of all servers and virtual machines assigned to a firewall.
- [List firewalls](https://www.latitude.sh/docs/api-reference/list-firewalls.md): List firewalls
- [Create firewall](https://www.latitude.sh/docs/api-reference/create-firewall.md): Create a firewall
- [Retrieve firewall](https://www.latitude.sh/docs/api-reference/get-firewall.md): Returns a single firewall by its ID.
- [Delete firewall](https://www.latitude.sh/docs/api-reference/delete-firewall.md)
- [Update firewall](https://www.latitude.sh/docs/api-reference/update-firewall.md): Updates a firewall by its ID.
- [Firewall assignments](https://www.latitude.sh/docs/api-reference/get-firewall-assignments.md): Returns a list of all servers and virtual machines assigned to a particular firewall.
- [Assign server to firewall](https://www.latitude.sh/docs/api-reference/create-firewall-assignment.md): Assigns a server or a virtual machine to a firewall by its ID.
- [Delete assignment](https://www.latitude.sh/docs/api-reference/delete-firewall-assignment.md): Removes a server or a virtual machine from a firewall by its assignment ID.
- [List Elastic IPs](https://www.latitude.sh/docs/api-reference/list-elastic-ips.md): List all Elastic IPs for the authenticated team. Elastic IPs are static public IP addresses that can be assigned to servers and moved between servers within the same project.
- [Create an Elastic IP](https://www.latitude.sh/docs/api-reference/create-elastic-ip.md): Creates a new Elastic IP and assigns it to the specified server. The IP is provisioned asynchronously—the response will show status `configuring` and the `id` will be `null` until provisioning completes. Currently only IPv4 /32 addresses in routed mode are supported.
- [Retrieve an Elastic IP](https://www.latitude.sh/docs/api-reference/get-elastic-ip.md): Returns a single Elastic IP by its ID.
- [Release an Elastic IP](https://www.latitude.sh/docs/api-reference/delete-elastic-ip.md): Releases an Elastic IP, returning it to the available pool. The IP will transition to `releasing` status before being fully removed. Only Elastic IPs with status `active` or `error` can be released.
- [Move an Elastic IP](https://www.latitude.sh/docs/api-reference/update-elastic-ip.md): Moves an Elastic IP to a different server within the same project and site. The reassignment is performed asynchronously. The Elastic IP must be in `active` status, the target server must belong to the same project, and the target server must be in the same site as the currently assigned server.
- [List BGP sessions](https://www.latitude.sh/docs/api-reference/list-elastic-ip-bgp-sessions.md): List the BGP sessions announcing an elastic IP
- [Create a BGP session](https://www.latitude.sh/docs/api-reference/create-elastic-ip-bgp-session.md): Announce an elastic IP from a server over BGP
- [Retrieve a BGP session](https://www.latitude.sh/docs/api-reference/get-elastic-ip-bgp-session.md): Retrieve a BGP session announcing an elastic IP
- [Delete a BGP session](https://www.latitude.sh/docs/api-reference/delete-elastic-ip-bgp-session.md): Stop announcing an elastic IP from a server
- [List IPs](https://www.latitude.sh/docs/api-reference/get-ips.md): List all Management and Additional IP Addresses.  • Management IPs are IPs that are used for the management IP of a device.    This is a public IP address that a device is born and dies with. It never changes during the lifecycle of the device.  • Additional IPs are individual IPs that can be added…
- [Retrieve an IP](https://www.latitude.sh/docs/api-reference/get-ip.md): Retrieve an IP Address
- [List members](https://www.latitude.sh/docs/api-reference/get-team-members.md)
- [Create member](https://www.latitude.sh/docs/api-reference/post-team-members.md)
- [Remove a member](https://www.latitude.sh/docs/api-reference/destroy-team-member.md)
- [List operating systems](https://www.latitude.sh/docs/api-reference/get-plans-operating-system.md): Lists all operating systems available to deploy and reinstall.
- [List Kubernetes Clusters](https://www.latitude.sh/docs/api-reference/kubernetes-clusters/list-kubernetes-clusters.md): Lists all Kubernetes clusters for a project.
- [Create a Kubernetes Cluster](https://www.latitude.sh/docs/api-reference/kubernetes-clusters/create-a-kubernetes-cluster.md): Creates a new managed Kubernetes cluster. Maximum of 1 cluster per project.
- [List Available Kubernetes Versions](https://www.latitude.sh/docs/api-reference/kubernetes-clusters/list-available-kubernetes-versions.md): Returns the list of available Kubernetes versions for cluster creation and upgrades. Versions are sourced from the RKE2 release channels and cached for 24 hours.
- [Get a Kubernetes Cluster](https://www.latitude.sh/docs/api-reference/kubernetes-clusters/get-a-kubernetes-cluster.md): Retrieves detailed information about a Kubernetes cluster including its status, control plane, worker node details, and individual node information.
- [Delete a Kubernetes Cluster](https://www.latitude.sh/docs/api-reference/kubernetes-clusters/delete-a-kubernetes-cluster.md): Deletes a Kubernetes cluster. This action is irreversible and will destroy all cluster resources.
- [Update Kubernetes Cluster](https://www.latitude.sh/docs/api-reference/kubernetes-clusters/update-kubernetes-cluster.md): Updates a Kubernetes cluster by scaling nodes or upgrading the Kubernetes version. The cluster must be in `Provisioned` phase to accept updates.
- [Get Kubernetes Cluster Kubeconfig](https://www.latitude.sh/docs/api-reference/kubernetes-clusters/get-kubernetes-cluster-kubeconfig.md): Retrieves the kubeconfig file for a Kubernetes cluster. The kubeconfig is only available once the cluster is fully provisioned.
- [List LKS clusters](https://www.latitude.sh/docs/api-reference/lks/list-lks-clusters.md): Lists every LKS cluster of a project. The response is not paginated; `meta.total` is the number of clusters returned.
- [Create an LKS cluster](https://www.latitude.sh/docs/api-reference/lks/create-an-lks-cluster.md): Creates an LKS cluster. The cluster is the control plane only — worker capacity is added separately through node pools (`POST /lks/clusters/{cluster_id}/nodepools`).
- [Get an LKS cluster](https://www.latitude.sh/docs/api-reference/lks/get-an-lks-cluster.md): Retrieves a single LKS cluster.
- [Delete an LKS cluster](https://www.latitude.sh/docs/api-reference/lks/delete-an-lks-cluster.md): Marks the cluster for deletion. The call returns as soon as the tombstone is written; the platform then tears the cluster and its node pools down asynchronously. A cluster that is already deleted, or that is paused, rejects the request.
- [Update an LKS cluster](https://www.latitude.sh/docs/api-reference/lks/update-an-lks-cluster.md): Renames a cluster, edits its description, or upgrades the control plane. At least one of `name`, `description` or `kubernetes_version` must be provided.
- [Get the cluster kubeconfig](https://www.latitude.sh/docs/api-reference/lks/get-the-cluster-kubeconfig.md): Returns the kubeconfig for the cluster. It only exists once the control plane is up, so this endpoint answers 409 `NOT_READY` while the cluster is still provisioning — poll `GET /lks/clusters/{id}` until `kubeconfig_url` is set.
- [List node pools](https://www.latitude.sh/docs/api-reference/lks/list-node-pools.md): Lists every node pool of an LKS cluster. The response is not paginated; `meta.total` is the number of node pools returned.
- [Create a node pool](https://www.latitude.sh/docs/api-reference/lks/create-a-node-pool.md): Adds a node pool to an LKS cluster. `mode` decides where the pool's nodes come from:
- [Get a node pool](https://www.latitude.sh/docs/api-reference/lks/get-a-node-pool.md): Retrieves a single node pool of an LKS cluster. `ready_nodes` reports how many of the pool's `count` nodes have joined the cluster.
- [Delete a node pool](https://www.latitude.sh/docs/api-reference/lks/delete-a-node-pool.md): Marks the node pool for deletion. The call returns as soon as the tombstone is written; the platform then drains and releases the nodes asynchronously.
- [Update a node pool](https://www.latitude.sh/docs/api-reference/lks/update-a-node-pool.md): Scales, renames, upgrades, re-labels or changes the servers of a node pool. At least one attribute must be provided.
- [List nodes](https://www.latitude.sh/docs/api-reference/lks/list-nodes.md): Lists the nodes of a node pool, with the status of each node and of the server it runs on. Each node's `id` is a stable node ID (format: `lksno_<hash>`); `name` is its Kubernetes node name, as shown by `kubectl get nodes`. The response is not paginated; `meta.total` is the number of nodes returned.
- [List available Kubernetes versions](https://www.latitude.sh/docs/api-reference/lks/list-available-kubernetes-versions.md): Lists the Kubernetes patches the platform offers, with their lifecycle flags. Use a version with `available_for_creation: true` when creating a cluster or a node pool, and one with `available_for_upgrade: true` when upgrading. Exactly one entry has `default: true`.
- [List sites available for LKS](https://www.latitude.sh/docs/api-reference/lks/list-sites-available-for-lks.md): Lists the sites that can host an LKS cluster, one entry per site. Pass an entry's `id` (the site slug) as `site` when creating a cluster. `country` is null when the underlying site has no region assigned.
- [List servers that can join an allocated node pool](https://www.latitude.sh/docs/api-reference/lks/list-servers-that-can-join-an-allocated-node-pool.md): Lists a project's servers at a site, with whether each one can join an allocated node pool right now. Pass the `id` of an allocatable server in `server_ids` when creating or updating an allocated node pool.
- [List plans](https://www.latitude.sh/docs/api-reference/get-plans.md): Lists all plans. Availability by region is included in `attributes.regions.locations.available[*]` node for a given plan.
- [Retrieve plan](https://www.latitude.sh/docs/api-reference/get-plan.md)
- [List bandwidth plans](https://www.latitude.sh/docs/api-reference/get-bandwidth-plans.md): Lists all bandwidth plans.
- [Update bandwidth packages](https://www.latitude.sh/docs/api-reference/update-plans-bandwidth.md): Allows to increase or decrease bandwidth packages. Only admins and owners can request.
- [List storage plans](https://www.latitude.sh/docs/api-reference/get-storage-plans.md)
- [List LKS plans](https://www.latitude.sh/docs/api-reference/get-lks-plans.md): Lists bare metal plans available to LKS with per-site capacity for a node pool. `attributes.regions.locations.in_stock_count` gives the number of servers a node pool can get, keyed by site slug.
- [List VM plans](https://www.latitude.sh/docs/api-reference/get-vm-plans.md)
- [List managed database plans](https://www.latitude.sh/docs/api-reference/get-managed-database-plans.md)
- [List networks](https://www.latitude.sh/docs/api-reference/get-public-networks.md): **Preview.** Available at locations where the `public_network` feature is enabled.
- [Create a network](https://www.latitude.sh/docs/api-reference/create-public-network.md): **Preview.** Available at locations where the `public_network` feature is enabled.
- [Retrieve a network](https://www.latitude.sh/docs/api-reference/get-public-network.md): Retrieve a customer network
- [Delete a network](https://www.latitude.sh/docs/api-reference/destroy-public-network.md): **Preview.** Available at locations where the `public_network` feature is enabled.
- [Update a network IP](https://www.latitude.sh/docs/api-reference/update-public-network-ip.md): **Preview.** Available at locations where the `public_network` feature is enabled.
- [List projects](https://www.latitude.sh/docs/api-reference/get-projects.md): Returns a list of all projects for the current team
- [Create project](https://www.latitude.sh/docs/api-reference/create-project.md)
- [Retrieve project](https://www.latitude.sh/docs/api-reference/get-project.md): Returns a single project belonging to the current team
- [Delete project](https://www.latitude.sh/docs/api-reference/delete-project.md): Deletes a project and releases associated resources. Any Elastic IPs assigned to the project are automatically released and returned to the available pool.
- [Update project](https://www.latitude.sh/docs/api-reference/update-project.md)
- [List SSH Keys](https://www.latitude.sh/docs/api-reference/get-project-ssh-keys.md): List all SSH Keys in the project. These keys can be used to access servers after deploy and reinstall actions.
- [Create SSH Key](https://www.latitude.sh/docs/api-reference/post-project-ssh-key.md): Allow you create SSH Keys in a project. These keys can be used to access servers after deploy and reinstall actions.
- [Retrieve Project SSH Key](https://www.latitude.sh/docs/api-reference/get-project-ssh-key.md): List all SSH Keys in the project. These keys can be used to access servers after deploy and reinstall actions.
- [Delete Project SSH Key](https://www.latitude.sh/docs/api-reference/delete-project-ssh-key.md): Allow you remove SSH Keys in a project. Remove a SSH Key from the project won't revoke the SSH Keys access for previously deploy and reinstall actions.
- [Update Project SSH Key](https://www.latitude.sh/docs/api-reference/put-project-ssh-key.md): Allow you update SSH Key in a project. These keys can be used to access servers after deploy and reinstall actions.
- [List SSH Keys](https://www.latitude.sh/docs/api-reference/get-ssh-keys.md): List all SSH Keys in the project. These keys can be used to access servers after deploy and reinstall actions.
- [Create SSH Key](https://www.latitude.sh/docs/api-reference/post-ssh-key.md): Allows you create SSH Keys. These keys can be used to access servers after deploy and reinstall actions.
- [Retrieve SSH Key](https://www.latitude.sh/docs/api-reference/get-ssh-key.md): List all SSH Keys in the project. These keys can be used to access servers after deploy and reinstall actions.
- [Delete SSH Key](https://www.latitude.sh/docs/api-reference/delete-ssh-key.md): Allows you remove SSH Keys in a project. Remove a SSH Key from the project won't revoke the SSH Keys access for previously deploy and reinstall actions.
- [Update SSH Key](https://www.latitude.sh/docs/api-reference/put-ssh-key.md): Allows you update SSH Key in a project. These keys can be used to access servers after deploy and reinstall actions.
- [List storage usage](https://www.latitude.sh/docs/api-reference/get-storage-usage.md): Returns daily object storage usage for a project. Each row reports the canonical usage in bytes for a single storage on a given day, plus the provider-reported raw value.
- [List access keys](https://www.latitude.sh/docs/api-reference/get-storage-access-keys.md): Lists object storage access keys for a project, grouped by storage class. Secrets are never returned by this endpoint.
- [Create access key](https://www.latitude.sh/docs/api-reference/post-storage-access-keys.md): Creates an object storage IAM access key for a project. The secret is returned only once, in this response, and cannot be retrieved again. The provider is selected by `storage_class`: `standard` provisions the key on Wasabi and `high_performance` provisions it on VAST.
- [Delete access key](https://www.latitude.sh/docs/api-reference/delete-storage-access-keys-username.md): Permanently deletes an object storage access key and its associated provider-side credentials. Deletion cannot be undone: it revokes the key's credentials and removes the key from the storage provider. For `standard` (Wasabi) keys, the IAM user is removed from each of the project's bucket policies,…
- [List bucket access keys](https://www.latitude.sh/docs/api-reference/get-storage-bucket-access-keys.md): Lists IAM access keys associated with an object storage bucket. Secrets are never returned by this endpoint.
- [List buckets](https://www.latitude.sh/docs/api-reference/get-storage-buckets.md): Lists all object storages from a team.
- [Create bucket](https://www.latitude.sh/docs/api-reference/post-storage-buckets.md): Creates a new object storage bucket for a project.
- [Retrieve bucket](https://www.latitude.sh/docs/api-reference/get-storage-bucket.md): Shows details of a specific object storage.
- [Delete bucket](https://www.latitude.sh/docs/api-reference/delete-storage-buckets.md): Allows you to remove an object storage from a project.
- [List lifecycle rules](https://www.latitude.sh/docs/api-reference/get-storage-bucket-lifecycle-rules.md): Lists all lifecycle rules for a specific object storage bucket.
- [Create lifecycle rule](https://www.latitude.sh/docs/api-reference/post-storage-bucket-lifecycle-rules.md): Creates a new lifecycle rule for an object storage bucket. Lifecycle rules automate object expiration based on age.
- [Retrieve lifecycle rule](https://www.latitude.sh/docs/api-reference/get-storage-bucket-lifecycle-rule.md): Retrieves details of a specific lifecycle rule.
- [Delete lifecycle rule](https://www.latitude.sh/docs/api-reference/delete-storage-bucket-lifecycle-rule.md): Deletes a lifecycle rule from an object storage bucket.
- [Update lifecycle rule](https://www.latitude.sh/docs/api-reference/patch-storage-bucket-lifecycle-rule.md): Updates an existing lifecycle rule for an object storage bucket.
- [Retrieve bucket metrics](https://www.latitude.sh/docs/api-reference/get-storage-bucket-metrics.md): Retrieves usage metrics for a specific object storage bucket, including storage consumption and estimated cost for the current billing period.
- [List Project user data](https://www.latitude.sh/docs/api-reference/get-project-users-data.md): List all Users Data in the project. These scripts can be used to configure servers with user data.
- [Create Project user data](https://www.latitude.sh/docs/api-reference/post-project-user-data.md): Allows you to create User Data in a project, which can be used to perform custom setup on your servers after deploy and reinstall.
- [Retrieve Project user data](https://www.latitude.sh/docs/api-reference/get-project-user-data.md): Get User Data in the project. These scripts can be used to configure servers with user data.
- [Delete Project user data](https://www.latitude.sh/docs/api-reference/delete-project-user-data.md): Allow you remove User Data in a project.
- [Update Project user data](https://www.latitude.sh/docs/api-reference/put-project-user-data.md): Allow you update User Data in a project.
- [List user data](https://www.latitude.sh/docs/api-reference/get-users-data.md): List all Users Data in the project. These scripts can be used to configure servers with user data.
- [Create user data](https://www.latitude.sh/docs/api-reference/post-user-data.md): Allows you to create User Data in a team, which can be used to perform custom setup on your servers after deploy and reinstall.
- [Retrieve user data](https://www.latitude.sh/docs/api-reference/get-user-data.md): Get User Data in the project. These scripts can be used to configure servers with user data.
- [Delete user data](https://www.latitude.sh/docs/api-reference/delete-user-data.md)
- [Update user data](https://www.latitude.sh/docs/api-reference/patch-user-data.md): Allow you update User Data in a team.
- [List regions](https://www.latitude.sh/docs/api-reference/get-regions.md): Lists all [available locations](https://latitude.sh/locations). For server availability by location, please see the [Plans API](/reference/get-plans).
- [Retrieve region](https://www.latitude.sh/docs/api-reference/get-region.md)
- [List roles](https://www.latitude.sh/docs/api-reference/get-roles.md): Returns a list of all roles that can be assigned to users
- [Retrieve role](https://www.latitude.sh/docs/api-reference/get-role-id.md)
- [List servers](https://www.latitude.sh/docs/api-reference/get-servers.md): Returns a list of all servers belonging to the team.
- [Create server](https://www.latitude.sh/docs/api-reference/create-server.md)
- [Retrieve server](https://www.latitude.sh/docs/api-reference/get-server.md): Returns a server that belongs to the team.
- [Remove server](https://www.latitude.sh/docs/api-reference/destroy-server.md)
- [Update server](https://www.latitude.sh/docs/api-reference/update-server.md)
- [Retrieve deploy config](https://www.latitude.sh/docs/api-reference/get-server-deploy-config.md)
- [Update deploy config](https://www.latitude.sh/docs/api-reference/update-server-deploy-config.md)
- [Lock server](https://www.latitude.sh/docs/api-reference/server-lock.md): Locks the server. A locked server cannot be deleted or modified and no actions can be performed on it.
- [Unlock server](https://www.latitude.sh/docs/api-reference/server-unlock.md): Unlocks the server. A locked server cannot be deleted or modified and no actions can be performed on it.
- [List out-of-band connections](https://www.latitude.sh/docs/api-reference/get-server-out-of-band.md)
- [Create out-of-band connection](https://www.latitude.sh/docs/api-reference/create-server-out-of-band.md)
- [Run power action](https://www.latitude.sh/docs/api-reference/create-server-action.md): Performs an action on a given server: - `power_on` - `power_off` - `reboot`
- [Create IPMI credentials](https://www.latitude.sh/docs/api-reference/create-ipmi-session.md): Generates IPMI credentials for a given server. Remote access creates a VPN connection to the internal network of your server so you can connect to its IPMI. You will have to use a VPN client such as https://openvpn.net to connect. See `VPN Sessions` API to create a VPN connection.
- [Put server in rescue mode](https://www.latitude.sh/docs/api-reference/server-start-rescue-mode.md): Starts rescue mode on a given server.
- [Exits rescue mode](https://www.latitude.sh/docs/api-reference/server-exit-rescue-mode.md): Exits rescue mode on a given server.
- [Schedule server deletion](https://www.latitude.sh/docs/api-reference/server-schedule-deletion.md): Schedules the server to be removed at the end of the billing cycle.
- [Unschedule server deletion](https://www.latitude.sh/docs/api-reference/server-unschedule-deletion.md): Unschedules the server removal at the end of the billing cycle.
- [Run Server Reinstall](https://www.latitude.sh/docs/api-reference/create-server-reinstall.md)
- [List filesystems](https://www.latitude.sh/docs/api-reference/list-filesystems.md): Lists all the filesystems from a team.
- [Create filesystem](https://www.latitude.sh/docs/api-reference/create-filesystem.md): Allows you to add persistent storage to a project. These filesystems can be used to store data across your servers.
- [Delete filesystem](https://www.latitude.sh/docs/api-reference/delete-filesystem.md): Allows you to remove a filesystem from a project.
- [Update filesystem](https://www.latitude.sh/docs/api-reference/update-filesystem.md): Allow you to upgrade the size of a filesystem.
- [Get filesystem attachment](https://www.latitude.sh/docs/api-reference/get-filesystem-attachment.md): Returns whether a server is attached to the storage network the filesystem is served on. Poll it after attaching: once the status is "attached", configure the returned storage network on the server and mount the filesystem.
- [Attach filesystem to server](https://www.latitude.sh/docs/api-reference/attach-filesystem.md): Attaches a running server to the private storage network the filesystem is served on, so it can mount the filesystem. The attach runs asynchronously and is idempotent.
- [Detach filesystem from server](https://www.latitude.sh/docs/api-reference/detach-filesystem.md): Detaches a server from the storage network the filesystem is served on, removing its storage IP and VLAN. The network stays while a volume is still mapped to the server, since volumes use the same network. The detach runs asynchronously: poll GET .../attach for its status.
- [List volumes](https://www.latitude.sh/docs/api-reference/list-volumes.md): Lists all the volumes from a team.
- [Create volume](https://www.latitude.sh/docs/api-reference/create-volume.md): Allows you to add persistent storage to a project. These volumes can be used to store data across your servers.
- [Retrieve volume](https://www.latitude.sh/docs/api-reference/retrieve-volume.md): Shows details of a specific volume.
- [Delete volume](https://www.latitude.sh/docs/api-reference/delete-volume.md): Allows you to remove a volume from a project.
- [Update volume](https://www.latitude.sh/docs/api-reference/update-volume.md): Increases the size of a high performance volume. Shrinking is not supported. Billing is prorated to the new size.
- [Mount volume (deprecated)](https://www.latitude.sh/docs/api-reference/mount-volume.md): Mounts a volume by adding the client to an allowed list
- [Map volume](https://www.latitude.sh/docs/api-reference/map-volume.md): Maps a high performance volume to a server over NVMe-TCP.
- [Unmap volume](https://www.latitude.sh/docs/api-reference/unmap-volume.md): Unmaps a high performance volume from the server it is currently mapped to.
- [List tags](https://www.latitude.sh/docs/api-reference/get-tags.md): List all Tags in the team.
- [Create tag](https://www.latitude.sh/docs/api-reference/create-tag.md): Create a Tag in the team.
- [Delete tag](https://www.latitude.sh/docs/api-reference/destroy-tag.md): Update a Tag in the team.
- [Update tag](https://www.latitude.sh/docs/api-reference/update-tag.md): Update a Tag in the team.
- [Retrieve team](https://www.latitude.sh/docs/api-reference/get-team.md)
- [Create team](https://www.latitude.sh/docs/api-reference/post-team.md)
- [Update team](https://www.latitude.sh/docs/api-reference/patch-current-team.md)
- [Retrieve traffic](https://www.latitude.sh/docs/api-reference/get-traffic-consumption.md)
- [Retrieve traffic quota](https://www.latitude.sh/docs/api-reference/get-traffic-quota.md)
- [Retrieve profile](https://www.latitude.sh/docs/api-reference/get-user-profile.md): Retrieve the current user profile
- [Update profile](https://www.latitude.sh/docs/api-reference/patch-user-profile.md): Update the current user profile
- [List user teams](https://www.latitude.sh/docs/api-reference/get-user-teams.md): Returns a list of all teams the user belongs to
- [List marketplace apps](https://www.latitude.sh/docs/api-reference/list-marketplace-apps.md): Lists the marketplace apps available to deploy on Virtual Machines. Only published apps are returned.
- [Retrieve a marketplace app](https://www.latitude.sh/docs/api-reference/get-marketplace-app.md): Retrieve a single marketplace app by ID or slug. Only published apps are visible.
- [List VMs](https://www.latitude.sh/docs/api-reference/index-virtual-machine.md): Show all Team's Virtual Machines.
- [Create VM](https://www.latitude.sh/docs/api-reference/create-virtual-machine.md): Creates a new Virtual Machine.
- [Retrieve VM](https://www.latitude.sh/docs/api-reference/show-virtual-machine.md): Show a Virtual Machine.
- [Destroy VM](https://www.latitude.sh/docs/api-reference/destroy-virtual-machine.md): Destroys a Virtual Machine.
- [Update VM](https://www.latitude.sh/docs/api-reference/update-virtual-machine.md): Updates a Virtual Machine's display name (hostname).
- [Run VM power action](https://www.latitude.sh/docs/api-reference/create-virtual-machine-action.md): Performs a power action on a given virtual machine: - `power_on` - Starts the virtual machine - `power_off` - Stops the virtual machine - `reboot` - Restarts the virtual machine
- [Retrieve VM metrics](https://www.latitude.sh/docs/api-reference/show-virtual-machine-metrics.md): Retrieve a time series for a single metric of a Virtual Machine.
- [List VM network attachments](https://www.latitude.sh/docs/api-reference/virtual-machines/list-vm-network-attachments.md): Lists the secondary network attachments currently configured for a Virtual Machine.
- [Attach a network to a VM](https://www.latitude.sh/docs/api-reference/virtual-machines/attach-a-network-to-a-vm.md): Attaches a virtual network (VLAN) to a Virtual Machine. Work runs asynchronously and returns 202 Accepted. A running VM restarts so the new NIC reaches the guest; a VM that is not running picks it up when it next starts.
- [Detach a network from a VM](https://www.latitude.sh/docs/api-reference/virtual-machines/detach-a-network-from-a-vm.md): Detaches a virtual network (VLAN) from a Virtual Machine. Work runs asynchronously and returns 202 Accepted. A running VM restarts so the NIC is removed from the guest; a VM that is not running loses it when it next starts.
- [List a VM's backups](https://www.latitude.sh/docs/api-reference/virtual-machine-backups/list-a-vms-backups.md): Lists the backups of the given Virtual Machine.
- [Create VM backup](https://www.latitude.sh/docs/api-reference/virtual-machine-backups/create-vm-backup.md): Triggers a backup of the given Virtual Machine.
- [List all VM backups](https://www.latitude.sh/docs/api-reference/virtual-machine-backups/list-all-vm-backups.md): Lists every backup that belongs to the authenticated team.
- [Create VM backup (top-level)](https://www.latitude.sh/docs/api-reference/virtual-machine-backups/create-vm-backup-top-level.md): Triggers a backup of the Virtual Machine referenced in the body.
- [Get VM backup](https://www.latitude.sh/docs/api-reference/virtual-machine-backups/get-vm-backup.md)
- [Delete VM backup](https://www.latitude.sh/docs/api-reference/virtual-machine-backups/delete-vm-backup.md): Archives and deletes a Virtual Machine backup. Work runs asynchronously and returns 202 Accepted. Only `Ready` or `Failed` backups can be deleted, and not while a restore from the backup is in progress.
- [List a backup's restores](https://www.latitude.sh/docs/api-reference/virtual-machine-restores/list-a-backups-restores.md): Lists the restores created from the given backup.
- [Create VM restore](https://www.latitude.sh/docs/api-reference/virtual-machine-restores/create-vm-restore.md): Restores a backup into a new Virtual Machine. Optionally accepts a `name` for the restored VM and a target `site` slug to restore into another region.
- [List a backup's restores (top-level backup path)](https://www.latitude.sh/docs/api-reference/virtual-machine-restores/list-a-backups-restores-top-level-backup-path.md): Lists the restores created from the given backup, reached via the top-level backup path.
- [List all VM restores](https://www.latitude.sh/docs/api-reference/virtual-machine-restores/list-all-vm-restores.md): Lists every restore that belongs to the authenticated team.
- [Create VM restore (flat)](https://www.latitude.sh/docs/api-reference/virtual-machine-restores/create-vm-restore-flat.md): Restores the backup referenced in the body into a new Virtual Machine. Optionally accepts a `name` for the restored VM and a target `site` slug to restore into another region.
- [Get VM restore](https://www.latitude.sh/docs/api-reference/virtual-machine-restores/get-vm-restore.md)
- [List VLANs](https://www.latitude.sh/docs/api-reference/get-virtual-networks.md): Lists virtual networks assigned to a project
- [Create VLAN](https://www.latitude.sh/docs/api-reference/create-virtual-network.md): Creates a new Virtual Network.
- [Retrieve VLAN](https://www.latitude.sh/docs/api-reference/get-virtual-network.md): Retrieve a Virtual Network.
- [Delete VLAN](https://www.latitude.sh/docs/api-reference/destroy-virtual-network.md): Delete virtual network
- [Update VLAN](https://www.latitude.sh/docs/api-reference/update-virtual-network.md): Update a Virtual Network.
- [List VLAN assignments](https://www.latitude.sh/docs/api-reference/get-virtual-networks-assignments.md): Returns a list of all servers assigned to virtual networks.
- [Assign VLAN](https://www.latitude.sh/docs/api-reference/assign-server-virtual-network.md)
- [Delete VLAN assignment](https://www.latitude.sh/docs/api-reference/delete-virtual-networks-assignments.md): Allow you to remove a Virtual Network assignment.
- [List VPN sessions](https://www.latitude.sh/docs/api-reference/get-vpn-sessions.md)
- [Create VPN session](https://www.latitude.sh/docs/api-reference/post-vpn-session.md): Creates a new VPN Session. `NOTE:` The VPN credentials are only listed ONCE upon creation. They can however be refreshed or deleted.
- [Refresh VPN session](https://www.latitude.sh/docs/api-reference/put-vpn-session.md): Refreshing an existing VPN Session will create new credentials for that session
- [Delete VPN session](https://www.latitude.sh/docs/api-reference/delete-vpn-session.md): Deletes an existing VPN Session.
- [Show managed database metrics](https://www.latitude.sh/docs/api-reference/managed-databases/show-managed-database-metrics.md)
- [List managed databases](https://www.latitude.sh/docs/api-reference/list-managed-databases.md)
- [Create a managed database](https://www.latitude.sh/docs/api-reference/create-managed-database.md)
- [Show a managed database](https://www.latitude.sh/docs/api-reference/show-managed-database.md)
- [Destroy a managed database](https://www.latitude.sh/docs/api-reference/destroy-managed-database.md)
- [Update a managed database](https://www.latitude.sh/docs/api-reference/update-managed-database.md)
- [List managed database backups](https://www.latitude.sh/docs/api-reference/list-managed-database-backups.md)
- [Developer resources](https://www.latitude.sh/docs/development.md): Tools, SDKs, and resources to build and scale on Latitude.sh
- [Examples](https://www.latitude.sh/docs/examples.md): Code examples for common use cases
- [Latitude.sh CLI](https://www.latitude.sh/docs/cli.md)
- [Commands](https://www.latitude.sh/docs/cli/commands.md)
- [Examples](https://www.latitude.sh/docs/cli/examples.md)
- [Output formats & automation](https://www.latitude.sh/docs/cli/output-formats.md): Render lsh list results as JSON, YAML, or CSV, filter them with JMESPath, and control pagination for scripts, CI, and AI agents
- [Model Context Protocol (MCP)](https://www.latitude.sh/docs/development/model-context-protocol.md): Let AI agents manage your Latitude.sh infrastructure through our hosted MCP server
- [SDKs](https://www.latitude.sh/docs/client-libraries.md): Official SDKs for the Latitude.sh API
- [Terraform](https://www.latitude.sh/docs/development/terraform.md)
- [Postman Collection](https://www.latitude.sh/docs/development/postman.md): Test and explore the Latitude.sh API using Postman
- [Cluster API](https://www.latitude.sh/docs/development/cluster-api.md)

## OpenAPI Specs

- [latitude-sh-api-with-code-samples](https://spec.speakeasy.com/latitude/latitude/latitude-sh-api-with-code-samples)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.