This endpoint allows you manage nodes (a node is a server on which Aspera software is installed).

Note: This endpoint is available only to users with admin access.

Common Error Codes

  • 404 No Content - Package not found; returns an error object
  • 400 Bad Request - Request parameters are invalid; returns an error object
  • 500 HTTP Internal Server Error - Request is valid but the server encountered an error; returns an error object

Get all nodes

GET /api/nodes

This method returns information for all nodes.

Query Parameters: None

Success Response Code:

  • 200 OK - Returns an array of nodes

Example Success Response:

[
    {
        "access_key": null,
        "alternate_address": "186.173.79.69",
        "alternate_address_client_filter": "186.173.79.69",
        "alternate_address_server_filter": "186.173.79.69",
        "api_port": 9092,
        "api_prefix": null,
        "api_username": "IpWWkjqoC+kXYn",
        "blob_container": null,
        "browse_count": 0,
        "created_at": "2013/09/29 23:17:21 -0500",
        "enable_alternate_address": true,
        "encrypted_api_password": "encrypted-api-password",
        "expiration_date": null,
        "host": "127.0.0.1",
        "id": 1,
        "name": "localhost",
        "primary_address": "example.com",
        "salt": "salt_value",
        "shared_url": null,
        "should_poll": true,
        "ssh_port": null,
        "ssl": true,
        "stats_api_reachable": true,
        "stats_iteration_token": null,
        "status": null,
        "status_at": null,
        "status_message": null,
        "storage_account": null,
        "storage_type": "",
        "updated_at": "2015/01/28 10:27:32 -0600",
        "verify_ssl": false,
        "shares": [
            {
                "browse_count": 0,
                "comment_added_at": null,
                "content_added_at": null,
                "created_at": "2013/09/29 23:17:21 -0500",
                "destination": false,
                "directory": "/",
                "enable_cloud_referencing": false,
                "enable_linking": false,
                "id": 2,
                "kbps_initial_target_download_rate": 45000,
                "kbps_initial_target_upload_rate": 45000,
                "kbps_max_target_download_rate": 100000,
                "kbps_max_target_upload_rate": 100000,
                "lock_minrate_policy": true,
                "name": "packages",
                "node_id": 1,
                "override_transfer_parameters": false,
                "relay_incoming_bandwidth": 45000,
                "relay_outgoing_bandwidth": 45000,
                "source_access": "limited",
                "status": null,
                "status_at": null,
                "status_message": null,
                "transfer_files_iteration_token": null,
                "transfers_iteration_token": null,
                "updated_at": "2015/08/14 17:45:29 -0500"
            },
            {
                .  .  .
            },
            {
                .  .  .
            }
        ]
    },
    {
    .  .  .
        
    }
]

Get shares for a given node

GET /api/nodes/{node_id}/shares

This method retrieves information about shares on a specific node.

Query Parameters: None

Request Body: None

Success Response Code:

  • 200 OK - Returns an array of shares for the specified node

Example Success Response:

[
    [
    {
        "browse_count": 0,
        "comment_added_at": null,
        "content_added_at": null,
        "created_at": "2013/09/29 23:17:21 -0500",
        "destination": false,
        "directory": "/",
        "enable_cloud_referencing": false,
        "enable_linking": false,
        "id": 2,
        "kbps_initial_target_download_rate": 45000,
        "kbps_initial_target_upload_rate": 45000,
        "kbps_max_target_download_rate": 100000,
        "kbps_max_target_upload_rate": 100000,
        "lock_minrate_policy": true,
        "name": "packages",
        "node_id": 1,
        "override_transfer_parameters": false,
        "relay_incoming_bandwidth": 45000,
        "relay_outgoing_bandwidth": 45000,
        "source_access": "limited",
        "status": null,
        "status_at": null,
        "status_message": null,
        "transfer_files_iteration_token": null,
        "transfers_iteration_token": null,
        "updated_at": "2015/08/14 17:45:29 -0500"
    },
    {
        .  .  .
    },
    {
         .  .  .
    }
]

Video player

Video

×