Description

IBM Aspera on Cloud is a cloud-based data transfer service that enables high-speed, secure, and reliable transfer of large files and data sets over the internet. It uses advanced encryption and data compression techniques to transfer data quickly and securely, regardless of the distance or network conditions.

Aspera on Cloud is designed for businesses of all sizes and industries, including media and entertainment, healthcare, and government.

IBM Aspera on Cloud provides a web-based interface and RESTful APIs that enable easy integration with other cloud-based applications and services. It also offers advanced features such as bandwidth control, file verification, and automatic retry to ensure efficient and secure transfer of large files and data sets.

Supported Operations

Files API

Get a Listing of App Memberships

Get a listing of app memberships. For organization admins, all app memberships for the entire organization are available to view. For all other users, your own app memberships are available.

Get Information About a Specific App Membership

Get information about a specific app membership, specified by membership ID.

Delete a Specific App Membership

Delete an app membership, specified by membership ID. Requires organization admin permission.

Create a New App Membership

Create an app membership. Requires organization admin permission.

Get a Listing of Client Access Keys

Get a listing of client access keys for your organization.

Register a New Client Access Key with Aspera on Cloud

Create a client access key.

Get Information About a Specific Client Access Key

Get information about a specific client access key, specified by ID.

Update the Name of a Client Access Key

Update the name of a client access key.

Delete a Specific Client Access Key

Delete a client access key, specified by ID.

Get a Listing of Information on all Client Whitelists

Get a listing of information on all client whitelists.

Create a New Authorization

Create an authorization for an API client. Each entity to authorize requires a separate request.

Get Information on Entities in a Whitelist for a Specific Client

Retrieve a listing with information on all entities in the whitelist for a specific client.

Delete a User from a Client Whitelist

Delete a user from a client whitelist.

Get a Listing of All Registered Clients

Get a listing of clients currently registered to use the Aspera on Cloud API.

Register a New Client with the Files API

Create an API client.

Get Information about a Specific Registered Client

Get information about a specific registered client, specified by the client ID returned in the GET response.

Modify a Registered Client

Update a registered client. For example, change the redirect URI and the admin node token retrieval parameters.

Delete a Specific Registered Client

Delete a registered client, specified by client ID.

Get a Listing of All Dropbox Members

Get a listing of information about the current members of a given dropbox.

Add a Dropbox Member

Add a user or group as a member of this dropbox.

Get Information on a Specific Dropbox Membership

Get information on a specific dropbox membership.

Update a Dropbox Membership

Update an existing dropbox membership.

Remove a Member from a Dropbox

Remove a direct dropbox membership. Note: If the user also has indirect membership through a group, the user will still have access to the dropbox.

Get a Listing of All Shared Inboxes

Retrieve a listing of all shared inboxes.

Create a New Shared Inbox

Create a new shared inbox.

Get Information on a Specific Shared Inbox

Retrieve information on a specific shared inbox.

Update a Shared Inbox

Make changes to an existing shared inbox.

Delete a Specific Shared Inbox

Delete a specific shared inbox, specified by shared inbox ID.

Get a Listing of All Nodes

Get information about all transfer nodes belonging to your organization.

Create a New Node

Create a new transfer node. User must be an organization admin.

Get Information on a Specific Node

Retrieve information about a specific transfer node.

Update a Node

Make changes to an existing transfer node. User must be an organization admin.

Delete a Specific Node

Delete a specific transfer node, as specified by node ID. User must be an organization admin.

Get Information About Your Organization

Retrieve information about your organization.

Update Your Organization

Make changes to your organization. Must be an organization admin to access.

Get a Listing of All Packages

Get information about all packages or retrieve packages sent to me in a specific workspace, sent to me as individual (not as a member of a dropbox), that are not archived and not deleted if the user ID is included in the token sent with the call.

Create Package to Send

Recipient can be an individual user, workspace, or a dropbox.

Get Information on a Specific Package

Get information on a specific package.

Update a package

Use the PUT method to mark the package "sent=true", including the proper number of transfers in the "transfers_expected" field, after the transfers have completed. The number of transfers expected depends on the number of discrete source locations of package contents.

