Skip to content

Amazon Route 53 Resolver API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

<p>When you create a VPC using Amazon VPC, you automatically get DNS resolution within the VPC from Route 53 Resolver. By default, Resolver answers DNS queries for VPC domain names such as domain names for EC2 instances or Elastic Load Balancing load balancers. Resolver performs recursive lookups against public name servers for all other domain names.</p> <p>You can also configure DNS resolution between your VPC and your network over a Direct Connect or VPN connection:</p> <p> <b>Forward DNS queries from resolvers on your network to Route 53 Resolver</b> </p> <p>DNS resolvers on your network can forward DNS queries to Resolver in a specified VPC. This allows your DNS resolvers to easily resolve domain names for Amazon Web Services resources such as EC2 instances or records in a Route 53 private hosted zone. For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resolver.html#resolver-overview-forward-network-to-vpc">How DNS Resolvers on Your Network Forward DNS Queries to Route 53 Resolver</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> <p> <b>Conditionally forward queries from a VPC to resolvers on your network</b> </p> <p>You can configure Resolver to forward queries that it receives from EC2 instances in your VPCs to DNS resolvers on your network. To forward selected queries, you create Resolver rules that specify the domain names for the DNS queries that you want to forward (such as example.com), and the IP addresses of the DNS resolvers on your network that you want to forward the queries to. If a query matches multiple rules (example.com, acme.example.com), Resolver chooses the rule with the most specific match (acme.example.com) and forwards the query to the IP addresses that you specified in that rule. For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resolver.html#resolver-overview-forward-vpc-to-network">How Route 53 Resolver Forwards DNS Queries from Your VPCs to Your Network</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> <p>Like Amazon VPC, Resolver is Regional. In each Region where you have VPCs, you can choose whether to forward queries from your VPCs to your network (outbound queries), from your network to your VPCs (inbound queries), or both.</p>

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

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2018-04-01
Endpoints
63
Spec updated
2020-03-11

Endpoints

