Open documentation ↗Overview
<fullname>Well-Architected Tool</fullname> <p>This is the <i>Well-Architected Tool API Reference</i>. The WA Tool API provides programmatic access to the <a href="http://aws.amazon.com/well-architected-tool">Well-Architected Tool</a> in the <a href="https://console.aws.amazon.com/wellarchitected">Amazon Web Services Management Console</a>. For information about the Well-Architected Tool, see the <a href="https://docs.aws.amazon.com/wellarchitected/latest/userguide/intro.html">Well-Architected Tool User Guide</a>.</p>
AWS Well-Architected Tool is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 43 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Version
- 2020-03-31
- Endpoints
- 43
- OpenAPI
- Specification ↗
- Spec updated
- 2021-01-15
Endpoints
| Method | Path | What it does |
|---|---|---|
| PATCH | /workloads/{WorkloadId}/associateLenses | <p>Associate a lens to a workload.</p> <p>Up to 10 lenses can be associated with a workload in a single API operation. A maximum of 20 lenses can be associated |
| GET | /lenses/{LensAlias}/shares | List the lens shares associated with the lens. |
| POST | /lenses/{LensAlias}/shares | <p>Create a lens share.</p> <p>The owner of a lens can share it with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) |
| POST | /lenses/{LensAlias}/versions | <p>Create a new lens version.</p> <p>A lens can have up to 100 versions.</p> <p>Use this operation to publish a new lens version after you have imported a lens. |
| POST | /workloads/{WorkloadId}/milestones | Create a milestone for an existing workload. |
| POST | /workloads | <p>Create a new workload.</p> <p>The owner of a workload can share the workload with other Amazon Web Services accounts, users, an organization, and organizatio |
| GET | /workloads/{WorkloadId}/shares | List the workload shares associated with the workload. |
| POST | /workloads/{WorkloadId}/shares | <p>Create a workload share.</p> <p>The owner of a workload can share it with other Amazon Web Services accounts and users in the same Amazon Web Services Region |
| DELETE | /lenses/{LensAlias}#ClientRequestToken&LensStatus | <p>Delete an existing lens.</p> <p>Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and users that you shared the |
| DELETE | /lenses/{LensAlias}/shares/{ShareId}#ClientRequestToken | <p>Delete a lens share.</p> <p>After the lens share is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shar |
| DELETE | /workloads/{WorkloadId}#ClientRequestToken | Delete an existing workload. |
| DELETE | /workloads/{WorkloadId}/shares/{ShareId}#ClientRequestToken | Delete a workload share. |
| PATCH | /workloads/{WorkloadId}/disassociateLenses | <p>Disassociate a lens from a workload.</p> <p>Up to 10 lenses can be disassociated from a workload in a single API operation.</p> <note> <p>The Amazon Web Serv |
| GET | /lenses/{LensAlias}/export | <p>Export an existing lens.</p> <p>Only the owner of a lens can export it. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot |
| GET | /workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId} | Get the answer to a specific question in a workload review. |
| PATCH | /workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId} | Update the answer to a specific question in a workload review. |
| GET | /consolidatedReport#Format | <p>Get a consolidated report of your workloads.</p> <p>You can optionally choose to include workloads that have been shared with you.</p> |
| GET | /lenses/{LensAlias} | Get an existing lens. |
| GET | /workloads/{WorkloadId}/lensReviews/{LensAlias} | Get lens review. |
| PATCH | /workloads/{WorkloadId}/lensReviews/{LensAlias} | Update lens review for a particular workload. |
| GET | /workloads/{WorkloadId}/lensReviews/{LensAlias}/report | Get lens review report. |
| GET | /lenses/{LensAlias}/versionDifference | Get lens version differences. |
| GET | /workloads/{WorkloadId}/milestones/{MilestoneNumber} | Get a milestone for an existing workload. |
| GET | /workloads/{WorkloadId} | Get an existing workload. |
| PATCH | /workloads/{WorkloadId} | Update an existing workload. |
| PUT | /importLens | <p>Import a new custom lens or update an existing custom lens.</p> <p>To update an existing custom lens, specify its ARN as the <code>LensAlias</code>. If no AR |
| GET | /workloads/{WorkloadId}/lensReviews/{LensAlias}/answers | List of answers for a particular workload and lens. |
| POST | /workloads/{WorkloadId}/checks | List of Trusted Advisor check details by account related to the workload. |
| POST | /workloads/{WorkloadId}/checkSummaries | List of Trusted Advisor checks summarized for all accounts related to the workload. |
| GET | /workloads/{WorkloadId}/lensReviews/{LensAlias}/improvements | List lens review improvements. |
| GET | /workloads/{WorkloadId}/lensReviews | List lens reviews for a particular workload. |
| GET | /lenses | List the available lenses. |
| POST | /workloads/{WorkloadId}/milestonesSummaries | List all milestones for an existing workload. |
| POST | /notifications | List lens notifications. |
| GET | /shareInvitations | List the workload invitations. |
| GET | /tags/{WorkloadArn} | <p>List the tags for a resource.</p> <note> <p>The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.</p> </note> |
| POST | /tags/{WorkloadArn} | <p>Adds one or more tags to the specified resource.</p> <note> <p>The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.</p> </note> |
| POST | /workloadsSummaries | Paginated list of workloads. |
| DELETE | /tags/{WorkloadArn}#tagKeys | <p>Deletes specified tags from a resource.</p> <note> <p>The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.</p> </note> <p>To specify |
| PATCH | /global-settings | Updates whether the Amazon Web Services account is opted into organization sharing features. |
| PATCH | /shareInvitations/{ShareInvitationId} | <p>Update a workload or custom lens share invitation.</p> <note> <p>This API operation can be called independently of any resource. Previous documentation impli |
| PATCH | /workloads/{WorkloadId}/shares/{ShareId} | Update a workload share. |
| PUT | /workloads/{WorkloadId}/lensReviews/{LensAlias}/upgrade | Upgrade lens review for a particular workload. |
Questions
Does the AWS Well-Architected Tool API need an API key?
Yes. The AWS Well-Architected Tool API uses API key authentication; the documentation explains how to get credentials.
Does the AWS Well-Architected Tool API support HTTPS?
Yes, the AWS Well-Architected Tool API is served over HTTPS.
How many endpoints does the AWS Well-Architected Tool API have?
Its OpenAPI description lists 43 endpoints in version 2020-03-31. All of them are shown on this page.
What are alternatives to the AWS Well-Architected Tool API?
Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.
Similar cloud platforms APIs
Compare alternatives →Remote Settings PROD
Cloud PlatformsFirefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.
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
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
Vercel API
Cloud PlatformsVercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.
Platform API
Cloud PlatformsThe [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.
Azure Data Lake Storage
Cloud PlatformsAzure Data Lake Storage provides storage for Hadoop and other big data workloads.
Listed from APIs.guru (CC0).