Skip to content

AWS Proton API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

<p>This is the Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the <a href="https://docs.aws.amazon.com/proton/latest/APIReference/API_Operations.html">actions</a> and <a href="https://docs.aws.amazon.com/proton/latest/APIReference/API_Types.html">data types</a> for the Proton service.</p> <p>The documentation for each action shows the Query API request parameters and the XML response.</p> <p>Alternatively, you can use the Amazon Web Services CLI to access an API. For more information, see the <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html">Amazon Web Services Command Line Interface User Guide</a>.</p> <p>The Proton service is a two-pronged automation framework. Administrators create service templates to provide standardized infrastructure and deployment tooling for serverless and container based applications. Developers, in turn, select from the available service templates to automate their application or service deployments.</p> <p>Because administrators define the infrastructure and tooling that Proton deploys and manages, they need permissions to use all of the listed API operations.</p> <p>When developers select a specific infrastructure and tooling set, Proton deploys their applications. To monitor their applications that are running on Proton, developers need permissions to the service <i>create</i>, <i>list</i>, <i>update</i> and <i>delete</i> API operations and the service instance <i>list</i> and <i>update</i> API operations.</p> <p>To learn more about Proton, see the <a href="https://docs.aws.amazon.com/proton/latest/userguide/Welcome.html">Proton User Guide</a>.</p> <p> <b>Ensuring Idempotency</b> </p> <p>When you make a mutating API request, the request typically returns a result before the asynchronous workflows of the operation are complete. Operations might also time out or encounter other server issues before they're complete, even if the request already returned a result. This might make it difficult to determine whether the request succeeded. Moreover, you might need to retry the request multiple times to ensure that the operation completes successfully. However, if the original request and the subsequent retries are successful, the operation occurs multiple times. This means that you might create more resources than you intended.</p> <p> <i>Idempotency</i> ensures that an API request action completes no more than one time. With an idempotent request, if the original request action completes successfully, any subsequent retries complete successfully without performing any further actions. However, the result might contain updated information, such as the current creation status.</p> <p>The following lists of APIs are grouped according to methods that ensure idempotency.</p> <p> <b>Idempotent create APIs with a client token</b> </p> <p>The API actions in this list support idempotency with the use of a <i>client token</i>. The corresponding Amazon Web Services CLI commands also support idempotency using a client token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, specify a client token in the request. We recommend that you <i>don't</i> reuse the same client token for other API requests. If you don’t provide a client token for these APIs, a default client token is automatically provided by SDKs.</p> <p>Given a request action that has succeeded:</p> <p>If you retry the request using the same client token and the same parameters, the retry succeeds without performing any further actions other than returning the original resource detail data in the response.</p> <p>If you retry the request using the same client token, but one or more of the parameters are different, the retry throws a <code>ValidationException</code> with an <code>IdempotentParameterMismatch</code> error.</p> <p>Client tokens expire eight hours after a request is made. If yo

AWS Proton is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 84 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2020-07-20
Endpoints
84
Spec updated
2021-06-18

Endpoints

