Skip to content

Amazon Route 53 API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

<p>Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web service.</p> <p>You can use Route 53 to:</p> <ul> <li> <p>Register domain names.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-domain-registration.html">How domain registration works</a>.</p> </li> <li> <p>Route internet traffic to the resources for your domain</p> <p>For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-dns-service.html">How internet traffic is routed to your website or web application</a>.</p> </li> <li> <p>Check the health of your resources.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-health-checks.html">How Route 53 checks the health of your resources</a>.</p> </li> </ul>

Amazon Route 53 is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 70 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Base URL
https://route53.amazonaws.com
Version
2013-04-01
Endpoints
70
Spec updated
2020-05-07

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://route53.amazonaws.com/2013-04-01/cidrcollection" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"
JavaScript
const response = await fetch("https://route53.amazonaws.com/2013-04-01/cidrcollection", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://route53.amazonaws.com/2013-04-01/cidrcollection",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
POST/2013-04-01/keysigningkey/{HostedZoneId}/{Name}/activateActivates a key-signing key (KSK) so that it can be used for signing by DNSSEC. This operation changes the KSK status to <code>ACTIVE</code>.
POST/2013-04-01/hostedzone/{Id}/associatevpc<p>Associates an Amazon VPC with a private hosted zone. </p> <important> <p>To perform the association, the VPC and the private hosted zone must already exist.
GET/2013-04-01/cidrcollection/{CidrCollectionId}Returns a paginated list of CIDR locations for the given collection (metadata only, does not include CIDR blocks).
POST/2013-04-01/cidrcollection/{CidrCollectionId}<p>Creates, changes, or deletes CIDR blocks within a collection. Contains authoritative IP information mapping blocks to one or multiple locations.</p> <p>A cha
DELETE/2013-04-01/cidrcollection/{CidrCollectionId}Deletes a CIDR collection in the current Amazon Web Services account. The collection must be empty before it can be deleted.
POST/2013-04-01/hostedzone/{Id}/rrset/<p>Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name. For example,
GET/2013-04-01/tags/{ResourceType}/{ResourceId}<p>Lists tags for one health check or hosted zone. </p> <p>For information about using tags for cost allocation, see <a href="https://docs.aws.amazon.com/awsacc
POST/2013-04-01/tags/{ResourceType}/{ResourceId}<p>Adds, edits, or deletes tags for a health check or a hosted zone.</p> <p>For information about using tags for cost allocation, see <a href="https://docs.aws.
GET/2013-04-01/cidrcollectionReturns a paginated list of CIDR collections in the Amazon Web Services account (metadata only).
POST/2013-04-01/cidrcollectionCreates a CIDR collection in the current Amazon Web Services account.
GET/2013-04-01/healthcheckRetrieve a list of the health checks that are associated with the current Amazon Web Services account.
POST/2013-04-01/healthcheck<p>Creates a new health check.</p> <p>For information about adding health checks to resource record sets, see <a href="https://docs.aws.amazon.com/Route53/lates
GET/2013-04-01/hostedzone<p>Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account. The response includes a <code>Hoste
POST/2013-04-01/hostedzone<p>Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain,
POST/2013-04-01/keysigningkeyCreates a new key-signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone.
GET/2013-04-01/queryloggingconfig<p>Lists the configurations for DNS query logging that are associated with the current Amazon Web Services account or the configuration that is associated with
POST/2013-04-01/queryloggingconfig<p>Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudW
GET/2013-04-01/delegationsetRetrieves a list of the reusable delegation sets that are associated with the current Amazon Web Services account.
POST/2013-04-01/delegationset<p>Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones that were created by the same Amazon Web Services account
POST/2013-04-01/trafficpolicyCreates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www
POST/2013-04-01/trafficpolicyinstanceCreates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version. In addition, <code>CreateTrafficPolicyInsta
POST/2013-04-01/trafficpolicy/{Id}Creates a new version of an existing traffic policy. When you create a new version of a traffic policy, you specify the ID of the traffic policy that you want t
GET/2013-04-01/hostedzone/{Id}/authorizevpcassociation<p>Gets a list of the VPCs that were created by other accounts and that can be associated with a specified hosted zone because you've submitted one or more <cod
POST/2013-04-01/hostedzone/{Id}/authorizevpcassociation<p>Authorizes the Amazon Web Services account that created a specified VPC to submit an <code>AssociateVPCWithHostedZone</code> request to associate the VPC wit
POST/2013-04-01/keysigningkey/{HostedZoneId}/{Name}/deactivateDeactivates a key-signing key (KSK) so that it will not be used for signing by DNSSEC. This operation changes the KSK status to <code>INACTIVE</code>.
GET/2013-04-01/healthcheck/{HealthCheckId}Gets information about a specified health check.
POST/2013-04-01/healthcheck/{HealthCheckId}<p>Updates an existing health check. Note that some values can't be updated. </p> <p>For more information about updating health checks, see <a href="https://doc
DELETE/2013-04-01/healthcheck/{HealthCheckId}<p>Deletes a health check.</p> <important> <p>Amazon Route 53 does not prevent you from deleting a health check even if the health check is associated with one
GET/2013-04-01/hostedzone/{Id}Gets information about a specified hosted zone including the four name servers assigned to the hosted zone.
POST/2013-04-01/hostedzone/{Id}Updates the comment for a specified hosted zone.
DELETE/2013-04-01/hostedzone/{Id}<p>Deletes a hosted zone.</p> <p>If the hosted zone was created by another service, such as Cloud Map, see <a href="https://docs.aws.amazon.com/Route53/latest/D
DELETE/2013-04-01/keysigningkey/{HostedZoneId}/{Name}<p>Deletes a key-signing key (KSK). Before you can delete a KSK, you must deactivate it. The KSK must be deactivated before you can delete it regardless of whet
GET/2013-04-01/queryloggingconfig/{Id}<p>Gets information about a specified configuration for DNS query logging.</p> <p>For more information about DNS query logs, see <a href="https://docs.aws.amazo
DELETE/2013-04-01/queryloggingconfig/{Id}<p>Deletes a configuration for DNS query logging. If you delete a configuration, Amazon Route 53 stops sending query logs to CloudWatch Logs. Route 53 doesn't d
GET/2013-04-01/delegationset/{Id}Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set.
DELETE/2013-04-01/delegationset/{Id}<p>Deletes a reusable delegation set.</p> <important> <p>You can delete a reusable delegation set only if it isn't associated with any hosted zones.</p> </impor
GET/2013-04-01/trafficpolicy/{Id}/{Version}<p>Gets information about a specific traffic policy version.</p> <p>For information about how of deleting a traffic policy affects the response from <code>GetTr
POST/2013-04-01/trafficpolicy/{Id}/{Version}Updates the comment for a specified traffic policy version.
DELETE/2013-04-01/trafficpolicy/{Id}/{Version}<p>Deletes a traffic policy.</p> <p>When you delete a traffic policy, Route 53 sets a flag on the policy to indicate that it has been deleted. However, Route 53
GET/2013-04-01/trafficpolicyinstance/{Id}<p>Gets information about a specified traffic policy instance.</p> <note> <p>After you submit a <code>CreateTrafficPolicyInstance</code> or an <code>UpdateTraff
POST/2013-04-01/trafficpolicyinstance/{Id}<p>Updates the resource record sets in a specified hosted zone that were created based on the settings in a specified traffic policy version.</p> <p>When you up
DELETE/2013-04-01/trafficpolicyinstance/{Id}<p>Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance.</p> <note> <p>In the Route
POST/2013-04-01/hostedzone/{Id}/deauthorizevpcassociation<p>Removes authorization to submit an <code>AssociateVPCWithHostedZone</code> request to associate a specified VPC with a hosted zone that was created by a diff
POST/2013-04-01/hostedzone/{Id}/disable-dnssecDisables DNSSEC signing in a specific hosted zone. This action does not deactivate any key-signing keys (KSKs) that are active in the hosted zone.
POST/2013-04-01/hostedzone/{Id}/disassociatevpc<p>Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53 private hosted zone. Note the following:</p> <ul> <li> <p>You can't disass
POST/2013-04-01/hostedzone/{Id}/enable-dnssecEnables DNSSEC signing in a specific hosted zone.
GET/2013-04-01/accountlimit/{Type}<p>Gets the specified limit for the current account, for example, the maximum number of health checks that you can create using the account.</p> <p>For the defa
GET/2013-04-01/change/{Id}<p>Returns the current status of a change batch request. The status is one of the following values:</p> <ul> <li> <p> <code>PENDING</code> indicates that the ch
GET/2013-04-01/checkeripranges<p>Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.</p> <important> <p> <code>GetC
GET/2013-04-01/hostedzone/{Id}/dnssecReturns information about DNSSEC for a specific hosted zone, including the key-signing keys (KSKs) in the hosted zone.
GET/2013-04-01/geolocation<p>Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.</p> <p>Route 53 does not pe
GET/2013-04-01/healthcheckcountRetrieves the number of health checks that are associated with the current Amazon Web Services account.
GET/2013-04-01/healthcheck/{HealthCheckId}/lastfailurereasonGets the reason that a specified health check failed most recently.
GET/2013-04-01/healthcheck/{HealthCheckId}/status<p>Gets status of a specified health check. </p> <important> <p>This API is intended for use during development to diagnose behavior. It doesn’t support product
GET/2013-04-01/hostedzonecountRetrieves the number of hosted zones that are associated with the current Amazon Web Services account.
GET/2013-04-01/hostedzonelimit/{Id}/{Type}<p>Gets the specified limit for a specified hosted zone, for example, the maximum number of records that you can create in the hosted zone. </p> <p>For the defa
GET/2013-04-01/reusabledelegationsetlimit/{Id}/{Type}<p>Gets the maximum number of hosted zones that you can associate with the specified reusable delegation set.</p> <p>For the default limit, see <a href="https:/
GET/2013-04-01/trafficpolicyinstancecountGets the number of traffic policy instances that are associated with the current Amazon Web Services account.
GET/2013-04-01/cidrcollection/{CidrCollectionId}/cidrblocksReturns a paginated list of location objects and their CIDR blocks.
GET/2013-04-01/geolocations<p>Retrieves a list of supported geographic locations.</p> <p>Countries are listed first, and continents are listed last. If Amazon Route 53 supports subdivisio
GET/2013-04-01/hostedzonesbyname<p>Retrieves a list of your hosted zones in lexicographic order. The response includes a <code>HostedZones</code> child element for each hosted zone created by
GET/2013-04-01/hostedzonesbyvpc#vpcid&vpcregion<p>Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account or Amazon Web Services service ow
GET/2013-04-01/hostedzone/{Id}/rrset<p>Lists the resource record sets in a specified hosted zone.</p> <p> <code>ListResourceRecordSets</code> returns up to 300 resource record sets at a time in AS
POST/2013-04-01/tags/{ResourceType}<p>Lists tags for up to 10 health checks or hosted zones.</p> <p>For information about using tags for cost allocation, see <a href="https://docs.aws.amazon.com/
GET/2013-04-01/trafficpolicies<p>Gets information about the latest version for every traffic policy that is associated with the current Amazon Web Services account. Policies are listed in th
GET/2013-04-01/trafficpolicyinstances<p>Gets information about the traffic policy instances that you created by using the current Amazon Web Services account.</p> <note> <p>After you submit an <cod
GET/2013-04-01/trafficpolicyinstances/hostedzone#id<p>Gets information about the traffic policy instances that you created in a specified hosted zone.</p> <note> <p>After you submit a <code>CreateTrafficPolicyIn
GET/2013-04-01/trafficpolicyinstances/trafficpolicy#id&version<p>Gets information about the traffic policy instances that you created by using a specify traffic policy version.</p> <note> <p>After you submit a <code>Create
GET/2013-04-01/trafficpolicies/{Id}/versions<p>Gets information about all of the versions for a specified traffic policy.</p> <p>Traffic policy versions are listed in numerical order by <code>VersionNumbe
GET/2013-04-01/testdnsanswer#hostedzoneid&recordname&recordtype<p>Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify the IP address of a

Questions

Does the Amazon Route 53 API need an API key?

Yes. The Amazon Route 53 API uses API key authentication; the documentation explains how to get credentials.

Does the Amazon Route 53 API support HTTPS?

Yes, the Amazon Route 53 API is served over HTTPS.

How many endpoints does the Amazon Route 53 API have?

Its OpenAPI description lists 70 endpoints in version 2013-04-01. All of them are shown on this page.

What are alternatives to the Amazon Route 53 API?

Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.

Compare alternatives →

Remote Settings PROD

Cloud Platforms

Firefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.

No auth19 endpoints

Linode API

Cloud Platforms

## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se

Bearer token350 endpoints

DigitalOcean API

Cloud Platforms

# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having

Bearer token290 endpoints

Vercel API

Cloud Platforms

Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.

Bearer token112 endpoints

Platform API

Cloud Platforms

The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.

HTTP Basic22 endpoints

Azure Data Lake Storage

Cloud Platforms

Azure Data Lake Storage provides storage for Hadoop and other big data workloads.

No auth10 endpoints

Listed from APIs.guru (CC0).