Skip to content

AWS Service Catalog API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

<fullname>Service Catalog</fullname> <p> <a href="http://aws.amazon.com/servicecatalog">Service Catalog</a> enables organizations to create and manage catalogs of IT services that are approved for Amazon Web Services. To get the most out of this documentation, you should be familiar with the terminology discussed in <a href="http://docs.aws.amazon.com/servicecatalog/latest/adminguide/what-is_concepts.html">Service Catalog Concepts</a>.</p>

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

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2015-12-10
Endpoints
90
Spec updated
2020-03-28

Endpoints

MethodPathWhat it does
POST/#X-Amz-Target=AWS242ServiceCatalogService.AcceptPortfolioShareAccepts an offer to share the specified portfolio.
POST/#X-Amz-Target=AWS242ServiceCatalogService.AssociateBudgetWithResourceAssociates the specified budget with the specified resource.
POST/#X-Amz-Target=AWS242ServiceCatalogService.AssociatePrincipalWithPortfolio<p>Associates the specified principal ARN with the specified portfolio.</p> <p>If you share the portfolio with principal name sharing enabled, the <code>Princip
POST/#X-Amz-Target=AWS242ServiceCatalogService.AssociateProductWithPortfolio<p>Associates the specified product with the specified portfolio.</p> <p>A delegated admin is authorized to invoke this command.</p>
POST/#X-Amz-Target=AWS242ServiceCatalogService.AssociateServiceActionWithProvisioningArtifactAssociates a self-service action with a provisioning artifact.
POST/#X-Amz-Target=AWS242ServiceCatalogService.AssociateTagOptionWithResourceAssociate the specified TagOption with the specified portfolio or product.
POST/#X-Amz-Target=AWS242ServiceCatalogService.BatchAssociateServiceActionWithProvisioningArtifactAssociates multiple self-service actions with provisioning artifacts.
POST/#X-Amz-Target=AWS242ServiceCatalogService.BatchDisassociateServiceActionFromProvisioningArtifactDisassociates a batch of self-service actions from the specified provisioning artifact.
POST/#X-Amz-Target=AWS242ServiceCatalogService.CopyProduct<p>Copies the specified source product to the specified target product or a new product.</p> <p>You can copy a product to the same account or another account. Y
POST/#X-Amz-Target=AWS242ServiceCatalogService.CreateConstraint<p>Creates a constraint.</p> <p>A delegated admin is authorized to invoke this command.</p>
POST/#X-Amz-Target=AWS242ServiceCatalogService.CreatePortfolio<p>Creates a portfolio.</p> <p>A delegated admin is authorized to invoke this command.</p>
POST/#X-Amz-Target=AWS242ServiceCatalogService.CreatePortfolioShare<p>Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the management account
POST/#X-Amz-Target=AWS242ServiceCatalogService.CreateProduct<p>Creates a product.</p> <p>A delegated admin is authorized to invoke this command.</p> <p>The user or role that performs this operation must have the <code>cl
POST/#X-Amz-Target=AWS242ServiceCatalogService.CreateProvisionedProductPlan<p>Creates a plan.</p> <p>A plan includes the list of resources to be created (when provisioning a new product) or modified (when updating a provisioned product
POST/#X-Amz-Target=AWS242ServiceCatalogService.CreateProvisioningArtifact<p>Creates a provisioning artifact (also known as a version) for the specified product.</p> <p>You cannot create a provisioning artifact for a product that was
POST/#X-Amz-Target=AWS242ServiceCatalogService.CreateServiceActionCreates a self-service action.
POST/#X-Amz-Target=AWS242ServiceCatalogService.CreateTagOptionCreates a TagOption.
POST/#X-Amz-Target=AWS242ServiceCatalogService.DeleteConstraint<p>Deletes the specified constraint.</p> <p>A delegated admin is authorized to invoke this command.</p>
POST/#X-Amz-Target=AWS242ServiceCatalogService.DeletePortfolio<p>Deletes the specified portfolio.</p> <p>You cannot delete a portfolio if it was shared with you or if it has associated products, users, constraints, or shar
POST/#X-Amz-Target=AWS242ServiceCatalogService.DeletePortfolioShare<p>Stops sharing the specified portfolio with the specified account or organization node. Shares to an organization node can only be deleted by the management a
POST/#X-Amz-Target=AWS242ServiceCatalogService.DeleteProduct<p>Deletes the specified product.</p> <p>You cannot delete a product if it was shared with you or is associated with a portfolio.</p> <p>A delegated admin is au
POST/#X-Amz-Target=AWS242ServiceCatalogService.DeleteProvisionedProductPlanDeletes the specified plan.
POST/#X-Amz-Target=AWS242ServiceCatalogService.DeleteProvisioningArtifact<p>Deletes the specified provisioning artifact (also known as a version) for the specified product.</p> <p>You cannot delete a provisioning artifact associated
POST/#X-Amz-Target=AWS242ServiceCatalogService.DeleteServiceActionDeletes a self-service action.
POST/#X-Amz-Target=AWS242ServiceCatalogService.DeleteTagOption<p>Deletes the specified TagOption.</p> <p>You cannot delete a TagOption if it is associated with a product or portfolio.</p>
POST/#X-Amz-Target=AWS242ServiceCatalogService.DescribeConstraintGets information about the specified constraint.
POST/#X-Amz-Target=AWS242ServiceCatalogService.DescribeCopyProductStatusGets the status of the specified copy product operation.
POST/#X-Amz-Target=AWS242ServiceCatalogService.DescribePortfolio<p>Gets information about the specified portfolio.</p> <p>A delegated admin is authorized to invoke this command.</p>
POST/#X-Amz-Target=AWS242ServiceCatalogService.DescribePortfolioShareStatusGets the status of the specified portfolio share operation. This API can only be called by the management account in the organization or by a delegated admin.
POST/#X-Amz-Target=AWS242ServiceCatalogService.DescribePortfolioShares<p>Returns a summary of each of the portfolio shares that were created for the specified portfolio.</p> <p>You can use this API to determine which accounts or o
POST/#X-Amz-Target=AWS242ServiceCatalogService.DescribeProduct<p>Gets information about the specified product.</p> <note> <p> Running this operation with administrator access results in a failure. <a>DescribeProductAsAdmin
POST/#X-Amz-Target=AWS242ServiceCatalogService.DescribeProductAsAdminGets information about the specified product. This operation is run with administrator access.
POST/#X-Amz-Target=AWS242ServiceCatalogService.DescribeProductViewGets information about the specified product.
POST/#X-Amz-Target=AWS242ServiceCatalogService.DescribeProvisionedProductGets information about the specified provisioned product.
POST/#X-Amz-Target=AWS242ServiceCatalogService.DescribeProvisionedProductPlanGets information about the resource changes for the specified plan.
POST/#X-Amz-Target=AWS242ServiceCatalogService.DescribeProvisioningArtifactGets information about the specified provisioning artifact (also known as a version) for the specified product.
POST/#X-Amz-Target=AWS242ServiceCatalogService.DescribeProvisioningParameters<p>Gets information about the configuration required to provision the specified product using the specified provisioning artifact.</p> <p>If the output contains
POST/#X-Amz-Target=AWS242ServiceCatalogService.DescribeRecord<p>Gets information about the specified request operation.</p> <p>Use this operation after calling a request operation (for example, <a>ProvisionProduct</a>, <a
POST/#X-Amz-Target=AWS242ServiceCatalogService.DescribeServiceActionDescribes a self-service action.
POST/#X-Amz-Target=AWS242ServiceCatalogService.DescribeServiceActionExecutionParametersFinds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user.
POST/#X-Amz-Target=AWS242ServiceCatalogService.DescribeTagOptionGets information about the specified TagOption.
POST/#X-Amz-Target=AWS242ServiceCatalogService.DisableAWSOrganizationsAccess<p>Disable portfolio sharing through the Organizations service. This command will not delete your current shares, but prevents you from creating new shares thro
POST/#X-Amz-Target=AWS242ServiceCatalogService.DisassociateBudgetFromResourceDisassociates the specified budget from the specified resource.
POST/#X-Amz-Target=AWS242ServiceCatalogService.DisassociatePrincipalFromPortfolio<p>Disassociates a previously associated principal ARN from a specified portfolio.</p> <p>The <code>PrincipalType</code> and <code>PrincipalARN</code> must matc
POST/#X-Amz-Target=AWS242ServiceCatalogService.DisassociateProductFromPortfolio<p>Disassociates the specified product from the specified portfolio. </p> <p>A delegated admin is authorized to invoke this command.</p>
POST/#X-Amz-Target=AWS242ServiceCatalogService.DisassociateServiceActionFromProvisioningArtifactDisassociates the specified self-service action association from the specified provisioning artifact.
POST/#X-Amz-Target=AWS242ServiceCatalogService.DisassociateTagOptionFromResourceDisassociates the specified TagOption from the specified resource.
POST/#X-Amz-Target=AWS242ServiceCatalogService.EnableAWSOrganizationsAccess<p>Enable portfolio sharing feature through Organizations. This API will allow Service Catalog to receive updates on your organization in order to sync your sha
POST/#X-Amz-Target=AWS242ServiceCatalogService.ExecuteProvisionedProductPlanProvisions or modifies a product based on the resource changes for the specified plan.
POST/#X-Amz-Target=AWS242ServiceCatalogService.ExecuteProvisionedProductServiceActionExecutes a self-service action against a provisioned product.
POST/#X-Amz-Target=AWS242ServiceCatalogService.GetAWSOrganizationsAccessStatusGet the Access Status for Organizations portfolio share feature. This API can only be called by the management account in the organization or by a delegated adm
POST/#X-Amz-Target=AWS242ServiceCatalogService.GetProvisionedProductOutputsThis API takes either a <code>ProvisonedProductId</code> or a <code>ProvisionedProductName</code>, along with a list of one or more output keys, and responds wi
POST/#X-Amz-Target=AWS242ServiceCatalogService.ImportAsProvisionedProduct<p> Requests the import of a resource as an Service Catalog provisioned product that is associated to an Service Catalog product and provisioning artifact. Once
POST/#X-Amz-Target=AWS242ServiceCatalogService.ListAcceptedPortfolioSharesLists all imported portfolios for which account-to-account shares were accepted by this account. By specifying the <code>PortfolioShareType</code>, you can list
POST/#X-Amz-Target=AWS242ServiceCatalogService.ListBudgetsForResourceLists all the budgets associated to the specified resource.
POST/#X-Amz-Target=AWS242ServiceCatalogService.ListConstraintsForPortfolioLists the constraints for the specified portfolio and product.
POST/#X-Amz-Target=AWS242ServiceCatalogService.ListLaunchPaths<p> Lists the paths to the specified product. A path describes how the user gets access to a specified product and is necessary when provisioning a product. A p
POST/#X-Amz-Target=AWS242ServiceCatalogService.ListOrganizationPortfolioAccess<p>Lists the organization nodes that have access to the specified portfolio. This API can only be called by the management account in the organization or by a d
POST/#X-Amz-Target=AWS242ServiceCatalogService.ListPortfolioAccess<p>Lists the account IDs that have access to the specified portfolio.</p> <p>A delegated admin can list the accounts that have access to the shared portfolio. N
POST/#X-Amz-Target=AWS242ServiceCatalogService.ListPortfoliosLists all portfolios in the catalog.
POST/#X-Amz-Target=AWS242ServiceCatalogService.ListPortfoliosForProductLists all portfolios that the specified product is associated with.
POST/#X-Amz-Target=AWS242ServiceCatalogService.ListPrincipalsForPortfolioLists all <code>PrincipalARN</code>s and corresponding <code>PrincipalType</code>s associated with the specified portfolio.
POST/#X-Amz-Target=AWS242ServiceCatalogService.ListProvisionedProductPlansLists the plans for the specified provisioned product or all plans to which the user has access.
POST/#X-Amz-Target=AWS242ServiceCatalogService.ListProvisioningArtifactsLists all provisioning artifacts (also known as versions) for the specified product.
POST/#X-Amz-Target=AWS242ServiceCatalogService.ListProvisioningArtifactsForServiceActionLists all provisioning artifacts (also known as versions) for the specified self-service action.
POST/#X-Amz-Target=AWS242ServiceCatalogService.ListRecordHistoryLists the specified requests or all performed requests.
POST/#X-Amz-Target=AWS242ServiceCatalogService.ListResourcesForTagOptionLists the resources associated with the specified TagOption.
POST/#X-Amz-Target=AWS242ServiceCatalogService.ListServiceActionsLists all self-service actions.
POST/#X-Amz-Target=AWS242ServiceCatalogService.ListServiceActionsForProvisioningArtifactReturns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.
POST/#X-Amz-Target=AWS242ServiceCatalogService.ListStackInstancesForProvisionedProductReturns summary information about stack instances that are associated with the specified <code>CFN_STACKSET</code> type provisioned product. You can filter for
POST/#X-Amz-Target=AWS242ServiceCatalogService.ListTagOptionsLists the specified TagOptions or all TagOptions.
POST/#X-Amz-Target=AWS242ServiceCatalogService.NotifyProvisionProductEngineWorkflowResultNotifies the result of the provisioning engine execution.
POST/#X-Amz-Target=AWS242ServiceCatalogService.NotifyTerminateProvisionedProductEngineWorkflowResultNotifies the result of the terminate engine execution.
POST/#X-Amz-Target=AWS242ServiceCatalogService.NotifyUpdateProvisionedProductEngineWorkflowResultNotifies the result of the update engine execution.
POST/#X-Amz-Target=AWS242ServiceCatalogService.ProvisionProduct<p> Provisions the specified product. </p> <p> A provisioned product is a resourced instance of a product. For example, provisioning a product that's based on a
POST/#X-Amz-Target=AWS242ServiceCatalogService.RejectPortfolioShareRejects an offer to share the specified portfolio.
POST/#X-Amz-Target=AWS242ServiceCatalogService.ScanProvisionedProducts<p>Lists the provisioned products that are available (not terminated).</p> <p>To use additional filtering, see <a>SearchProvisionedProducts</a>.</p>
POST/#X-Amz-Target=AWS242ServiceCatalogService.SearchProductsGets information about the products to which the caller has access.
POST/#X-Amz-Target=AWS242ServiceCatalogService.SearchProductsAsAdminGets information about the products for the specified portfolio or all products.
POST/#X-Amz-Target=AWS242ServiceCatalogService.SearchProvisionedProductsGets information about the provisioned products that meet the specified criteria.
POST/#X-Amz-Target=AWS242ServiceCatalogService.TerminateProvisionedProduct<p>Terminates the specified provisioned product.</p> <p>This operation does not delete any records associated with the provisioned product.</p> <p>You can check
POST/#X-Amz-Target=AWS242ServiceCatalogService.UpdateConstraintUpdates the specified constraint.
POST/#X-Amz-Target=AWS242ServiceCatalogService.UpdatePortfolio<p>Updates the specified portfolio.</p> <p>You cannot update a product that was shared with you.</p>
POST/#X-Amz-Target=AWS242ServiceCatalogService.UpdatePortfolioShare<p>Updates the specified portfolio share. You can use this API to enable or disable <code>TagOptions</code> sharing or Principal sharing for an existing portfol
POST/#X-Amz-Target=AWS242ServiceCatalogService.UpdateProductUpdates the specified product.
POST/#X-Amz-Target=AWS242ServiceCatalogService.UpdateProvisionedProduct<p>Requests updates to the configuration of the specified provisioned product.</p> <p>If there are tags associated with the object, they cannot be updated or ad
POST/#X-Amz-Target=AWS242ServiceCatalogService.UpdateProvisionedProductPropertiesRequests updates to the properties of the specified provisioned product.
POST/#X-Amz-Target=AWS242ServiceCatalogService.UpdateProvisioningArtifact<p>Updates the specified provisioning artifact (also known as a version) for the specified product.</p> <p>You cannot update a provisioning artifact for a produ
POST/#X-Amz-Target=AWS242ServiceCatalogService.UpdateServiceActionUpdates a self-service action.
POST/#X-Amz-Target=AWS242ServiceCatalogService.UpdateTagOptionUpdates the specified TagOption.

Questions

Does the AWS Service Catalog API need an API key?

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

Does the AWS Service Catalog API support HTTPS?

Yes, the AWS Service Catalog API is served over HTTPS.

How many endpoints does the AWS Service Catalog API have?

Its OpenAPI description lists 90 endpoints in version 2015-12-10. All of them are shown on this page.

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