MethodPathWhat it does
POST/#X-Amz-Target=AwsProton20200720.AcceptEnvironmentAccountConnection<p>In a management account, an environment account connection request is accepted. When the environment account connection request is accepted, Proton can use t
POST/#X-Amz-Target=AwsProton20200720.CancelComponentDeployment<p>Attempts to cancel a component deployment (for a component that is in the <code>IN_PROGRESS</code> deployment status).</p> <p>For more information about comp
POST/#X-Amz-Target=AwsProton20200720.CancelEnvironmentDeployment<p>Attempts to cancel an environment deployment on an <a>UpdateEnvironment</a> action, if the deployment is <code>IN_PROGRESS</code>. For more information, see
POST/#X-Amz-Target=AwsProton20200720.CancelServiceInstanceDeployment<p>Attempts to cancel a service instance deployment on an <a>UpdateServiceInstance</a> action, if the deployment is <code>IN_PROGRESS</code>. For more informati
POST/#X-Amz-Target=AwsProton20200720.CancelServicePipelineDeployment<p>Attempts to cancel a service pipeline deployment on an <a>UpdateServicePipeline</a> action, if the deployment is <code>IN_PROGRESS</code>. For more informati
POST/#X-Amz-Target=AwsProton20200720.CreateComponent<p>Create an Proton component. A component is an infrastructure extension for a service instance.</p> <p>For more information about components, see <a href="htt
POST/#X-Amz-Target=AwsProton20200720.CreateEnvironment<p>Deploy a new environment. An Proton environment is created from an environment template that defines infrastructure and resources that can be shared across s
POST/#X-Amz-Target=AwsProton20200720.CreateEnvironmentAccountConnection<p>Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the environment account
POST/#X-Amz-Target=AwsProton20200720.CreateEnvironmentTemplate<p>Create an environment template for Proton. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-templates.html">Environm
POST/#X-Amz-Target=AwsProton20200720.CreateEnvironmentTemplateVersionCreate a new major or minor version of an environment template. A major version of an environment template is a version that <i>isn't</i> backwards compatible.
POST/#X-Amz-Target=AwsProton20200720.CreateRepository<p>Create and register a link to a repository. Proton uses the link to repeatedly access the repository, to either push to it (self-managed provisioning) or pul
POST/#X-Amz-Target=AwsProton20200720.CreateServiceCreate an Proton service. An Proton service is an instantiation of a service template and often includes several service instances and pipeline. For more inform
POST/#X-Amz-Target=AwsProton20200720.CreateServiceInstanceCreate a service instance.
POST/#X-Amz-Target=AwsProton20200720.CreateServiceSyncConfigCreate the Proton Ops configuration file.
POST/#X-Amz-Target=AwsProton20200720.CreateServiceTemplateCreate a service template. The administrator creates a service template to define standardized infrastructure and an optional CI/CD service pipeline. Developers
POST/#X-Amz-Target=AwsProton20200720.CreateServiceTemplateVersionCreate a new major or minor version of a service template. A major version of a service template is a version that <i>isn't</i> backward compatible. A minor ver
POST/#X-Amz-Target=AwsProton20200720.CreateTemplateSyncConfig<p>Set up a template to create new template versions automatically by tracking a linked repository. A linked repository is a repository that has been registered
POST/#X-Amz-Target=AwsProton20200720.DeleteComponent<p>Delete an Proton component resource.</p> <p>For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-compon
POST/#X-Amz-Target=AwsProton20200720.DeleteEnvironmentDelete an environment.
POST/#X-Amz-Target=AwsProton20200720.DeleteEnvironmentAccountConnection<p>In an environment account, delete an environment account connection.</p> <p>After you delete an environment account connection that’s in use by an Proton env
POST/#X-Amz-Target=AwsProton20200720.DeleteEnvironmentTemplateIf no other major or minor versions of an environment template exist, delete the environment template.
POST/#X-Amz-Target=AwsProton20200720.DeleteEnvironmentTemplateVersion<p>If no other minor versions of an environment template exist, delete a major version of the environment template if it's not the <code>Recommended</code> vers
POST/#X-Amz-Target=AwsProton20200720.DeleteRepositoryDe-register and unlink your repository.
POST/#X-Amz-Target=AwsProton20200720.DeleteService<p>Delete a service, with its instances and pipeline.</p> <note> <p>You can't delete a service if it has any service instances that have components attached to
POST/#X-Amz-Target=AwsProton20200720.DeleteServiceSyncConfigDelete the Proton Ops file.
POST/#X-Amz-Target=AwsProton20200720.DeleteServiceTemplateIf no other major or minor versions of the service template exist, delete the service template.
POST/#X-Amz-Target=AwsProton20200720.DeleteServiceTemplateVersion<p>If no other minor versions of a service template exist, delete a major version of the service template if it's not the <code>Recommended</code> version. Dele
POST/#X-Amz-Target=AwsProton20200720.DeleteTemplateSyncConfigDelete a template sync configuration.
POST/#X-Amz-Target=AwsProton20200720.GetAccountSettingsGet detail data for Proton account-wide settings.
POST/#X-Amz-Target=AwsProton20200720.GetComponent<p>Get detailed data for a component.</p> <p>For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-componen
POST/#X-Amz-Target=AwsProton20200720.GetEnvironmentGet detailed data for an environment.
POST/#X-Amz-Target=AwsProton20200720.GetEnvironmentAccountConnection<p>In an environment account, get the detailed data for an environment account connection.</p> <p>For more information, see <a href="https://docs.aws.amazon.com
POST/#X-Amz-Target=AwsProton20200720.GetEnvironmentTemplateGet detailed data for an environment template.
POST/#X-Amz-Target=AwsProton20200720.GetEnvironmentTemplateVersionGet detailed data for a major or minor version of an environment template.
POST/#X-Amz-Target=AwsProton20200720.GetRepositoryGet detail data for a linked repository.
POST/#X-Amz-Target=AwsProton20200720.GetRepositorySyncStatus<p>Get the sync status of a repository used for Proton template sync. For more information about template sync, see .</p> <note> <p>A repository sync status isn
POST/#X-Amz-Target=AwsProton20200720.GetResourcesSummary<p>Get counts of Proton resources.</p> <p>For infrastructure-provisioning resources (environments, services, service instances, pipelines), the action returns s
POST/#X-Amz-Target=AwsProton20200720.GetServiceGet detailed data for a service.
POST/#X-Amz-Target=AwsProton20200720.GetServiceInstanceGet detailed data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment.
POST/#X-Amz-Target=AwsProton20200720.GetServiceInstanceSyncStatusGet the status of the synced service instance.
POST/#X-Amz-Target=AwsProton20200720.GetServiceSyncBlockerSummaryGet detailed data for the service sync blocker summary.
POST/#X-Amz-Target=AwsProton20200720.GetServiceSyncConfigGet detailed information for the service sync configuration.
POST/#X-Amz-Target=AwsProton20200720.GetServiceTemplateGet detailed data for a service template.
POST/#X-Amz-Target=AwsProton20200720.GetServiceTemplateVersionGet detailed data for a major or minor version of a service template.
POST/#X-Amz-Target=AwsProton20200720.GetTemplateSyncConfigGet detail data for a template sync configuration.
POST/#X-Amz-Target=AwsProton20200720.GetTemplateSyncStatusGet the status of a template sync.
POST/#X-Amz-Target=AwsProton20200720.ListComponentOutputs<p>Get a list of component Infrastructure as Code (IaC) outputs.</p> <p>For more information about components, see <a href="https://docs.aws.amazon.com/proton/l
POST/#X-Amz-Target=AwsProton20200720.ListComponentProvisionedResources<p>List provisioned resources for a component with details.</p> <p>For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest
POST/#X-Amz-Target=AwsProton20200720.ListComponents<p>List components with summary data. You can filter the result list by environment, service, or a single service instance.</p> <p>For more information about co
POST/#X-Amz-Target=AwsProton20200720.ListEnvironmentAccountConnections<p>View a list of environment account connections.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-
POST/#X-Amz-Target=AwsProton20200720.ListEnvironmentOutputsList the infrastructure as code outputs for your environment.
POST/#X-Amz-Target=AwsProton20200720.ListEnvironmentProvisionedResourcesList the provisioned resources for your environment.
POST/#X-Amz-Target=AwsProton20200720.ListEnvironmentTemplateVersionsList major or minor versions of an environment template with detail data.
POST/#X-Amz-Target=AwsProton20200720.ListEnvironmentTemplatesList environment templates.
POST/#X-Amz-Target=AwsProton20200720.ListEnvironmentsList environments with detail data summaries.
POST/#X-Amz-Target=AwsProton20200720.ListRepositoriesList linked repositories with detail data.
POST/#X-Amz-Target=AwsProton20200720.ListRepositorySyncDefinitionsList repository sync definitions with detail data.
POST/#X-Amz-Target=AwsProton20200720.ListServiceInstanceOutputsGet a list service of instance Infrastructure as Code (IaC) outputs.
POST/#X-Amz-Target=AwsProton20200720.ListServiceInstanceProvisionedResourcesList provisioned resources for a service instance with details.
POST/#X-Amz-Target=AwsProton20200720.ListServiceInstancesList service instances with summary data. This action lists service instances of all services in the Amazon Web Services account.
POST/#X-Amz-Target=AwsProton20200720.ListServicePipelineOutputsGet a list of service pipeline Infrastructure as Code (IaC) outputs.
POST/#X-Amz-Target=AwsProton20200720.ListServicePipelineProvisionedResourcesList provisioned resources for a service and pipeline with details.
POST/#X-Amz-Target=AwsProton20200720.ListServiceTemplateVersionsList major or minor versions of a service template with detail data.
POST/#X-Amz-Target=AwsProton20200720.ListServiceTemplatesList service templates with detail data.
POST/#X-Amz-Target=AwsProton20200720.ListServicesList services with summaries of detail data.
POST/#X-Amz-Target=AwsProton20200720.ListTagsForResourceList tags for a resource. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a
POST/#X-Amz-Target=AwsProton20200720.NotifyResourceDeploymentStatusChange<p>Notify Proton of status changes to a provisioned resource when you use self-managed provisioning.</p> <p>For more information, see <a href="https://docs.aws.
POST/#X-Amz-Target=AwsProton20200720.RejectEnvironmentAccountConnection<p>In a management account, reject an environment account connection from another environment account.</p> <p>After you reject an environment account connection
POST/#X-Amz-Target=AwsProton20200720.TagResource<p>Tag a resource. A tag is a key-value pair of metadata that you associate with an Proton resource.</p> <p>For more information, see <a href="https://docs.aws.
POST/#X-Amz-Target=AwsProton20200720.UntagResource<p>Remove a customer tag from a resource. A tag is a key-value pair of metadata associated with an Proton resource.</p> <p>For more information, see <a href="ht
POST/#X-Amz-Target=AwsProton20200720.UpdateAccountSettingsUpdate Proton settings that are used for multiple services in the Amazon Web Services account.
POST/#X-Amz-Target=AwsProton20200720.UpdateComponent<p>Update a component.</p> <p>There are a few modes for updating a component. The <code>deploymentType</code> field defines the mode.</p> <note> <p>You can't up
POST/#X-Amz-Target=AwsProton20200720.UpdateEnvironment<p>Update an environment.</p> <p>If the environment is associated with an environment account connection, <i>don't</i> update or include the <code>protonService
POST/#X-Amz-Target=AwsProton20200720.UpdateEnvironmentAccountConnection<p>In an environment account, update an environment account connection to use a new IAM role.</p> <p>For more information, see <a href="https://docs.aws.amazon.
POST/#X-Amz-Target=AwsProton20200720.UpdateEnvironmentTemplateUpdate an environment template.
POST/#X-Amz-Target=AwsProton20200720.UpdateEnvironmentTemplateVersionUpdate a major or minor version of an environment template.
POST/#X-Amz-Target=AwsProton20200720.UpdateService<p>Edit a service description or use a spec to add and delete service instances.</p> <note> <p>Existing service instances and the service pipeline <i>can't</i>
POST/#X-Amz-Target=AwsProton20200720.UpdateServiceInstance<p>Update a service instance.</p> <p>There are a few modes for updating a service instance. The <code>deploymentType</code> field defines the mode.</p> <note> <
POST/#X-Amz-Target=AwsProton20200720.UpdateServicePipeline<p>Update the service pipeline.</p> <p>There are four modes for updating a service pipeline. The <code>deploymentType</code> field defines the mode.</p> <dl> <d
POST/#X-Amz-Target=AwsProton20200720.UpdateServiceSyncBlockerUpdate the service sync blocker by resolving it.
POST/#X-Amz-Target=AwsProton20200720.UpdateServiceSyncConfigUpdate the Proton Ops config file.
POST/#X-Amz-Target=AwsProton20200720.UpdateServiceTemplateUpdate a service template.
POST/#X-Amz-Target=AwsProton20200720.UpdateServiceTemplateVersionUpdate a major or minor version of a service template.
POST/#X-Amz-Target=AwsProton20200720.UpdateTemplateSyncConfigUpdate template sync configuration parameters, except for the <code>templateName</code> and <code>templateType</code>. Repository details (branch, name, and pro

Questions

Does the AWS Proton API need an API key?

Yes. The AWS Proton API uses API key authentication; the documentation explains how to get credentials.

Does the AWS Proton API support HTTPS?

Yes, the AWS Proton API is served over HTTPS.

How many endpoints does the AWS Proton API have?

Its OpenAPI description lists 84 endpoints in version 2020-07-20. All of them are shown on this page.

What are alternatives to the AWS Proton 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).