Amazon Lightsail API

The Amazon Lightsail API — 162 operations covering instances (virtual private servers), container services, object storage buckets, managed MySQL and PostgreSQL databases, block storage disks, static IP addresses, load balancers, CDN distributions, SSL/TLS certificates, DNS zones, alarms and snapshots. AWS JSON 1.1 over AWS Signature Version 4; regional endpoints.

Operations 162

POST /budgettracker/getCostEstimate Retrieves information about the cost estimate for a specified resource #
POST /ls/api/2016-11-28/AllocateStaticIp Allocates a static IP address #
POST /ls/api/2016-11-28/AttachCertificateToDistribution Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution #
POST /ls/api/2016-11-28/AttachDisk Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name #
POST /ls/api/2016-11-28/AttachInstancesToLoadBalancer Attaches one or more Lightsail instances to a load balancer #
POST /ls/api/2016-11-28/AttachLoadBalancerTlsCertificate Attaches a Transport Layer Security (TLS) certificate to your load balancer #
POST /ls/api/2016-11-28/AttachStaticIp Attaches a static IP address to a specific Amazon Lightsail instance #
POST /ls/api/2016-11-28/CloseInstancePublicPorts Closes ports for a specific Amazon Lightsail instance #
POST /ls/api/2016-11-28/CopySnapshot Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot #
POST /ls/api/2016-11-28/CreateBucket Creates an Amazon Lightsail bucket #
POST /ls/api/2016-11-28/CreateBucketAccessKey Creates a new access key for the specified Amazon Lightsail bucket #
POST /ls/api/2016-11-28/CreateCertificate Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service #
POST /ls/api/2016-11-28/CreateCloudFormationStack Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot #
POST /ls/api/2016-11-28/CreateContactMethod Creates an email or SMS text message contact method #
POST /ls/api/2016-11-28/CreateDisk Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone ( us-east-2a ) #
POST /ls/api/2016-11-28/CreateDiskFromSnapshot Creates a block storage disk from a manual or automatic snapshot of a disk #
POST /ls/api/2016-11-28/CreateDiskSnapshot Creates a snapshot of a block storage disk #
POST /ls/api/2016-11-28/CreateDistribution Creates an Amazon Lightsail content delivery network (CDN) distribution #
POST /ls/api/2016-11-28/CreateDomain Creates a domain resource for the specified domain (example.com) #
POST /ls/api/2016-11-28/CreateDomainEntry Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server... #
POST /ls/api/2016-11-28/CreateInstanceSnapshot Creates a snapshot of a specific virtual private server, or instance #
POST /ls/api/2016-11-28/CreateInstances Creates one or more Amazon Lightsail instances #
POST /ls/api/2016-11-28/CreateInstancesFromSnapshot Creates one or more new instances from a manual or automatic snapshot of an instance #
POST /ls/api/2016-11-28/CreateKeyPair Creates a custom SSH key pair that you can use with an Amazon Lightsail instance #
POST /ls/api/2016-11-28/CreateLoadBalancer Creates a Lightsail load balancer #
POST /ls/api/2016-11-28/CreateLoadBalancerTlsCertificate Creates an SSL/TLS certificate for an Amazon Lightsail load balancer #
POST /ls/api/2016-11-28/CreateRelationalDatabase Creates a new database in Amazon Lightsail #
POST /ls/api/2016-11-28/CreateRelationalDatabaseFromSnapshot Creates a new database from an existing database snapshot in Amazon Lightsail #
POST /ls/api/2016-11-28/CreateRelationalDatabaseSnapshot Creates a snapshot of your database in Amazon Lightsail #
DELETE /ls/api/2016-11-28/DeleteAlarm/{alarmName} Deletes an alarm #
POST /ls/api/2016-11-28/DeleteAutoSnapshot Deletes an automatic snapshot of an instance or disk #
POST /ls/api/2016-11-28/DeleteBucket Deletes a Amazon Lightsail bucket #
POST /ls/api/2016-11-28/DeleteBucketAccessKey Deletes an access key for the specified Amazon Lightsail bucket #
POST /ls/api/2016-11-28/DeleteCertificate Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution #
POST /ls/api/2016-11-28/DeleteContactMethod Deletes a contact method #
POST /ls/api/2016-11-28/DeleteDisk Deletes the specified block storage disk #
POST /ls/api/2016-11-28/DeleteDiskSnapshot Deletes the specified disk snapshot #
POST /ls/api/2016-11-28/DeleteDistribution Deletes your Amazon Lightsail content delivery network (CDN) distribution #
POST /ls/api/2016-11-28/DeleteDomain Deletes the specified domain recordset and all of its domain records #
POST /ls/api/2016-11-28/DeleteDomainEntry Deletes a specific domain entry #
POST /ls/api/2016-11-28/DeleteInstance Deletes an Amazon Lightsail instance #
POST /ls/api/2016-11-28/DeleteInstanceSnapshot Deletes a specific snapshot of a virtual private server (or instance ) #
POST /ls/api/2016-11-28/DeleteKeyPair Deletes the specified key pair by removing the public key from Amazon Lightsail #
POST /ls/api/2016-11-28/DeleteKnownHostKeys Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance #
POST /ls/api/2016-11-28/DeleteLoadBalancer Deletes a Lightsail load balancer and all its associated SSL/TLS certificates #
POST /ls/api/2016-11-28/DeleteLoadBalancerTlsCertificate Deletes an SSL/TLS certificate associated with a Lightsail load balancer #
POST /ls/api/2016-11-28/DeleteRelationalDatabase Deletes a database in Amazon Lightsail #
POST /ls/api/2016-11-28/DeleteRelationalDatabaseSnapshot Deletes a database snapshot in Amazon Lightsail #
POST /ls/api/2016-11-28/DetachCertificateFromDistribution Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution #
POST /ls/api/2016-11-28/DetachDisk Detaches a stopped block storage disk from a Lightsail instance #
POST /ls/api/2016-11-28/DetachInstancesFromLoadBalancer Detaches the specified instances from a Lightsail load balancer #
POST /ls/api/2016-11-28/DetachStaticIp Detaches a static IP from the Amazon Lightsail instance to which it is attached #
POST /ls/api/2016-11-28/DisableAddOn Disables an add-on for an Amazon Lightsail resource #
POST /ls/api/2016-11-28/DownloadDefaultKeyPair Downloads the regional Amazon Lightsail default key pair #
POST /ls/api/2016-11-28/EnableAddOn Enables or modifies an add-on for an Amazon Lightsail resource #
POST /ls/api/2016-11-28/ExportSnapshot Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2) #
POST /ls/api/2016-11-28/GetActiveNames Returns the names of all active (not deleted) resources #
GET /ls/api/2016-11-28/GetAlarms Returns information about the configured alarms #
POST /ls/api/2016-11-28/GetAutoSnapshots Returns the available automatic snapshots for an instance or disk #
POST /ls/api/2016-11-28/GetBlueprints Returns the list of available instance images, or blueprints #
POST /ls/api/2016-11-28/GetBucketAccessKeys Returns the existing access key IDs for the specified Amazon Lightsail bucket #
POST /ls/api/2016-11-28/GetBucketBundles Returns the bundles that you can apply to a Amazon Lightsail bucket #
POST /ls/api/2016-11-28/GetBucketMetricData Returns the data points of a specific metric for an Amazon Lightsail bucket #
POST /ls/api/2016-11-28/GetBuckets Returns information about one or more Amazon Lightsail buckets #
POST /ls/api/2016-11-28/GetBundles Returns the bundles that you can apply to an Amazon Lightsail instance when you create it #
POST /ls/api/2016-11-28/GetCertificates Returns information about one or more Amazon Lightsail SSL/TLS certificates #
POST /ls/api/2016-11-28/GetCloudFormationStackRecords Returns the CloudFormation stack record created as a result of the create cloud formation stack operation #
GET /ls/api/2016-11-28/GetContactMethods Returns information about the configured contact methods #
POST /ls/api/2016-11-28/GetDisk Returns information about a specific block storage disk #
POST /ls/api/2016-11-28/GetDiskSnapshot Returns information about a specific block storage disk snapshot #
POST /ls/api/2016-11-28/GetDiskSnapshots Returns information about all block storage disk snapshots in your AWS account and region #
POST /ls/api/2016-11-28/GetDisks Returns information about all block storage disks in your AWS account and region #
POST /ls/api/2016-11-28/GetDistributionBundles Returns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions #
POST /ls/api/2016-11-28/GetDistributionLatestCacheReset Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution #
POST /ls/api/2016-11-28/GetDistributionMetricData Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution #
POST /ls/api/2016-11-28/GetDistributions Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions #
POST /ls/api/2016-11-28/GetDomain Returns information about a specific domain recordset #
POST /ls/api/2016-11-28/GetDomains Returns a list of all domains in the user's account #
POST /ls/api/2016-11-28/GetExportSnapshotRecords Returns all export snapshot records created as a result of the export snapshot operation #
POST /ls/api/2016-11-28/GetInstance Returns information about a specific Amazon Lightsail instance, which is a virtual private server #
POST /ls/api/2016-11-28/GetInstanceAccessDetails Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance #
POST /ls/api/2016-11-28/GetInstanceMetricData Returns the data points for the specified Amazon Lightsail instance metric, given an instance name #
POST /ls/api/2016-11-28/GetInstancePortStates Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses allowed to connect to the instance through the ports, and the... #
POST /ls/api/2016-11-28/GetInstanceSnapshot Returns information about a specific instance snapshot #
POST /ls/api/2016-11-28/GetInstanceSnapshots Returns all instance snapshots for the user's account #
POST /ls/api/2016-11-28/GetInstanceState Returns the state of a specific instance #
POST /ls/api/2016-11-28/GetInstances Returns information about all Amazon Lightsail virtual private servers, or instances #
POST /ls/api/2016-11-28/GetKeyPair Returns information about a specific key pair #
POST /ls/api/2016-11-28/GetKeyPairs Returns information about all key pairs in the user's account #
POST /ls/api/2016-11-28/GetLoadBalancer Returns information about the specified Lightsail load balancer #
POST /ls/api/2016-11-28/GetLoadBalancerMetricData Returns information about health metrics for your Lightsail load balancer #
POST /ls/api/2016-11-28/GetLoadBalancerTlsCertificates Returns information about the TLS certificates that are associated with the specified Lightsail load balancer #
POST /ls/api/2016-11-28/GetLoadBalancerTlsPolicies Returns a list of TLS security policies that you can apply to Lightsail load balancers #
POST /ls/api/2016-11-28/GetLoadBalancers Returns information about all load balancers in an account #
POST /ls/api/2016-11-28/GetOperation Returns information about a specific operation #
POST /ls/api/2016-11-28/GetOperations Returns information about all operations #
POST /ls/api/2016-11-28/GetOperationsForResource Gets operations for a specific resource (an instance or a static IP) #
GET /ls/api/2016-11-28/GetProfile Returns information about the profile of the Amazon Lightsail account that makes the request #
POST /ls/api/2016-11-28/GetRegions Returns a list of all valid regions for Amazon Lightsail #
POST /ls/api/2016-11-28/GetRelationalDatabase Returns information about a specific database in Amazon Lightsail #
POST /ls/api/2016-11-28/GetRelationalDatabaseBlueprints Returns a list of available database blueprints in Amazon Lightsail #
POST /ls/api/2016-11-28/GetRelationalDatabaseBundles Returns the list of bundles that are available in Amazon Lightsail #
POST /ls/api/2016-11-28/GetRelationalDatabaseEvents Returns a list of events for a specific database in Amazon Lightsail #
POST /ls/api/2016-11-28/GetRelationalDatabaseLogEvents Returns a list of log events for a database in Amazon Lightsail #
POST /ls/api/2016-11-28/GetRelationalDatabaseLogStreams Returns a list of available log streams for a specific database in Amazon Lightsail #
POST /ls/api/2016-11-28/GetRelationalDatabaseMasterUserPassword Returns the current, previous, or pending versions of the master user password for a Lightsail database #
POST /ls/api/2016-11-28/GetRelationalDatabaseMetricData Returns the data points of the specified metric for a database in Amazon Lightsail #
POST /ls/api/2016-11-28/GetRelationalDatabaseParameters Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail #
POST /ls/api/2016-11-28/GetRelationalDatabaseSnapshot Returns information about a specific database snapshot in Amazon Lightsail #
POST /ls/api/2016-11-28/GetRelationalDatabaseSnapshots Returns information about all of your database snapshots in Amazon Lightsail #
POST /ls/api/2016-11-28/GetRelationalDatabases Returns information about all of your databases in Amazon Lightsail #
POST /ls/api/2016-11-28/GetStaticIp Returns information about an Amazon Lightsail static IP #
POST /ls/api/2016-11-28/GetStaticIps Returns information about all static IPs in the user's account #
POST /ls/api/2016-11-28/ImportKeyPair Imports a public SSH key from a specific key pair #
POST /ls/api/2016-11-28/IsVpcPeered Returns a Boolean value indicating whether your Lightsail VPC is peered #
POST /ls/api/2016-11-28/OpenInstancePublicPorts Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol #
POST /ls/api/2016-11-28/PeerVpc Peers the Lightsail VPC with the user's default VPC #
POST /ls/api/2016-11-28/PutAlarm Creates or updates an alarm, and associates it with the specified metric #
POST /ls/api/2016-11-28/PutInstancePublicPorts Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol #
POST /ls/api/2016-11-28/RebootInstance Restarts a specific instance #
POST /ls/api/2016-11-28/RebootRelationalDatabase Restarts a specific database in Amazon Lightsail #
POST /ls/api/2016-11-28/ReleaseStaticIp Deletes a specific static IP from your account #
POST /ls/api/2016-11-28/ResetDistributionCache Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution #
POST /ls/api/2016-11-28/SendContactMethodVerification Sends a verification request to an email contact method to ensure it's owned by the requester #
POST /ls/api/2016-11-28/SetIpAddressType Sets the IP address type for an Amazon Lightsail resource #
POST /ls/api/2016-11-28/SetResourceAccessForBucket Sets the Amazon Lightsail resources that can access the specified Lightsail bucket #
POST /ls/api/2016-11-28/StartInstance Starts a specific Amazon Lightsail instance from a stopped state #
POST /ls/api/2016-11-28/StartRelationalDatabase Starts a specific database from a stopped state in Amazon Lightsail #
POST /ls/api/2016-11-28/StopInstance Stops a specific Amazon Lightsail instance that is currently running #
POST /ls/api/2016-11-28/StopRelationalDatabase Stops a specific database that is currently running in Amazon Lightsail #
POST /ls/api/2016-11-28/TagResource Adds one or more tags to the specified Amazon Lightsail resource #
GET /ls/api/2016-11-28/TestAlarm/{alarmName} Tests an alarm by displaying a banner on the Amazon Lightsail console #
POST /ls/api/2016-11-28/UnpeerVpc Unpeers the Lightsail VPC from the user's default VPC #
POST /ls/api/2016-11-28/UntagResource Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource #
POST /ls/api/2016-11-28/UpdateBucket Updates an existing Amazon Lightsail bucket #
POST /ls/api/2016-11-28/UpdateBucketBundle Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket #
POST /ls/api/2016-11-28/UpdateDistribution Updates an existing Amazon Lightsail content delivery network (CDN) distribution #
POST /ls/api/2016-11-28/UpdateDistributionBundle Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution #
POST /ls/api/2016-11-28/UpdateDomainEntry Updates a domain recordset after it is created #
POST /ls/api/2016-11-28/UpdateInstanceMetadataOptions Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance #
POST /ls/api/2016-11-28/UpdateLoadBalancerAttribute Updates the specified attribute for a load balancer #
POST /ls/api/2016-11-28/UpdateRelationalDatabase Allows the update of one or more attributes of a database in Amazon Lightsail #
POST /ls/api/2016-11-28/UpdateRelationalDatabaseParameters Allows the update of one or more parameters of a database in Amazon Lightsail #
GET /ls/api/2016-11-28/container-api-metadata Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin #
POST /ls/api/2016-11-28/container-registry-login Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine #
GET /ls/api/2016-11-28/container-service-powers Returns the list of powers that can be specified for your Amazon Lightsail container services #
POST /ls/api/2016-11-28/container-services Creates an Amazon Lightsail container service #
GET /ls/api/2016-11-28/container-services Returns information about one or more of your Amazon Lightsail container services #
DELETE /ls/api/2016-11-28/container-services/{serviceName} Deletes your Amazon Lightsail container service #
PATCH /ls/api/2016-11-28/container-services/{serviceName} Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names #
GET /ls/api/2016-11-28/container-services/{serviceName}/containers/{containerName}/log Returns the log events of a container of your Amazon Lightsail container service #
POST /ls/api/2016-11-28/container-services/{serviceName}/deployments Creates a deployment for your Amazon Lightsail container service #
GET /ls/api/2016-11-28/container-services/{serviceName}/deployments Returns the deployments for your Amazon Lightsail container service A deployment specifies the settings, such as the ports and launch command, of containers... #
GET /ls/api/2016-11-28/container-services/{serviceName}/images Returns the container images that are registered to your Amazon Lightsail container service #
POST /ls/api/2016-11-28/container-services/{serviceName}/images Registers a container image to your Amazon Lightsail container service #
DELETE /ls/api/2016-11-28/container-services/{serviceName}/images/{image} Deletes a container image that is registered to your Amazon Lightsail container service #
GET /ls/api/2016-11-28/container-services/{serviceName}/metrics Returns the data points of a specific metric of your Amazon Lightsail container service #
POST /ls/api/2016-11-28/create-gui-session-access-details Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session #
POST /ls/api/2016-11-28/get-setup-history Returns detailed information for five of the most recent SetupInstanceHttps requests that were ran on the target instance #
POST /ls/api/2016-11-28/setup-instance-https Creates an SSL/TLS certificate that secures traffic for your website #
POST /ls/api/2016-11-28/start-gui-session Initiates a graphical user interface (GUI) session that’s used to access a virtual computer’s operating system and application #
POST /ls/api/2016-11-28/stop-gui-session Terminates a web-based Amazon DCV session that’s used to access a virtual computer’s operating system or application #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-lightsail-instances-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-lightsail-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Lightsail API
  description: 'Amazon Lightsail is the easiest way to get started with Amazon Web Services (AWS) for developers
    who need to build websites or web applications. The API manages instances (virtual private servers), container
    services, storage buckets, managed databases, block storage disks, static IP addresses, load balancers, CDN
    distributions, DNS zones and resource snapshots. Derived mechanically from the AWS-published Smithy 2.0 service
    model (aws/api-models-aws, models/lightsail/service/2016-11-28). The wire protocol is AWS JSON 1.1: every operation
    is a POST signed with AWS Signature Version 4 (service name "lightsail") carrying the X-Amz-Target header shown
    as x-amz-target on each operation. Paths and response codes are the smithy.api#http traits the model itself
    declares.'
  version: '2016-11-28'
  contact:
    name: AWS Support
    url: https://aws.amazon.com/premiumsupport/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: https://a0.awsstatic.com/libra-css/images/logos/aws_logo_smile_1200x630.png
  x-generated-from: AWS Smithy 2.0 service model (https://github.com/aws/api-models-aws) — mechanical transform,
    no hand-authored operations
externalDocs:
  description: Amazon Lightsail API Reference
  url: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/Welcome.html
servers:
- url: https://lightsail.us-east-1.amazonaws.com
  description: Amazon Lightsail regional endpoint (us-east-1). Lightsail is regional — one endpoint per AWS Region,
    lightsail.{region}.amazonaws.com (IPv4) or lightsail.{region}.api.aws (dual-stack). See https://docs.aws.amazon.com/general/latest/gr/lightsail.html
security:
- sigv4: []
tags:
- name: Account
- name: Alarms
- name: Block Storage
- name: Blueprints
- name: Buckets
- name: Bundles
- name: Certificates
- name: Contact Methods
- name: Container Services
- name: Cost Estimate
- name: Distributions
- name: Domains
- name: Instances
- name: Key Pairs
- name: Load Balancers
- name: Operations
- name: Regions
- name: Relational Databases
- name: Setup
- name: Snapshots
- name: Static IPs


# --- truncated at 32 KB (865 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-lightsail/refs/heads/main/openapi/amazon-lightsail-openapi.yml