Open documentation ↗Overview
<fullname>DataSync</fullname> <p>DataSync is a managed data transfer service that makes it simpler for you to automate moving data between on-premises storage and Amazon Web Services storage services. You also can use DataSync to transfer data between other cloud providers and Amazon Web Services storage services.</p> <p>This API interface reference includes documentation for using DataSync programmatically. For complete information, see the <i> <a href="https://docs.aws.amazon.com/datasync/latest/userguide/what-is-datasync.html">DataSync User Guide</a> </i>.</p>
AWS DataSync 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
- Category
- Cloud Platforms
- Version
- 2018-11-09
- Endpoints
- 44
- OpenAPI
- Specification ↗
- Spec updated
- 2020-03-11
Endpoints
| Method | Path | What it does |
|---|---|---|
| POST | /#X-Amz-Target=FmrsService.CancelTaskExecution | <p>Stops an DataSync task execution that's in progress. The transfer of some files are abruptly interrupted. File contents that're transferred to the destinatio |
| POST | /#X-Amz-Target=FmrsService.CreateAgent | <p>Activates an DataSync agent that you have deployed in your storage environment. The activation process associates your agent with your account. In the activa |
| POST | /#X-Amz-Target=FmrsService.CreateLocationEfs | Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer. For more information, see <a href="https://docs.aws.amazon.com/datasy |
| POST | /#X-Amz-Target=FmrsService.CreateLocationFsxLustre | Creates an endpoint for an Amazon FSx for Lustre file system. |
| POST | /#X-Amz-Target=FmrsService.CreateLocationFsxOntap | Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer. For more information, see <a href="https://docs.aws. |
| POST | /#X-Amz-Target=FmrsService.CreateLocationFsxOpenZfs | <p>Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can access for a transfer. For more information, see <a href="https://docs.aws.am |
| POST | /#X-Amz-Target=FmrsService.CreateLocationFsxWindows | Creates an endpoint for an Amazon FSx for Windows File Server file system. |
| POST | /#X-Amz-Target=FmrsService.CreateLocationHdfs | Creates an endpoint for a Hadoop Distributed File System (HDFS). |
| POST | /#X-Amz-Target=FmrsService.CreateLocationNfs | Defines a file system on a Network File System (NFS) server that can be read from or written to. |
| POST | /#X-Amz-Target=FmrsService.CreateLocationObjectStorage | Creates an endpoint for an object storage system that DataSync can access for a transfer. For more information, see <a href="https://docs.aws.amazon.com/datasyn |
| POST | /#X-Amz-Target=FmrsService.CreateLocationS3 | Creates an endpoint for an Amazon S3 bucket that DataSync can access for a transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/lat |
| POST | /#X-Amz-Target=FmrsService.CreateLocationSmb | Creates an endpoint for a Server Message Block (SMB) file server that DataSync can access for a transfer. For more information, see <a href="https://docs.aws.am |
| POST | /#X-Amz-Target=FmrsService.CreateTask | <p>Configures a task, which defines where and how DataSync transfers your data.</p> <p>A task includes a source location, a destination location, and the prefer |
| POST | /#X-Amz-Target=FmrsService.DeleteAgent | Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from |
| POST | /#X-Amz-Target=FmrsService.DeleteLocation | Deletes the configuration of a location used by DataSync. |
| POST | /#X-Amz-Target=FmrsService.DeleteTask | Deletes an DataSync task. |
| POST | /#X-Amz-Target=FmrsService.DescribeAgent | Returns metadata about an DataSync agent, such as its name, endpoint type, and status. |
| POST | /#X-Amz-Target=FmrsService.DescribeLocationEfs | Returns metadata about your DataSync location for an Amazon EFS file system. |
| POST | /#X-Amz-Target=FmrsService.DescribeLocationFsxLustre | Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured. |
| POST | /#X-Amz-Target=FmrsService.DescribeLocationFsxOntap | <p>Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.</p> <note> <p>If your location uses SMB, the <c |
| POST | /#X-Amz-Target=FmrsService.DescribeLocationFsxOpenZfs | <p>Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.</p> <note> <p>Response elements related to <code>SMB |
| POST | /#X-Amz-Target=FmrsService.DescribeLocationFsxWindows | Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path. |
| POST | /#X-Amz-Target=FmrsService.DescribeLocationHdfs | Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location. |
| POST | /#X-Amz-Target=FmrsService.DescribeLocationNfs | Returns metadata, such as the path information, about an NFS location. |
| POST | /#X-Amz-Target=FmrsService.DescribeLocationObjectStorage | Returns metadata about your DataSync location for an object storage system. |
| POST | /#X-Amz-Target=FmrsService.DescribeLocationS3 | Returns metadata, such as bucket name, about an Amazon S3 bucket location. |
| POST | /#X-Amz-Target=FmrsService.DescribeLocationSmb | Returns metadata, such as the path and user information about an SMB location. |
| POST | /#X-Amz-Target=FmrsService.DescribeTask | Returns metadata about a task. |
| POST | /#X-Amz-Target=FmrsService.DescribeTaskExecution | Returns detailed metadata about a task that is being executed. |
| POST | /#X-Amz-Target=FmrsService.ListAgents | <p>Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region specified in the request.</p> <p>With pagin |
| POST | /#X-Amz-Target=FmrsService.ListLocations | <p>Returns a list of source and destination locations.</p> <p>If you have more locations than are returned in a response (that is, the response returns only a t |
| POST | /#X-Amz-Target=FmrsService.ListTagsForResource | Returns all the tags associated with an Amazon Web Services resource. |
| POST | /#X-Amz-Target=FmrsService.ListTaskExecutions | Returns a list of executed tasks. |
| POST | /#X-Amz-Target=FmrsService.ListTasks | Returns a list of the DataSync tasks you created. |
| POST | /#X-Amz-Target=FmrsService.StartTaskExecution | <p>Starts an DataSync task. For each task, you can only run one task execution at a time.</p> <p>There are several phases to a task execution. For more informat |
| POST | /#X-Amz-Target=FmrsService.TagResource | <p>Applies a <i>tag</i> to an Amazon Web Services resource. Tags are key-value pairs that can help you manage, filter, and search for your resources.</p> <p>The |
| POST | /#X-Amz-Target=FmrsService.UntagResource | Removes tags from an Amazon Web Services resource. |
| POST | /#X-Amz-Target=FmrsService.UpdateAgent | Updates the name of an agent. |
| POST | /#X-Amz-Target=FmrsService.UpdateLocationHdfs | Updates some parameters of a previously created location for a Hadoop Distributed File System cluster. |
| POST | /#X-Amz-Target=FmrsService.UpdateLocationNfs | Updates some of the parameters of a previously created location for Network File System (NFS) access. For information about creating an NFS location, see <a hre |
| POST | /#X-Amz-Target=FmrsService.UpdateLocationObjectStorage | Updates some parameters of an existing object storage location that DataSync accesses for a transfer. For information about creating a self-managed object stora |
| POST | /#X-Amz-Target=FmrsService.UpdateLocationSmb | Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access. For information about creating an SMB locatio |
| POST | /#X-Amz-Target=FmrsService.UpdateTask | Updates the metadata associated with a task. |
| POST | /#X-Amz-Target=FmrsService.UpdateTaskExecution | <p>Updates execution of a task.</p> <p>You can modify bandwidth throttling for a task execution that is running or queued. For more information, see <a href="ht |
Questions
Does the AWS DataSync API need an API key?
Yes. The AWS DataSync API uses API key authentication; the documentation explains how to get credentials.
Does the AWS DataSync API support HTTPS?
Yes, the AWS DataSync API is served over HTTPS.
How many endpoints does the AWS DataSync API have?
Its OpenAPI description lists 44 endpoints in version 2018-11-09. All of them are shown on this page.
What are alternatives to the AWS DataSync 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).