Skip to content

Amazon FSx API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

Amazon FSx is a fully managed service that makes it easy for storage and application administrators to launch and use shared file storage.

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

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2018-03-01
Endpoints
41
Spec updated
2020-03-26

Endpoints

MethodPathWhat it does
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.AssociateFileSystemAliases<p>Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system. A file system can
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.CancelDataRepositoryTask<p>Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the <code>PENDING</code> or <code>EXECUTING</code> state. When you c
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.CopyBackup<p>Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region (cross-Region copy) or within the same Amazon Web
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.CreateBackup<p>Creates a backup of an existing Amazon FSx for Windows File Server file system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Ama
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.CreateDataRepositoryAssociation<p>Creates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Ama
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.CreateDataRepositoryTaskCreates an Amazon FSx for Lustre data repository task. You use data repository tasks to perform bulk operations between your Amazon FSx file system and its link
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.CreateFileCache<p>Creates a new Amazon File Cache resource.</p> <p>You can use this operation with a client request token in the request that Amazon File Cache uses to ensure
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.CreateFileSystem<p>Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the <code>CreateFileSystem</code> API opera
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.CreateFileSystemFromBackup<p>Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.</p> <p>If
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.CreateSnapshot<p>Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With snapshots, you can easily undo file changes and compare file versions by restoring the
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.CreateStorageVirtualMachineCreates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.CreateVolumeCreates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.CreateVolumeFromBackupCreates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.DeleteBackup<p>Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and its data is gone.</p> <p>The <code>DeleteBackup</code> call returns instantly.
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.DeleteDataRepositoryAssociationDeletes a data repository association on an Amazon FSx for Lustre file system. Deleting the data repository association unlinks the file system from the Amazon
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.DeleteFileCache<p>Deletes an Amazon File Cache resource. After deletion, the cache no longer exists, and its data is gone.</p> <p>The <code>DeleteFileCache</code> operation re
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.DeleteFileSystem<p>Deletes a file system. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups and snapshots are also deleted.
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.DeleteSnapshot<p>Deletes an Amazon FSx for OpenZFS snapshot. After deletion, the snapshot no longer exists, and its data is gone. Deleting a snapshot doesn't affect snapshots
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.DeleteStorageVirtualMachineDeletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior to deleting an SVM, you must delete all non-root volumes in the SVM, otherwise the
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.DeleteVolumeDeletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.DescribeBackups<p>Returns the description of a specific Amazon FSx backup, if a <code>BackupIds</code> value is provided for that backup. Otherwise, it returns all backups own
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.DescribeDataRepositoryAssociations<p>Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if one or more <code>AssociationIds</code> value
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.DescribeDataRepositoryTasks<p>Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository tasks, if one or more <code>TaskIds</code> values are provided
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.DescribeFileCaches<p>Returns the description of a specific Amazon File Cache resource, if a <code>FileCacheIds</code> value is provided for that cache. Otherwise, it returns desc
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.DescribeFileSystemAliasesReturns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of all DNS aliases that have been assoc
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.DescribeFileSystems<p>Returns the description of specific Amazon FSx file systems, if a <code>FileSystemIds</code> value is provided for that file system. Otherwise, it returns de
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.DescribeSnapshots<p>Returns the description of specific Amazon FSx for OpenZFS snapshots, if a <code>SnapshotIds</code> value is provided. Otherwise, this operation returns all
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.DescribeStorageVirtualMachinesDescribes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.DescribeVolumesDescribes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.DisassociateFileSystemAliases<p>Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for Windows File Server file system. If you atte
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.ListTagsForResource<p>Lists tags for Amazon FSx resources.</p> <p>When retrieving all tags, you can optionally specify the <code>MaxResults</code> parameter to limit the number of
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.ReleaseFileSystemNfsV3LocksReleases the file system lock from an Amazon FSx for OpenZFS file system.
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.RestoreVolumeFromSnapshotReturns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot.
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.TagResourceTags an Amazon FSx resource.
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.UntagResourceThis action removes a tag from an Amazon FSx resource.
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.UpdateDataRepositoryAssociationUpdates the configuration of an existing data repository association on an Amazon FSx for Lustre file system. Data repository associations are supported for all
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.UpdateFileCacheUpdates the configuration of an existing Amazon File Cache resource. You can update multiple properties in a single request.
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.UpdateFileSystem<p>Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request.</p> <p>For FSx
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.UpdateSnapshotUpdates the name of an Amazon FSx for OpenZFS snapshot.
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.UpdateStorageVirtualMachineUpdates an Amazon FSx for ONTAP storage virtual machine (SVM).
POST/#X-Amz-Target=AWSSimbaAPIService_v20180301.UpdateVolumeUpdates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.

Questions

Does the Amazon FSx API need an API key?

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

Does the Amazon FSx API support HTTPS?

Yes, the Amazon FSx API is served over HTTPS.

How many endpoints does the Amazon FSx API have?

Its OpenAPI description lists 41 endpoints in version 2018-03-01. All of them are shown on this page.

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