Delete a Specific Package

Use package_id to delete the contents of a specific package. This action removes package contents permanently, but retains information on the package: sender, recipients, size, date, metadata if any, download history, and transfer specs like rate.

Get a Listing of Usage Reports

Get a listing of usage reports.

Get a Listing of Users

Get a list of information about all users.

Create a New User

Create a new user.

Get Information on a Specific User

Get Information on a specific user.

Update a Specific User Record

Make a change to an existing user; for example, make a user an administrator.

Delete a Specific User

Delete a specific user.

Get a Listing of All Workspace Members

Get information about the current members of a given workspace.

Add a User as a Workspace Member

Add a user as a member of this workspace.

Get Information on a Specific Membership

Get information on a specific membership.

Update a Workspace Membership

Make an existing workspace member a workspace manager.

Remove a Member from a Workspace

Remove a direct workspace membership. Note: If the user has indirect membership, through a group for example, the user still has access to the workspace.

Get a Listing of All Workspaces

Retrieve a listing of all configured workspaces.

Create a New Workspace

Create a new workspace.

Get Information on a Specific Workspace

Retrieve information on a specific workspace.

Update a Workspace

Make changes to an existing workspace; for example, change collaboration settings.

Delete a specific Workspace

Delete a specific workspace, specified by workspace ID.

IBM Aspera Node API

Get metadata for all access keys

Get information about all access keys to which the user has access.

Create an access key

Create an access key that allows the user to access the specified path on the HSTS node storage.

Get metadata for the specified access key

Get information about an access key to which the authentication method has access, specified by access key ID.

Modify the specified access key

Update an access key configuration with the specified values. The request body is the same as for a POST request and can contain all or only the updated element-value pairs. The access key ID cannot be updated.

Delete the specified access key

Delete the access key as well as the event and transfer history associated with the access key.

Get event information for the node

Get a full or filtered list of node events to which the user has access.

Get event information for a specific event

Get the event information for a specific event. User must have access to the event to get information.

Browse the specified path.

Retrieve metadata about the contents of the specified path.

Create files and directories

