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/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/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/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/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/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/CreateLoadBalancerTlsCertificate
Creates an SSL/TLS certificate for an Amazon Lightsail load balancer
#
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
#
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/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/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/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/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/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/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
#
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/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/GetInstances
Returns information about all Amazon Lightsail virtual private servers, or instances
#
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/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/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/GetStaticIps
Returns information about all static IPs in the user's account
#
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/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/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/UntagResource
Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource
#
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/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
#
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
#
Documentation
📖
APIReference
https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/Welcome.html
📖
Documentation
https://docs.aws.amazon.com/lightsail/latest/userguide/what-is-amazon-lightsail.html
📖
GettingStarted
https://aws.amazon.com/lightsail/getting-started/
Specifications
Schemas & Data
Other Resources
🔗
Smithy
https://raw.githubusercontent.com/api-evangelist/amazon-lightsail/refs/heads/main/smithy/amazon-lightsail-2016-11-28.json
🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/amazon-lightsail/refs/heads/main/overlays/amazon-lightsail-overlay.yaml
🔗
Pricing
https://aws.amazon.com/lightsail/pricing/
🔗
FAQ
https://aws.amazon.com/lightsail/faq/
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/amazon-lightsail/refs/heads/main/json-ld/amazon-lightsail-context.jsonld
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/amazon-lightsail/refs/heads/main/apis.yml