Skip to content

Amazon WorkDocs API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

<p>The Amazon WorkDocs API is designed for the following use cases:</p> <ul> <li> <p>File Migration: File migration applications are supported for users who want to migrate their files from an on-premises or off-premises file system or service. Users can insert files into a user directory structure, as well as allow for basic metadata changes, such as modifications to the permissions of files.</p> </li> <li> <p>Security: Support security applications are supported for users who have additional security needs, such as antivirus or data loss prevention. The API actions, along with CloudTrail, allow these applications to detect when changes occur in Amazon WorkDocs. Then, the application can take the necessary actions and replace the target file. If the target file violates the policy, the application can also choose to email the user.</p> </li> <li> <p>eDiscovery/Analytics: General administrative applications are supported, such as eDiscovery and analytics. These applications can choose to mimic or record the actions in an Amazon WorkDocs site, along with CloudTrail, to replicate data for eDiscovery, backup, or analytical applications.</p> </li> </ul> <p>All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed. They not only require the use of the Amazon Web Services SDK, but also allow for the exclusive use of IAM users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the Amazon WorkDocs site, the IAM user gains full administrative visibility into the entire Amazon WorkDocs site (or as set in the IAM policy). This includes, but is not limited to, the ability to modify file permissions and upload any file to any user. This allows developers to perform the three use cases above, as well as give users the ability to grant access on a selective basis using the IAM model.</p> <note> <p>The pricing for Amazon WorkDocs APIs varies depending on the API call type for these actions:</p> <ul> <li> <p> <code>READ (Get*)</code> </p> </li> <li> <p> <code>WRITE (Activate*, Add*, Create*, Deactivate*, Initiate*, Update*)</code> </p> </li> <li> <p> <code>LIST (Describe*)</code> </p> </li> <li> <p> <code>DELETE*, CANCEL</code> </p> </li> </ul> <p>For information about Amazon WorkDocs API pricing, see <a href="https://aws.amazon.com/workdocs/pricing/">Amazon WorkDocs Pricing</a>.</p> </note>

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

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2016-05-01
Endpoints
44
Spec updated
2020-03-11

Endpoints

