Open documentation ↗Overview
<fullname>Amazon Cloud Directory</fullname> <p>Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of cloud-scale web, mobile, and IoT applications. This guide describes the Cloud Directory operations that you can call programmatically and includes detailed information on data types and errors. For information about Cloud Directory features, see <a href="https://aws.amazon.com/directoryservice/">AWS Directory Service</a> and the <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/what_is_cloud_directory.html">Amazon Cloud Directory Developer Guide</a>.</p>
Amazon CloudDirectory is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 66 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Version
- 2017-01-11
- Endpoints
- 66
- OpenAPI
- Specification ↗
- Spec updated
- 2020-03-11
Endpoints
| Method | Path | What it does |
|---|---|---|
| PUT | /amazonclouddirectory/2017-01-11/object/facets#x-amz-data-partition | Adds a new <a>Facet</a> to an object. An object can have more than one facet applied on it. |
| PUT | /amazonclouddirectory/2017-01-11/schema/apply#x-amz-data-partition | Copies the input published schema, at the specified version, into the <a>Directory</a> with the same name and version as that of the published schema. |
| PUT | /amazonclouddirectory/2017-01-11/object/attach#x-amz-data-partition | <p>Attaches an existing object to another object. An object can be accessed in two ways:</p> <ol> <li> <p>Using the path</p> </li> <li> <p>Using <code>ObjectIde |
| PUT | /amazonclouddirectory/2017-01-11/policy/attach#x-amz-data-partition | Attaches a policy object to a regular object. An object can have a limited number of attached policies. |
| PUT | /amazonclouddirectory/2017-01-11/index/attach#x-amz-data-partition | Attaches the specified object to the specified index. |
| PUT | /amazonclouddirectory/2017-01-11/typedlink/attach#x-amz-data-partition | Attaches a typed link to a specified source and target object. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developergui |
| POST | /amazonclouddirectory/2017-01-11/batchread#x-amz-data-partition | Performs all the read operations in a batch. |
| PUT | /amazonclouddirectory/2017-01-11/batchwrite#x-amz-data-partition | Performs all the write operations in a batch. Either all the operations succeed or none. |
| PUT | /amazonclouddirectory/2017-01-11/directory/create#x-amz-data-partition | <p>Creates a <a>Directory</a> by copying the published schema into the directory. A directory cannot be created without a schema.</p> <p>You can also quickly cr |
| PUT | /amazonclouddirectory/2017-01-11/facet/create#x-amz-data-partition | Creates a new <a>Facet</a> in a schema. Facet creation is allowed only in development or applied schemas. |
| PUT | /amazonclouddirectory/2017-01-11/index#x-amz-data-partition | Creates an index object. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.html">Indexing and search</a> for more in |
| PUT | /amazonclouddirectory/2017-01-11/object#x-amz-data-partition | Creates an object in a <a>Directory</a>. Additionally attaches the object to a parent, if a parent reference and <code>LinkName</code> is specified. An object i |
| PUT | /amazonclouddirectory/2017-01-11/schema/create | <p>Creates a new schema in a development state. A schema can exist in three phases:</p> <ul> <li> <p> <i>Development:</i> This is a mutable phase of the schema. |
| PUT | /amazonclouddirectory/2017-01-11/typedlink/facet/create#x-amz-data-partition | Creates a <a>TypedLinkFacet</a>. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.htm |
| PUT | /amazonclouddirectory/2017-01-11/directory#x-amz-data-partition | Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories. |
| PUT | /amazonclouddirectory/2017-01-11/facet/delete#x-amz-data-partition | Deletes a given <a>Facet</a>. All attributes and <a>Rule</a>s that are associated with the facet will be deleted. Only development schema facets are allowed del |
| PUT | /amazonclouddirectory/2017-01-11/object/delete#x-amz-data-partition | Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted. The maximum number of attributes that can be delet |
| PUT | /amazonclouddirectory/2017-01-11/schema#x-amz-data-partition | Deletes a given schema. Schemas in a development and published state can only be deleted. |
| PUT | /amazonclouddirectory/2017-01-11/typedlink/facet/delete#x-amz-data-partition | Deletes a <a>TypedLinkFacet</a>. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.htm |
| PUT | /amazonclouddirectory/2017-01-11/index/detach#x-amz-data-partition | Detaches the specified object from the specified index. |
| PUT | /amazonclouddirectory/2017-01-11/object/detach#x-amz-data-partition | Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name. |
| PUT | /amazonclouddirectory/2017-01-11/policy/detach#x-amz-data-partition | Detaches a policy from an object. |
| PUT | /amazonclouddirectory/2017-01-11/typedlink/detach#x-amz-data-partition | Detaches a typed link from a specified source and target object. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerg |
| PUT | /amazonclouddirectory/2017-01-11/directory/disable#x-amz-data-partition | Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reena |
| PUT | /amazonclouddirectory/2017-01-11/directory/enable#x-amz-data-partition | Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to. |
| POST | /amazonclouddirectory/2017-01-11/schema/getappliedschema | Returns current applied schema version ARN, including the minor version in use. |
| POST | /amazonclouddirectory/2017-01-11/directory/get#x-amz-data-partition | Retrieves metadata about a directory. |
| POST | /amazonclouddirectory/2017-01-11/facet#x-amz-data-partition | Gets details of the <a>Facet</a>, such as facet name, attributes, <a>Rule</a>s, or <code>ObjectType</code>. You can call this on all kinds of schema facets -- p |
| PUT | /amazonclouddirectory/2017-01-11/facet#x-amz-data-partition | <p>Does the following:</p> <ol> <li> <p>Adds new <code>Attributes</code>, <code>Rules</code>, or <code>ObjectTypes</code>.</p> </li> <li> <p>Updates existing <c |
| POST | /amazonclouddirectory/2017-01-11/typedlink/attributes/get#x-amz-data-partition | Retrieves attributes that are associated with a typed link. |
| POST | /amazonclouddirectory/2017-01-11/object/attributes/get#x-amz-data-partition | Retrieves attributes within a facet that are associated with an object. |
| POST | /amazonclouddirectory/2017-01-11/object/information#x-amz-data-partition | Retrieves metadata about an object. |
| POST | /amazonclouddirectory/2017-01-11/schema/json#x-amz-data-partition | Retrieves a JSON representation of the schema. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_jsonformat.html#schemas_jso |
| PUT | /amazonclouddirectory/2017-01-11/schema/json#x-amz-data-partition | Allows a schema to be updated using JSON upload. Only available for development schemas. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/develope |
| POST | /amazonclouddirectory/2017-01-11/typedlink/facet/get#x-amz-data-partition | Returns the identity attribute order for a specific <a>TypedLinkFacet</a>. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/ |
| POST | /amazonclouddirectory/2017-01-11/schema/applied | Lists schema major versions applied to a directory. If <code>SchemaArn</code> is provided, lists the minor version. |
| POST | /amazonclouddirectory/2017-01-11/object/indices#x-amz-data-partition | Lists indices attached to the specified object. |
| POST | /amazonclouddirectory/2017-01-11/schema/development | Retrieves each Amazon Resource Name (ARN) of schemas in the development state. |
| POST | /amazonclouddirectory/2017-01-11/directory/list | Lists directories created within an account. |
| POST | /amazonclouddirectory/2017-01-11/facet/attributes#x-amz-data-partition | Retrieves attributes attached to the facet. |
| POST | /amazonclouddirectory/2017-01-11/facet/list#x-amz-data-partition | Retrieves the names of facets that exist in a schema. |
| POST | /amazonclouddirectory/2017-01-11/typedlink/incoming#x-amz-data-partition | Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity at |
| POST | /amazonclouddirectory/2017-01-11/index/targets#x-amz-data-partition | Lists objects attached to the specified index. |
| POST | /amazonclouddirectory/2017-01-11/schema/managed | Lists the major version families of each managed schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed |
| POST | /amazonclouddirectory/2017-01-11/object/attributes#x-amz-data-partition | Lists all attributes that are associated with an object. |
| POST | /amazonclouddirectory/2017-01-11/object/children#x-amz-data-partition | Returns a paginated list of child objects that are associated with a given object. |
| POST | /amazonclouddirectory/2017-01-11/object/parentpaths#x-amz-data-partition | <p>Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, se |
| POST | /amazonclouddirectory/2017-01-11/object/parent#x-amz-data-partition | Lists parent objects that are associated with a given object in pagination fashion. |
| POST | /amazonclouddirectory/2017-01-11/object/policy#x-amz-data-partition | Returns policies attached to an object in pagination fashion. |
| POST | /amazonclouddirectory/2017-01-11/typedlink/outgoing#x-amz-data-partition | Returns a paginated list of all the outgoing <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity at |
| POST | /amazonclouddirectory/2017-01-11/policy/attachment#x-amz-data-partition | Returns all of the <code>ObjectIdentifiers</code> to which a given policy is attached. |
| POST | /amazonclouddirectory/2017-01-11/schema/published | Lists the major version families of each published schema. If a major version ARN is provided as <code>SchemaArn</code>, the minor version revisions in that fam |
| POST | /amazonclouddirectory/2017-01-11/tags | Returns tags for a resource. Tagging is currently supported only for directories with a limit of 50 tags per directory. All 50 tags are returned for a given dir |
| POST | /amazonclouddirectory/2017-01-11/typedlink/facet/attributes#x-amz-data-partition | Returns a paginated list of all attribute definitions for a particular <a>TypedLinkFacet</a>. For more information, see <a href="https://docs.aws.amazon.com/clo |
| POST | /amazonclouddirectory/2017-01-11/typedlink/facet/list#x-amz-data-partition | Returns a paginated list of <code>TypedLink</code> facet names for a particular schema. For more information, see <a href="https://docs.aws.amazon.com/clouddire |
| POST | /amazonclouddirectory/2017-01-11/policy/lookup#x-amz-data-partition | Lists all policies from the root of the <a>Directory</a> to the object specified. If there are no policies present, an empty list is returned. If policies are p |
| PUT | /amazonclouddirectory/2017-01-11/schema/publish#x-amz-data-partition | Publishes a development schema with a major version and a recommended minor version. |
| PUT | /amazonclouddirectory/2017-01-11/object/facets/delete#x-amz-data-partition | Removes the specified facet from the specified object. |
| PUT | /amazonclouddirectory/2017-01-11/tags/add | An API operation for adding tags to a resource. |
| PUT | /amazonclouddirectory/2017-01-11/tags/remove | An API operation for removing tags from a resource. |
| POST | /amazonclouddirectory/2017-01-11/typedlink/attributes/update#x-amz-data-partition | Updates a given typed link’s attributes. Attributes to be updated must not contribute to the typed link’s identity, as defined by its <code>IdentityAttributeOrd |
| PUT | /amazonclouddirectory/2017-01-11/object/update#x-amz-data-partition | Updates a given object's attributes. |
| PUT | /amazonclouddirectory/2017-01-11/schema/update#x-amz-data-partition | Updates the schema name with a new name. Only development schema names can be updated. |
| PUT | /amazonclouddirectory/2017-01-11/typedlink/facet#x-amz-data-partition | Updates a <a>TypedLinkFacet</a>. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.htm |
| PUT | /amazonclouddirectory/2017-01-11/schema/upgradeapplied | Upgrades a single directory in-place using the <code>PublishedSchemaArn</code> with schema updates found in <code>MinorVersion</code>. Backwards-compatible mino |
| PUT | /amazonclouddirectory/2017-01-11/schema/upgradepublished | Upgrades a published schema under a new minor version revision using the current contents of <code>DevelopmentSchemaArn</code>. |
Questions
Does the Amazon CloudDirectory API need an API key?
Yes. The Amazon CloudDirectory API uses API key authentication; the documentation explains how to get credentials.
Does the Amazon CloudDirectory API support HTTPS?
Yes, the Amazon CloudDirectory API is served over HTTPS.
How many endpoints does the Amazon CloudDirectory API have?
Its OpenAPI description lists 66 endpoints in version 2017-01-11. All of them are shown on this page.
What are alternatives to the Amazon CloudDirectory 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).