Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CheckSubdomainAvailability

Checks whether a Lightsail subdomain is available to create. Optionally, reserves the subdomain for your account for 15 minutes.

If you don't reserve the subdomain, another account can create it before you do.

Request Syntax


{
   "reserve": boolean,
   "subdomainName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

reserve

Specifies whether to reserve the subdomain for your account if it's available. A reservation holds the subdomain for 15 minutes so that other accounts can't create it. Checking the subdomain again doesn't extend the reservation.

For a nested subdomain, such as blog.mysite, the top-level subdomain (mysite) is reserved.

You can have up to 5 active reservations at a time.

Type: Boolean

Required: No

subdomainName

The subdomain to check (for example, mysite or blog.mysite).

A subdomain can contain one or two labels separated by a period (.). Each label must start and end with a lowercase letter or a number, and can contain only lowercase letters, numbers, and hyphens (-). The name can be up to 39 characters long, including periods. Labels that start with xn-- aren't supported, and some names are reserved.

Specify only the subdomain. A web address, such as mysite.amazonlightsail.com, isn't accepted.

Type: String

Required: Yes

Response Syntax


{
   "available": boolean,
   "reservationExpiresAt": number,
   "subdomainName": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

available

A Boolean value that indicates whether the subdomain is available to create.

Type: Boolean

reservationExpiresAt

The timestamp when the reservation of the subdomain expires.

The expiry is returned only when your account holds an active reservation for the subdomain.

Type: Timestamp

subdomainName

The subdomain that was checked.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

HTTP Status Code: 400

InvalidInputException

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Note

Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

HTTP Status Code: 400

OperationFailureException

Lightsail throws this exception when an operation fails to execute.

HTTP Status Code: 400

ServiceException

A general service exception.

HTTP Status Code: 500

UnauthenticatedException

Lightsail throws this exception when the user has not been authenticated.

HTTP Status Code: 400