/ping and /info

Test the responsiveness of a node by sending a request to /ping and get information about the node set up and capabilities by sending a request to /info.

Requirements
  • Available as of Enterprise Server version 3.0.0.
Access Control
  • HTTP Basic Auth
    Provide a node username and secret or an access key ID and secret.
  • Bearer token
Status Codes and Errors
Code Description Notes
200 OK Success
400 Bad Request Error Request contains a formatting or syntax error.

Endpoint Actions

Test the Responsiveness of a Node

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

URL
https://{domain}:9092/ping

Sample Request
curl -i -u user:secret https://{domain}:9092/ping \

Sample Response
HTTP/1.1 200 OK

Get Information about a Node

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.

URL
GET https://{domain}:9092/info

Sample Request
curl -i -u user:secret -X GET https://{domain}:9092/info \

Sample Response
HTTP/1.1 200 OK
Cache: no-cache
Connection: close
Content-Type: application/json; charset=utf-8

{
    "application" : "node",
    "version" : "3.8.0.153038",
    "current_time" : "2018-02-28T21:28:06Z",
    "license_expiration_date" : "2018-02-28",
    "license_max_rate" : "unlimited",
    "os" : "Darwin 17.4.0 Darwin Kernel Version 17.4.0: Sun Dec 17 09:19:54 PST 2017; root:xnu-4570.41.2~1/RELEASE_X86_64",
    "async_reporting" : "no",
    "transfer_activity_reporting" : "yes",
    "transfer_user" : "aspera",
    "docroot" : "/",
    "node_id" : "dc3239h5-f872-48b9-v5h9-849rn233725",
    "cluster_id" : "88613fc0-4ad8-47ee-99f0-019122f11575",
    "acls" : [
        "admin",
        "impersonation"
    ],
    "access_key_configuration_capabilities" : {
        "transfer" : [
            "cipher",
            "policy",
            "target_rate_cap_kbps",
            "target_rate_kbps",
            "preserve_timestamps",
            "content_protection_secret",
            "aggressiveness"
        ],
        "server" : [
            "activity_event_logging",
            "recursive_counts"
        ]    
    },
    "capabilities" : [
        {
            "name" : "sync",
            "value" : true
        },
        {
            "name" : "watchfolder",
            "value" : true
        },
        {
            "name" : "symbolic_links",
            "value" : true
        },
        {
            "name" : "move_file",
            "value" : true
        },
        {
            "name" : "move_directory",
            "value" : true
        },
        {
            "name" : "filelock",
            "value" : true
        },
        {
            "name" : "ssh_fingerprint",
            "value" : false
        }
    ],
    "settings" : [
        {
            "name" : "content_protection_required",
            "value" : false
        },
        {
            "name" : "content_protection_strong_pass_required",
            "value" : false
        },
        {
            "name" : "filelock_restriction",
            "value" : "none"
        },
        {
            "name" : "ssh_fingerprint",
            "value" : null
        }
    ]
}

Video player

Video

×