MethodPathWhat it does
GET/api/v1/documents/{DocumentId}/versions/{VersionId}Retrieves version metadata for the specified document.
PATCH/api/v1/documents/{DocumentId}/versions/{VersionId}<p>Changes the status of the document version to ACTIVE. </p> <p>Amazon WorkDocs also sets its document container to ACTIVE. This is the last step in a document
DELETE/api/v1/documents/{DocumentId}/versions/{VersionId}Aborts the upload of the specified document version that was previously initiated by <a>InitiateDocumentVersionUpload</a>. The client should make this call only
POST/api/v1/users/{UserId}/activationActivates the specified user. Only active users can access Amazon WorkDocs.
DELETE/api/v1/users/{UserId}/activationDeactivates the specified user, which revokes the user's access to Amazon WorkDocs.
GET/api/v1/resources/{ResourceId}/permissionsDescribes the permissions of a specified resource.
POST/api/v1/resources/{ResourceId}/permissionsCreates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions
DELETE/api/v1/resources/{ResourceId}/permissionsRemoves all the permissions from the specified resource.
POST/api/v1/documents/{DocumentId}/versions/{VersionId}/commentAdds a new comment to the specified document version.
PUT/api/v1/resources/{ResourceId}/customMetadataAdds one or more custom properties to the specified resource (a folder, document, or version).
DELETE/api/v1/resources/{ResourceId}/customMetadataDeletes custom metadata from the specified resource.
POST/api/v1/foldersCreates a folder with the specified name and parent folder.
PUT/api/v1/resources/{ResourceId}/labelsAdds the specified list of labels to the given resource (a document or folder)
DELETE/api/v1/resources/{ResourceId}/labelsDeletes the specified list of labels from a resource.
GET/api/v1/organizations/{OrganizationId}/subscriptionsLists the specified notification subscriptions.
POST/api/v1/organizations/{OrganizationId}/subscriptions<p>Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription.</p> <p>For more i
GET/api/v1/users<p>Describes the specified users. You can describe all users or filter the results (for example, by status or organization).</p> <p>By default, Amazon WorkDocs
POST/api/v1/usersCreates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is "ACTIVE". New users can access Amazon WorkDocs.
DELETE/api/v1/documents/{DocumentId}/versions/{VersionId}/comment/{CommentId}Deletes the specified comment from the document version.
GET/api/v1/documents/{DocumentId}Retrieves details of a document.
PATCH/api/v1/documents/{DocumentId}Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.
DELETE/api/v1/documents/{DocumentId}Permanently deletes the specified document and its associated metadata.
DELETE/api/v1/documentVersions/{DocumentId}/versions/{VersionId}#deletePriorVersionsDeletes a specific version of a document.
GET/api/v1/folders/{FolderId}Retrieves the metadata of the specified folder.
PATCH/api/v1/folders/{FolderId}Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable.
DELETE/api/v1/folders/{FolderId}Permanently deletes the specified folder and its contents.
GET/api/v1/folders/{FolderId}/contents<p>Describes the contents of the specified folder, including its documents and subfolders.</p> <p>By default, Amazon WorkDocs returns the first 100 active docum
DELETE/api/v1/folders/{FolderId}/contentsDeletes the contents of the specified folder.
DELETE/api/v1/organizations/{OrganizationId}/subscriptions/{SubscriptionId}Deletes the specified subscription from the specified organization.
PATCH/api/v1/users/{UserId}Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.
DELETE/api/v1/users/{UserId}<p>Deletes the specified user from a Simple AD or Microsoft AD directory.</p> <important> <p>Deleting a user immediately and permanently deletes all content in
GET/api/v1/activitiesDescribes the user activities in a specified time period.
GET/api/v1/documents/{DocumentId}/versions/{VersionId}/commentsList all the comments for the specified document version.
GET/api/v1/documents/{DocumentId}/versions<p>Retrieves the document versions for the specified document.</p> <p>By default, only active versions are returned.</p>
GET/api/v1/groups#searchQueryDescribes the groups specified by the query. Groups are defined by the underlying Active Directory.
GET/api/v1/me/root#Authentication<p>Describes the current user's special folders; the <code>RootFolder</code> and the <code>RecycleBin</code>. <code>RootFolder</code> is the root of user's file
GET/api/v1/me#Authentication<p>Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients.</p>
GET/api/v1/documents/{DocumentId}/path<p>Retrieves the path information (the hierarchy from the root folder) for the requested document.</p> <p>By default, Amazon WorkDocs returns a maximum of 100 l
GET/api/v1/folders/{FolderId}/path<p>Retrieves the path information (the hierarchy from the root folder) for the specified folder.</p> <p>By default, Amazon WorkDocs returns a maximum of 100 lev
GET/api/v1/resourcesRetrieves a collection of resources, including folders and documents. The only <code>CollectionType</code> supported is <code>SHARED_WITH_ME</code>.
POST/api/v1/documents<p>Creates a new document object and version object.</p> <p>The client specifies the parent folder ID and name of the document to upload. The ID is optionally s
DELETE/api/v1/resources/{ResourceId}/permissions/{PrincipalId}Removes the permission for the specified principal from the specified resource.
POST/api/v1/documentVersions/restore/{DocumentId}Recovers a deleted version of an Amazon WorkDocs document.
POST/api/v1/searchSearches metadata and the content of folders, documents, document versions, and comments.

Questions

Does the Amazon WorkDocs API need an API key?

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

Does the Amazon WorkDocs API support HTTPS?

Yes, the Amazon WorkDocs API is served over HTTPS.

How many endpoints does the Amazon WorkDocs API have?

Its OpenAPI description lists 44 endpoints in version 2016-05-01. All of them are shown on this page.

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