Create directories, files, and symbolic links. Does not accept bearer token authentication; use /files/{id} instead. On Unix-like OSes, if you want to allow /files/create to set the owner of the created files and directories, run the following command: 'asconfigurator -x `set_node_data;group_ownership,-'` Otherwise, when a group ID is set on a parent directory, files and directories and that are created in the parent directory by using /files/create have the primary group ID of the user rather than the group ID of the parent directory. All requests to this endpoint use the same headers.

Delete file and directories

This endpoint allows for the deletion of files and directories. For directories, specify the behavior for deleting non-empty directories. Does not accept bearer token authentication; use /files/{id} instead.

Create a download transfer token

FASP transfers can use transfer tokens to authorize the transfer. Transfer tokens are the most restrictive of the tokens and require careful configuration. Token expiration is configurable on HSTS/HSTE.

Get information about size and counts of files and directories.

Recursive size and counts of files and directories.

Get metadata for the files and directories

Get metadata for the files and directories that are specified in an array of paths. To get file information by using bearer token authentication, use the /files/{id} endpoint.

Paging through the file set

This was introduced since 4.0. It provides a new interface to page through the whole file set with improved performance.

Rename files and directories

Rename the specified files and directories. Existing files and directories cannot be overwritten by a /files/rename request. Does not accept bearer token authentication; use /files/{id} instead.

Search the file system

This endpoint allows for searching the file system based on specified search specifications, including the base path, number of items to return, and filters. Does not accept bearer token authentication.

Create an upload transfer token

FASP transfers can use transfer tokens to authorize the transfer.Transfer tokens are the most restrictive of the tokens and require carefulconfiguration. Token expiration is configurable on HSTS/HSTE. Note: Transfer specifications that are set in aspera.conf overwrite the corresponding values in the request body when the token is created.

Get the metadata of a file

List the metadata of the specified file, symbolic link, or folder. Bearer token users must have "list" permission (recursively) on the directory and "admin" permissions to view file paths.

Modify a file, symbolic link, or directory

Rename the specified file, directory, or symbolic link. Change the mount point status of a directory. Bearer token users must have "rename" permission (recursively) on the file. Mount point status is only visible to master access keys.

Delete a file, link, or directory

Delete the specified file, symbolic link, or directory. Bearer token users must have "delete" permission (recursively) on the file.

Get file contents

List the contents of the specified file. Content cannot be returned for symbolic links or directories. Bearer token user must have "read" permission (recursively) on the file. Content cannot be returned for files that are larger than the configured maximum requested file creation size ("max_request_file_create_size_kb").

List metadata for files in a directory

List the metadata of files in the specified directory (IDs of links and folders are not supported). Bearer token users must have "list" permission (recursively) on the directory, and "admin" permissions to view file paths.

Create a file, symbolic link, or folder

Create a zero or non-zero byte file, symbolic link, or directory in the directory that is specified by ID. Specify the object characteristics in the request body. Bearer token users must have "write" permission (recursively) on the directory to create files or links, and "mkdir" permission to create directories. The non-zero file size is limited by max_request_file_create_size_kb server configuration char_device_file type cannot be created.

Get file contents

List the contents of the specified file with the uri encoded path relative to the docroot. Content cannot be returned for symbolic links or directories. The maximum size being returned is 4096 bytes.

Get information about the node configuration

List information about the node configuration, including the version of the Aspera software, licensed features, the node ID and cluster ID, and requirements for the transfer specification, such as content protection or minimum cipher for encryption of data in transit.

Get Information about transfers (all or filtered)

Retrieve information about transfers to which you have access. The response can be filtered and sorted. To retrieve information about transfers that were started with Faspex or the Connect Server web UI, use the Reliable Query API. To retrieve bandwidth data, use /ops/transfers/bandwidth.

Start a new transfer

Start a transfer between the local node (the node receiving the Node API request) and a remote node that uses the transfer specifications that are contained in the request body

Get bandwidth usage data for all transfers.

Retrieve time series data on transfer rates for all transfers to which the user has access.

Get information about a specific transfer.

Retrieve information about a specific transfer to which you have access and that was started by using the Node API.

Modify a transfer.

Modify the transfer specification of an active transfer, specified by transfer ID, by submitting a partial or complete request body that contains the values.

Cancel a transfer. Must use HTTP CANCEL action, not DELETE.

Cancel a transfer. Use CANCEL instead of DELETE. The user must have access to the transfer and the transfer must be started by a Node API request. This is a shortcut to a PUT /ops/transfers/{id} request that has { "status" : "canceled" } as the request payload.

Get permissions information

Get information about permissions and optionally filter the response. Sub-access key users cannot view permissions.

Create a permission

Apply permissions to a file or directory for a specific user. Accessible only if the user has any permission (recursively) on the associated file. Sub-access key users cannot create or view permissions.

Get permissions information for a specific permission

Get information about a specific permission by permission ID. Accessible only if the user created the permission, is the target of the permission, or has any permission (recursively) on the associated file. Sub-access key users cannot view permissions.

Modify a permission

Modify the access levels or tags associated with a permission. A user can modify permissions on a file only if they were the creator or have any permissions (recursively) on the file. Only the access levels or tags can be modified. To change other settings, delete the permission and recreate it with the new values.

Delete a permission

Delete a permission, specified by permission ID.

Test the responsiveness of a node

Send a request to the node to confirm that it is connected and responsive.

Get access key metadata.

Get metadata, including ID and storage path, for the access key that is associated with the basic token or bearer token that is used to authenticate the request.

Get space information for the file system

Get the total and available space for the file system, drives or partitions (logical or physical) that host one or more queried paths.

Get all usage data

Retrieve usage information, as allowed by the authentication method.

Get usage data for a specific usage id

Retrieve usage information for a specific usage ID, as allowed by the authentication method.

Details
Last Update

3 days ago

Includes
aspera-cloud-api-client
aspera-node-api-client
aspera-cloud-auth