Amazon Lightsail

Amazon Lightsail Instances API

Lightsail virtual server instance management

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 22

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /instances Create instances via the REST-style /instances path · Amazon Lightsail Create Instances #
Ask an LLM
“Can I create instances by POSTing to the /instances resource path?”
“What does the resource-style POST /instances endpoint do?”
Tell an agent
Create instances with a POST to the REST-style /instances path.
Use POST /instances to launch new servers.
GET /instances List instances via the REST-style /instances path · Amazon Lightsail Get Instances #
Ask an LLM
“Is there a plain GET /instances resource path for listing my servers?”
“Which REST-style endpoint lists instances without the JSON action body?”
Tell an agent
List my instances with a GET on the REST-style /instances path.
Call GET /instances to list all virtual private servers.
GET /instances/{instanceName} Get an instance via the REST-style /instances path · Amazon Lightsail Get Instance #
Ask an LLM
“Can I fetch one server with a plain GET on its /instances resource path?”
“Which resource-path endpoint returns a single instance by name?”
Tell an agent
GET /instances/{instanceName} to read that server.
Fetch instance {instanceName} through the REST-style resource path.
DELETE /instances/{instanceName} Delete an instance via an HTTP DELETE on /instances · Amazon Lightsail Delete Instance #
Ask an LLM
“Can I remove a server with an HTTP DELETE on its /instances path?”
“Is there a REST-style DELETE endpoint for instances?”
Tell an agent destructive · confirm first
Send DELETE /instances/{instanceName} to remove that server.
Delete instance {instanceName} using the REST-style resource path.
POST /instances/{instanceName}/start Start an instance via the REST-style /start path · Amazon Lightsail Start Instance #
Ask an LLM
“Can I boot a server by POSTing to its /start sub-path?”
“Which REST-style path starts an instance?”
Tell an agent
POST to /instances/{instanceName}/start.
Start {instanceName} through the REST-style /start path.
POST /instances/{instanceName}/stop Stop an instance via the REST-style /stop path · Amazon Lightsail Stop Instance #
Ask an LLM
“Can I shut down a server by POSTing to its /stop sub-path?”
“Which REST-style path stops an instance?”
Tell an agent
POST to /instances/{instanceName}/stop.
Stop {instanceName} through the REST-style /stop path.
POST /ls/api/2016-11-28/CloseInstancePublicPorts Close a firewall port on an instance · Closes ports for a specific Amazon Lightsail instance #
Ask an LLM
“How do I close port 22 to the public on my instance?”
“Can I remove one firewall rule without touching the others?”
Tell an agent
Close port {portInfo} on {instanceName}.
Remove the firewall rule {portInfo} from instance {instanceName}.
POST /ls/api/2016-11-28/CreateInstances Launch new instances from a blueprint · Creates one or more Amazon Lightsail instances #
Ask an LLM
“How do I launch a new Lightsail server running WordPress or Ubuntu?”
“Can I pass a launch script and SSH key when creating an instance?”
Tell an agent
Create instances {instanceNames} in {availabilityZone} from blueprint {blueprintId} on bundle {bundleId}.
Launch {instanceNames} ({blueprintId}, {bundleId}) in {availabilityZone} with key pair {keyPairName} and user data {userData}.
POST /ls/api/2016-11-28/DeleteInstance Delete an instance · Deletes an Amazon Lightsail instance #
Ask an LLM
“How do I permanently delete a Lightsail server?”
“Can I force-delete an instance's add-ons like automatic snapshots along with it?”
Tell an agent destructive · confirm first
Delete instance {instanceName}.
Delete {instanceName} and force-delete its add-ons ({forceDeleteAddOns}).
POST /ls/api/2016-11-28/GetInstance Get details of one instance · Returns information about a specific Amazon Lightsail instance, which is a… #
Ask an LLM
“What's the public IP, plan and blueprint of a particular server?”
“Which disks and add-ons are on a specific instance?”
Tell an agent
Get details for instance {instanceName}.
Show the IP addresses and plan of {instanceName}.
POST /ls/api/2016-11-28/GetInstanceAccessDetails Get temporary SSH or RDP access credentials · Returns temporary SSH keys you can use to connect to a specific virtual private… #
Ask an LLM
“How do I get temporary SSH keys to connect to my instance?”
“Can I get RDP login details for a Windows instance?”
Tell an agent
Get temporary access details for {instanceName}.
Give me {protocol} credentials to connect to {instanceName}.
POST /ls/api/2016-11-28/GetInstanceMetricData Get CPU, network or status metrics for an instance · Returns the data points for the specified Amazon Lightsail instance metric… #
Ask an LLM
“How much CPU has my instance been using this week?”
“Can I check whether my instance is running out of burst capacity?”
Tell an agent
Get {metricName} for instance {instanceName} from {startTime} to {endTime} every {period}s as {statistics} in {unit}.
Show instance {instanceName} {metricName} since {startTime}.
POST /ls/api/2016-11-28/GetInstancePortStates Show an instance's open firewall ports · Returns the firewall port states for a specific Amazon Lightsail instance, the… #
Ask an LLM
“Which ports are open on my instance's firewall?”
“What IP ranges are allowed to reach each open port?”
Tell an agent
List the firewall port states for {instanceName}.
Show which ports and source IPs are allowed on {instanceName}.
POST /ls/api/2016-11-28/GetInstanceState Check whether an instance is running · Returns the state of a specific instance #
Ask an LLM
“Is my server running, stopped or pending right now?”
“What state is a given instance in?”
Tell an agent
Get the state of instance {instanceName}.
Check if {instanceName} is running.
POST /ls/api/2016-11-28/GetInstances List all instances · Returns information about all Amazon Lightsail virtual private servers, or… #
Ask an LLM
“Which Lightsail servers do I have in this region?”
“Can I page through all my instances with a page token?”
Tell an agent
List all my Lightsail instances.
Get the next page of instances using {pageToken}.
POST /ls/api/2016-11-28/OpenInstancePublicPorts Open an additional firewall port · Opens ports for a specific Amazon Lightsail instance, and specifies the IP… #
Ask an LLM
“How do I open port 443 on my instance without changing other rules?”
“Can I restrict a newly opened port to certain IP addresses?”
Tell an agent
Open port {portInfo} on {instanceName}.
Add firewall rule {portInfo} to {instanceName}, keeping existing rules.
POST /ls/api/2016-11-28/PutInstancePublicPorts Replace all firewall rules on an instance · Opens ports for a specific Amazon Lightsail instance, and specifies the IP… #
Ask an LLM
“Can I overwrite the whole firewall of an instance with a new set of rules?”
“What happens to ports I leave out when I replace an instance's rules?”
Tell an agent
Replace all firewall rules on {instanceName} with {portInfos}.
Set the full list of open ports on {instanceName} to {portInfos}.
POST /ls/api/2016-11-28/RebootInstance Reboot an instance · Restarts a specific instance #
Ask an LLM
“How do I restart a Lightsail server that's unresponsive?”
“Does rebooting an instance keep its public IP?”
Tell an agent
Reboot instance {instanceName}.
Restart {instanceName}.
POST /ls/api/2016-11-28/StartInstance Start a stopped instance · Starts a specific Amazon Lightsail instance from a stopped state #
Ask an LLM
“How do I boot a stopped Lightsail server?”
“Will my instance get a new public IP when I start it again?”
Tell an agent
Start instance {instanceName}.
Power on the stopped server {instanceName}.
POST /ls/api/2016-11-28/StopInstance Stop a running instance · Stops a specific Amazon Lightsail instance that is currently running #
Ask an LLM
“How do I shut down a running Lightsail server?”
“Can I force-stop an instance that's stuck stopping?”
Tell an agent
Stop instance {instanceName}.
Force-stop {instanceName} ({force}).
POST /ls/api/2016-11-28/UpdateInstanceMetadataOptions Change an instance's metadata service settings · Modifies the Amazon Lightsail instance metadata parameters on a running or… #
Ask an LLM
“How do I require IMDSv2 tokens on my instance?”
“Can I turn off the instance metadata endpoint or enable it over IPv6?”
Tell an agent
Require metadata tokens on {instanceName} by setting httpTokens to {httpTokens}.
Set the metadata endpoint of {instanceName} to {httpEndpoint}.
POST /ls/api/2016-11-28/setup-instance-https Set up HTTPS on an instance's website · Creates an SSL/TLS certificate that secures traffic for your website #
Ask an LLM
“How do I add a free SSL certificate to the website on my instance?”
“Can Lightsail configure HTTPS for several domain names on one server?”
Tell an agent
Set up HTTPS on {instanceName} for {domainNames} using {certificateProvider}, contact {emailAddress}.
Secure the site on {instanceName} ({domainNames}) with a {certificateProvider} certificate registered to {emailAddress}.

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

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/amazon-lightsail/refs/heads/main/openapi/amazon-lightsail-instances-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amazon-lightsail/refs/heads/main/json-schema/amazon-lightsail-instance-schema.json

Other Resources

🔗
Smithy
https://raw.githubusercontent.com/api-evangelist/amazon-lightsail/refs/heads/main/smithy/amazon-lightsail-2016-11-28.json
🔗
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

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: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.

GitHub Google LinkedIn

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

OpenAPI Specification

amazon-lightsail-instances-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Amazon Lightsail Instances API
  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-refined-note:
  - x-generated-from differs across the merged source definitions and was not carried
  x-logo:
    url: https://a0.awsstatic.com/libra-css/images/logos/aws_logo_smile_1200x630.png
  version: '1.0'
  description: 'Operations tagged Instances across 2 of this provider''s published API definitions: amazon-lightsail-openapi.yml, amazon-lightsail-openapi_2.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://lightsail.us-east-1.amazonaws.com
  description: Amazon Lightsail endpoint
security:
- sigv4: []
tags:


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