MethodPathWhat it does
POST/#X-Amz-Target=Route53Resolver.AssociateFirewallRuleGroupAssociates a <a>FirewallRuleGroup</a> with a VPC, to provide DNS filtering for the VPC.
POST/#X-Amz-Target=Route53Resolver.AssociateResolverEndpointIpAddress<p>Adds IP addresses to an inbound or an outbound Resolver endpoint. If you want to add more than one IP address, submit one <code>AssociateResolverEndpointIpAd
POST/#X-Amz-Target=Route53Resolver.AssociateResolverQueryLogConfig<p>Associates an Amazon VPC with a specified query logging configuration. Route 53 Resolver logs DNS queries that originate in all of the Amazon VPCs that are a
POST/#X-Amz-Target=Route53Resolver.AssociateResolverRuleAssociates a Resolver rule with a VPC. When you associate a rule with a VPC, Resolver forwards all DNS queries for the domain name that is specified in the rule
POST/#X-Amz-Target=Route53Resolver.CreateFirewallDomainListCreates an empty firewall domain list for use in DNS Firewall rules. You can populate the domains for the new list with a file, using <a>ImportFirewallDomains</
POST/#X-Amz-Target=Route53Resolver.CreateFirewallRuleCreates a single DNS Firewall rule in the specified rule group, using the specified domain list.
POST/#X-Amz-Target=Route53Resolver.CreateFirewallRuleGroupCreates an empty DNS Firewall rule group for filtering DNS network traffic in a VPC. You can add rules to the new rule group by calling <a>CreateFirewallRule</a
POST/#X-Amz-Target=Route53Resolver.CreateResolverEndpoint<p>Creates a Resolver endpoint. There are two types of Resolver endpoints, inbound and outbound:</p> <ul> <li> <p>An <i>inbound Resolver endpoint</i> forwards D
POST/#X-Amz-Target=Route53Resolver.CreateResolverQueryLogConfig<p>Creates a Resolver query logging configuration, which defines where you want Resolver to save DNS query logs that originate in your VPCs. Resolver can log qu
POST/#X-Amz-Target=Route53Resolver.CreateResolverRuleFor DNS queries that originate in your VPCs, specifies which Resolver endpoint the queries pass through, one domain name that you want to forward to your networ
POST/#X-Amz-Target=Route53Resolver.DeleteFirewallDomainListDeletes the specified domain list.
POST/#X-Amz-Target=Route53Resolver.DeleteFirewallRuleDeletes the specified firewall rule.
POST/#X-Amz-Target=Route53Resolver.DeleteFirewallRuleGroupDeletes the specified firewall rule group.
POST/#X-Amz-Target=Route53Resolver.DeleteResolverEndpoint<p>Deletes a Resolver endpoint. The effect of deleting a Resolver endpoint depends on whether it's an inbound or an outbound Resolver endpoint:</p> <ul> <li> <p
POST/#X-Amz-Target=Route53Resolver.DeleteResolverQueryLogConfig<p>Deletes a query logging configuration. When you delete a configuration, Resolver stops logging DNS queries for all of the Amazon VPCs that are associated wit
POST/#X-Amz-Target=Route53Resolver.DeleteResolverRuleDeletes a Resolver rule. Before you can delete a Resolver rule, you must disassociate it from all the VPCs that you associated the Resolver rule with. For more
POST/#X-Amz-Target=Route53Resolver.DisassociateFirewallRuleGroupDisassociates a <a>FirewallRuleGroup</a> from a VPC, to remove DNS filtering from the VPC.
POST/#X-Amz-Target=Route53Resolver.DisassociateResolverEndpointIpAddress<p>Removes IP addresses from an inbound or an outbound Resolver endpoint. If you want to remove more than one IP address, submit one <code>DisassociateResolverE
POST/#X-Amz-Target=Route53Resolver.DisassociateResolverQueryLogConfig<p>Disassociates a VPC from a query logging configuration.</p> <note> <p>Before you can delete a query logging configuration, you must first disassociate all VP
POST/#X-Amz-Target=Route53Resolver.DisassociateResolverRule<p>Removes the association between a specified Resolver rule and a specified VPC.</p> <important> <p>If you disassociate a Resolver rule from a VPC, Resolver st
POST/#X-Amz-Target=Route53Resolver.GetFirewallConfigRetrieves the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC).
POST/#X-Amz-Target=Route53Resolver.GetFirewallDomainListRetrieves the specified firewall domain list.
POST/#X-Amz-Target=Route53Resolver.GetFirewallRuleGroupRetrieves the specified firewall rule group.
POST/#X-Amz-Target=Route53Resolver.GetFirewallRuleGroupAssociationRetrieves a firewall rule group association, which enables DNS filtering for a VPC with one rule group. A VPC can have more than one firewall rule group associa
POST/#X-Amz-Target=Route53Resolver.GetFirewallRuleGroupPolicyReturns the Identity and Access Management (Amazon Web Services IAM) policy for sharing the specified rule group. You can use the policy to share the rule group
POST/#X-Amz-Target=Route53Resolver.GetResolverConfigRetrieves the behavior configuration of Route 53 Resolver behavior for a single VPC from Amazon Virtual Private Cloud.
POST/#X-Amz-Target=Route53Resolver.GetResolverDnssecConfigGets DNSSEC validation information for a specified resource.
POST/#X-Amz-Target=Route53Resolver.GetResolverEndpointGets information about a specified Resolver endpoint, such as whether it's an inbound or an outbound Resolver endpoint, and the current status of the endpoint.
POST/#X-Amz-Target=Route53Resolver.GetResolverQueryLogConfigGets information about a specified Resolver query logging configuration, such as the number of VPCs that the configuration is logging queries for and the locati
POST/#X-Amz-Target=Route53Resolver.GetResolverQueryLogConfigAssociationGets information about a specified association between a Resolver query logging configuration and an Amazon VPC. When you associate a VPC with a query logging c
POST/#X-Amz-Target=Route53Resolver.GetResolverQueryLogConfigPolicyGets information about a query logging policy. A query logging policy specifies the Resolver query logging operations and resources that you want to allow anoth
POST/#X-Amz-Target=Route53Resolver.GetResolverRuleGets information about a specified Resolver rule, such as the domain name that the rule forwards DNS queries for and the ID of the outbound Resolver endpoint th
POST/#X-Amz-Target=Route53Resolver.GetResolverRuleAssociationGets information about an association between a specified Resolver rule and a VPC. You associate a Resolver rule and a VPC using <a href="https://docs.aws.amazo
POST/#X-Amz-Target=Route53Resolver.GetResolverRulePolicyGets information about the Resolver rule policy for a specified rule. A Resolver rule policy includes the rule that you want to share with another account, the
POST/#X-Amz-Target=Route53Resolver.ImportFirewallDomains<p>Imports domain names from a file into a domain list, for use in a DNS firewall rule group. </p> <p>Each domain specification in your domain list must satisfy
POST/#X-Amz-Target=Route53Resolver.ListFirewallConfigs<p>Retrieves the firewall configurations that you have defined. DNS Firewall uses the configurations to manage firewall behavior for your VPCs. </p> <p>A single
POST/#X-Amz-Target=Route53Resolver.ListFirewallDomainLists<p>Retrieves the firewall domain lists that you have defined. For each firewall domain list, you can retrieve the domains that are defined for a list by calling
POST/#X-Amz-Target=Route53Resolver.ListFirewallDomains<p>Retrieves the domains that you have defined for the specified firewall domain list. </p> <p>A single call might return only a partial list of the domains. Fo
POST/#X-Amz-Target=Route53Resolver.ListFirewallRuleGroupAssociations<p>Retrieves the firewall rule group associations that you have defined. Each association enables DNS filtering for a VPC with one rule group. </p> <p>A single
POST/#X-Amz-Target=Route53Resolver.ListFirewallRuleGroups<p>Retrieves the minimal high-level information for the rule groups that you have defined. </p> <p>A single call might return only a partial list of the rule gr
POST/#X-Amz-Target=Route53Resolver.ListFirewallRules<p>Retrieves the firewall rules that you have defined for the specified firewall rule group. DNS Firewall uses the rules in a rule group to filter DNS network t
POST/#X-Amz-Target=Route53Resolver.ListResolverConfigsRetrieves the Resolver configurations that you have defined. Route 53 Resolver uses the configurations to manage DNS resolution behavior for your VPCs.
POST/#X-Amz-Target=Route53Resolver.ListResolverDnssecConfigsLists the configurations for DNSSEC validation that are associated with the current Amazon Web Services account.
POST/#X-Amz-Target=Route53Resolver.ListResolverEndpointIpAddressesGets the IP addresses for a specified Resolver endpoint.
POST/#X-Amz-Target=Route53Resolver.ListResolverEndpointsLists all the Resolver endpoints that were created using the current Amazon Web Services account.
POST/#X-Amz-Target=Route53Resolver.ListResolverQueryLogConfigAssociationsLists information about associations between Amazon VPCs and query logging configurations.
POST/#X-Amz-Target=Route53Resolver.ListResolverQueryLogConfigsLists information about the specified query logging configurations. Each configuration defines where you want Resolver to save DNS query logs and specifies the
POST/#X-Amz-Target=Route53Resolver.ListResolverRuleAssociationsLists the associations that were created between Resolver rules and VPCs using the current Amazon Web Services account.
POST/#X-Amz-Target=Route53Resolver.ListResolverRulesLists the Resolver rules that were created using the current Amazon Web Services account.
POST/#X-Amz-Target=Route53Resolver.ListTagsForResourceLists the tags that you associated with the specified resource.
POST/#X-Amz-Target=Route53Resolver.PutFirewallRuleGroupPolicyAttaches an Identity and Access Management (Amazon Web Services IAM) policy for sharing the rule group. You can use the policy to share the rule group using Res
POST/#X-Amz-Target=Route53Resolver.PutResolverQueryLogConfigPolicySpecifies an Amazon Web Services account that you want to share a query logging configuration with, the query logging configuration that you want to share, and
POST/#X-Amz-Target=Route53Resolver.PutResolverRulePolicySpecifies an Amazon Web Services rule that you want to share with another account, the account that you want to share the rule with, and the operations that you
POST/#X-Amz-Target=Route53Resolver.TagResourceAdds one or more tags to a specified resource.
POST/#X-Amz-Target=Route53Resolver.UntagResourceRemoves one or more tags from a specified resource.
POST/#X-Amz-Target=Route53Resolver.UpdateFirewallConfigUpdates the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC).
POST/#X-Amz-Target=Route53Resolver.UpdateFirewallDomainsUpdates the firewall domain list from an array of domain specifications.
POST/#X-Amz-Target=Route53Resolver.UpdateFirewallRuleUpdates the specified firewall rule.
POST/#X-Amz-Target=Route53Resolver.UpdateFirewallRuleGroupAssociationChanges the association of a <a>FirewallRuleGroup</a> with a VPC. The association enables DNS filtering for the VPC.
POST/#X-Amz-Target=Route53Resolver.UpdateResolverConfigUpdates the behavior configuration of Route 53 Resolver behavior for a single VPC from Amazon Virtual Private Cloud.
POST/#X-Amz-Target=Route53Resolver.UpdateResolverDnssecConfigUpdates an existing DNSSEC validation configuration. If there is no existing DNSSEC validation configuration, one is created.
POST/#X-Amz-Target=Route53Resolver.UpdateResolverEndpointUpdates the name, or enpoint type for an inbound or an outbound Resolver endpoint. You can only update between IPV4 and DUALSTACK, IPV6 endpoint type can't be u
POST/#X-Amz-Target=Route53Resolver.UpdateResolverRuleUpdates settings for a specified Resolver rule. <code>ResolverRuleId</code> is required, and all other parameters are optional. If you don't specify a parameter

Questions

Does the Amazon Route 53 Resolver API need an API key?

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

Does the Amazon Route 53 Resolver API support HTTPS?

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

How many endpoints does the Amazon Route 53 Resolver API have?

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

What are alternatives to the Amazon Route 53 Resolver 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).