This page contains the following endpoints:

Application Email Settings

/system/configuration/application_email_setting

This endpoint allows you to manage application email settings.


Request Headers

Content-Type: application/json
Accept: application/json
Authorization: Bearer access_token
Host: example.org
Cookie: 

Request Example

curl "http://shares.example.com/system/configuration/application_email_setting" -d '{"share_authorization":false}' -X PUT \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer access_token" \
-H "Host: example.org" \
-H "Cookie: "

Success Response Codes

Method Code
GET 200 OK
PUT 200 OK
DELETE 200 OK

Error Response Codes

Description of error is included in response body.

Method Error Reason
PUT 422 Unprocessable Entity Submitted a parameter with an invalid or empty value

Response Attributes

Name Type Description
share_authorization boolean Share authorization
project_authorization boolean Project authorization
transfer_completion boolean Transfer completion

Get application email settings

GET /system/configuration/application_email_setting

Request Example

curl -g "http://shares.example.com/system/configuration/application_email_setting" -X GET

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"3d34500755a4bd17124cdf0501107fe1"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 9603653d-c2d8-4fa8-9265-78efc86ad54c
X-Runtime: 0.028790
Content-Length: 84

Success Response Example

200 OK
{
  "share_authorization": true,
  "project_authorization": true,
  "transfer_completion": true
}


Update application email settings

PUT /system/configuration/application_email_setting

Request Example

curl "http://shares.example.com/system/configuration/application_email_setting" -d '{"share_authorization":false}' -X PUT

Request Parameters

Name Required/Optional Type Description
share_authorization Optional boolean Share authorization
project_authorization Optional boolean Project authorization
transfer_completion Optional boolean Transfer completion

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"2fa930c7933172407517ea8cb148ef68"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 8c727504-ab40-43d1-a47a-2411d890207e
X-Runtime: 0.015953
Content-Length: 85

Success Response Example

200 OK
{
  "share_authorization": false,
  "project_authorization": true,
  "transfer_completion": true
}

Error Response Example

422 Unprocessable Entity

Example Response Body

{
              "errors": {
                "share_authorization": [
                  "is not included in the list"
                ]
              }
            }


Reset application email settings

DELETE /system/configuration/application_email_setting

Request Example

curl "http://shares.example.com/system/configuration/application_email_setting" -d '' -X DELETE

Response Headers

X-Frame-Options: SAMEORIGIN
  X-XSS-Protection: 1; mode=block
  X-Content-Type-Options: nosniff
  Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
  Content-Type: application/json; charset=utf-8
  ETag: W/"3d34500755a4bd17124cdf0501107fe1"
  Cache-Control: max-age=0, private, must-revalidate
  X-Request-Id: 73778d6e-cd1e-4eaf-924c-2cd8b28deb10
  X-Runtime: 0.011826
  Content-Length: 84

Success Response Example

200 OK
{
  "share_authorization": true,
  "project_authorization": true,
  "transfer_completion": true
  }


Application IP Address Filter

/system/configuration/application_ip_address_filter

This endpoint allows you to manage IP address filters.

Request Headers

Content-Type: application/json
Accept: application/json
Authorization: Bearer access_token
Host: example.org
Cookie: 

Request Example

curl "http://shares.example.com/system/configuration/application_ip_address_filter" -d '{"accepting":false,"addresses":"10.0.0.3, 10.0.45.102/10"}' -X POST \
	-H "Content-Type: application/json" \
	-H "Accept: application/json" \
	-H "Authorization: Bearer access_token" \
	-H "Host: example.org" \
	-H "Cookie: "

Request Parameters (POST and PUT)

Name Required/Optional Type Description
accepting Required boolean Accepting
addresses Required integer Port

Success Response Codes

Method Code
GET 200 OK
POST 201 Created
PUT 200 OK
DELETE 204 No Content

Error Response Codes

Description of error is included in response body.

Method Error Reason
PUT 422 Unprocessable Entity Submitted a parameter with an invalid or empty value

Response Attributes

Name Type Description
accepting boolean Accepting
addresses string IP addresses

List all application IP address filters

GET /system/configuration/application_ip_address_filter

Request Example

curl -g "http://shares.example.com/system/configuration/application_ip_address_filter" -X GET

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"54ed51e93fd863b57bdbc681cf96d749"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 8bdc8b9c-f735-4879-9040-b080b607ffa8
X-Runtime: 0.033493
Content-Length: 73

Success Response Example

200 OK
{
  "accepting": false,
  "addresses": "10.0.200.119, 10.2.200.201, 10.0.6.4/30"
}


Create a application IP address filter

POST /system/configuration/application_ip_address_filter

Request Example

curl "http://shares.example.com/system/configuration/application_ip_address_filter" -d '{"accepting":false,"addresses":"10.0.0.3, 10.0.45.102/10"}' -X POST

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"6adecdcb88d3d3b210505e13c21f65ce"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: d417f465-c465-44c3-96d6-0f9c875b90cc
X-Runtime: 0.015318
Content-Length: 58

Success Response Example

201 Created
{
  "accepting": false,
  "addresses": "10.0.0.3, 10.0.45.102/10"
}


Update application IP addresses filter

PUT /system/configuration/application_ip_address_filter

Request Example

curl "http://shares.example.com/system/configuration/application_ip_address_filter" -d '{"accepting":false,"addresses":"10.0.0.3, 10.0.45.102/10"}' -X PUT

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"6adecdcb88d3d3b210505e13c21f65ce"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 12107c27-349e-4dc1-bf0e-19a3c31822ca
X-Runtime: 0.016589
Content-Length: 58

Success Response Example

200 OK
{
  "accepting": false,
  "addresses": "10.0.0.3, 10.0.45.102/10"
}

Error Response Example

422 Unprocessable Entity
{
          "errors": {
          "addresses": [
            "can't be blank"
          ]
          }
          }


Delete application IP address filters

DELETE /system/configuration/application_ip_address_filter

Request Example

curl "http://shares.example.com/system/configuration/application_ip_address_filter" -d '' -X DELETE

Response Headers

X-Frame-Options: SAMEORIGIN
    X-XSS-Protection: 1; mode=block
    X-Content-Type-Options: nosniff
    Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
    Cache-Control: no-cache
    X-Request-Id: ab30622a-a305-4f9f-b92f-b43610ec8059
    X-Runtime: 0.010794

Success Response Example

204 No Content



Application Messages

/system/configuration/application_message

This endpoint allows you to manage application messages.

Request Headers

Content-Type: application/json
Accept: application/json
Authorization: Bearer access_token
Host: example.org
Cookie: 

Request Example

curl "http://shares.example.com/system/configuration/application_message" -d '{"login_page_message":"Logging"}' -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer access_token" \
-H "Host: example.org" \
-H "Cookie: "

Request Parameters (POST and PUT)

Name Required/Optional Type Description
login_page_message Optional string Login page message

Success Response Codes

Method Code
GET 200 OK
POST 201 Created
PUT 200 OK
DELETE 204 No Content

Response Attributes

Name Type Description
login_page_message string Login page message

Get all application messages

GET /system/configuration/application_message

Request Example

curl -g "http://shares.example.com/system/configuration/application_message" -X GET

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"b0f0665177b17658d4eb9b72a4ffe928"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 973f6877-4e6a-44cd-a27f-b52aad28f88a
X-Runtime: 0.011837
Content-Length: 42

Success Response Example

200 OK
{
"login_page_message": "Hello and welcome"
}


Create application message

POST /system/configuration/application_message

Request Example

curl "http://shares.example.com/system/configuration/application_message" -d '{"login_page_message":"Logging"}' -X POST

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"fa281b20117910abf17bdbcea39113bd"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 3804dd0f-9f5f-40ba-b19c-4c57edf97ef8
X-Runtime: 0.070319
Content-Length: 32

Success Response Example

201 Created
{
  "login_page_message": "Logging"
}


Update application message

PUT /system/configuration/application_message

Request Example

curl "http://shares.example.com/system/configuration/application_message" -d '{"login_page_message":"Login page"}' -X PUT

Response Headers

X-Frame-Options: SAMEORIGIN
  X-XSS-Protection: 1; mode=block
  X-Content-Type-Options: nosniff
  Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
  Content-Type: application/json; charset=utf-8
  ETag: W/"16ccfaf98e7fd404a4d9b0577789c553"
  Cache-Control: max-age=0, private, must-revalidate
  X-Request-Id: 7d97d4c8-e827-4a8a-9858-e077c1fb3297
  X-Runtime: 0.016609
  Content-Length: 35

Success Response Example

200 OK
{
  "login_page_message": "Login page"
  }


Delete application message

DELETE /system/configuration/application_message

Request Example

curl "http://shares.example.com/system/configuration/application_message" -d '' -X DELETE

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Cache-Control: no-cache
X-Request-Id: 2ae487b2-12d6-4c25-972e-60331af1e819
X-Runtime: 0.013072

Success Response Example

204 No Content


Application Transfer Settings

/system/configuration/application_transfer_setting

This endpoint allows you to manage application transfer settings.

Request Headers

Content-Type: application/json
Accept: application/json
Authorization: Bearer access_token
Host: example.org
Cookie: 

Request Example

curl "http://shares.example.com/system/configuration/application_transfer_setting" -d '{"upload_target_rate":"100 Mbps","upload_target_rate_cap":"10 Gbps","download_target_rate":"400 Mbps","download_target_rate_cap":"10 Gbps","starting_policy":"low","allowed_policy":"low","encryption":"aes-128","encryption_at_rest":false}' -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer access_token" \
-H "Host: example.org" \
-H "Cookie: "

Request Parameters (POST and PUT)

Name Required/Optional Type Description
min_connect_version Optional string Minimum connect version
upload_target_rate Optional unsigned integer Upload target rate (kbps)
upload_target_rate_cap Optional unsigned integer Upload target rate cap (kbps)
download_target_rate Optional unsigned integer Download target rate (kbps)
download_target_rate_cap Optional unsigned integer Download target rate cap (kbps)
starting_policy Optional string Starting rate policy
allowed_policy Optional string Allowed rate policies
encryption Optional string Encryption
encryption_at_rest Optional boolean Encryption at rest

Success Response Codes

Method Code
GET 200 OK
POST 201 Created
PUT 200 OK
DELETE 200 OK

Error Response Codes

Description of error is included in response body.

Method Error Reason
POST 422 Unprocessable Entity Submitted a parameter with an invalid or empty value, number is in an incorrect format, or units are incorrect
PUT 422 Unprocessable Entity Submitted a parameter with an invalid or empty value, number is in an incorrect format, or units are incorrect

Response Attributes

Name Type Description
min_connect_version string Minimum connect version
upload_target_rate unsigned integer Upload target rate (kbps)
upload_target_rate_cap unsigned integer Upload target rate cap (kbps)
download_target_rate unsigned integer Download target rate (kbps)
download_target_rate_cap unsigned integer Download target rate cap (kbps)
starting_policy string Starting rate policy
allowed_policy string Allowed rate policies
encryption string Encryption
encryption_at_rest boolean Encryption at rest

Show application transfer settings

GET /system/configuration/application_transfer_setting

Request Example

curl -g "http://shares.example.com/system/configuration/application_transfer_setting" -X GET

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"da486af5d7bcc100df3fb51ca99c5985"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: de5405df-b7b2-4dd2-b1bf-3c19def8302e
X-Runtime: 0.026493
Content-Length: 257

Success Response Example

200 OK
{
"min_connect_version": "3.6.1",
"upload_target_rate": "41.0 Kbps",
"upload_target_rate_cap": "4.1 Gbps",
"download_target_rate": null,
"download_target_rate_cap": null,
"starting_policy": "low",
"allowed_policy": "low",
"encryption": "aes-128",
"encryption_at_rest": false
}


Create application transfer settings

POST /system/configuration/application_transfer_setting

Request Example

curl "http://shares.example.com/system/configuration/application_transfer_setting" -d '{"upload_target_rate":"100 Mbps","upload_target_rate_cap":"10 Gbps","download_target_rate":"400 Mbps","download_target_rate_cap":"10 Gbps","starting_policy":"low","allowed_policy":"low","encryption":"aes-128","encryption_at_rest":false}' -X POST \

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"be30053596b5e4b6bb8e1221d083f58b"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 62dd85be-6098-46a0-9a92-ae6f05240d73
X-Runtime: 0.016505
Content-Length: 274

Success Response Example

201 Created
{
  "min_connect_version": "3.6.1",
  "upload_target_rate": "100.0 Mbps",
  "upload_target_rate_cap": "10.0 Gbps",
  "download_target_rate": "400.0 Mbps",
  "download_target_rate_cap": "10.0 Gbps",
  "starting_policy": "low",
  "allowed_policy": "low",
  "encryption": "aes-128",
  "encryption_at_rest": false
}

Error Response Example

422 Unprocessable Entity
{
        "errors": {
        "min_connect_version": [
          "can't be blank",
          "must have the form 1, 1.2, 1.2.3, or 1.2.3.4, etc."
        ]
        }
        }


Update application transfer settings

PUT /system/configuration/application_transfer_setting

Request Example

curl "http://shares.example.com/system/configuration/application_transfer_setting" -d '{"upload_target_rate":"41 Mbps","upload_target_rate_cap":"100 Mbps","download_target_rate":"52 Mbps","download_target_rate_cap":"100 Mbps","starting_policy":"low","allowed_policy":"low","encryption":"aes-128","encryption_at_rest":false}' -X PUT

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"777cead33336bd4d3290d4c5b57e9835"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: d6b7ba82-a115-4224-ae7f-6cfe7923af27
X-Runtime: 0.018563
Content-Length: 274

Success Response Example

200 OK
{
  "min_connect_version": "3.6.1",
  "upload_target_rate": "41.0 Mbps",
  "upload_target_rate_cap": "100.0 Mbps",
  "download_target_rate": "52.0 Mbps",
  "download_target_rate_cap": "100.0 Mbps",
  "starting_policy": "low",
  "allowed_policy": "low",
  "encryption": "aes-128",
  "encryption_at_rest": false
}

Error Response Example

422 Unprocessable Entity
{
        "errors": {
        "starting_policy": [
          "is not included in the list"
        ],
        "allowed_policy": [
          "is not included in the list"
        ],
        "encryption": [
          "is not included in the list"
        ],
        "upload_target_rate": [
          "must be of the form: 'number' or 'number unit'; units in (Kbps, Mbps, Gbps, Tbps)"
        ],
        "download_target_rate": [
          "must be less than or equal to 10.0 Gbps"
        ],
        "min_connect_version": [
          "must have the form 1, 1.2, 1.2.3, or 1.2.3.4, etc."
        ]
        }
        }


Reset application transfer settings

DELETE /system/configuration/application_transfer_setting

Request Example

curl "http://shares.example.com/system/configuration/application_transfer_setting" -d '' -X DELETE

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"a94c9b4c88628a5ba77f47d7503706c3"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 4f5eae7d-9326-4f40-9ab6-ecb93e380aa5
X-Runtime: 0.015994
Content-Length: 265

Success Response Example

200 OK
{
  "min_connect_version": "3.6.1",
  "upload_target_rate": null,
  "upload_target_rate_cap": null,
  "download_target_rate": null,
  "download_target_rate_cap": null,
  "starting_policy": "fair",
  "allowed_policy": "fixed, high, fair, and low",
  "encryption": "none",
  "encryption_at_rest": false
}


License

/system/configuration/license

This endpoint allows you to manage licenses.

Request Headers

Content-Type: application/json
Accept: application/json
Authorization: Bearer access_token
Host: example.org
Cookie: 

Request Example

curl "http://shares.example.com/system/configuration/license" -d '{"encoded_license":"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxsaWNl\nbnNlIHZlcnNpb249IjEiPg0KICA8IS0tIFZvaWQgaWYgbW9kaWZpZWQgLS0+\nDQogIDxwcm9kdWN0X2lkPjI5PC9wcm9kdWN0X2lkPg0KICA8cHJvZHVjdF9u\nYW1lPlNoYXJlczwvcHJvZHVjdF9uYW1lPg0KICA8Y3VzdG9tZXJfaWQ+MTwv\nY3VzdG9tZXJfaWQ+DQogIDxsaWNlbnNlX2lkPjEyMzwvbGljZW5zZV9pZD4N\nCiAgPGV4cGlyYXRpb25fZGF0ZT4yMDY3LTA2LTMwPC9leHBpcmF0aW9uX2Rh\ndGU+DQogIDxzaGFyZXNfZW5hYmxlZD55ZXM8L3NoYXJlc19lbmFibGVkPg0K\nICA8bWF4X25vZGVzPjU8L21heF9ub2Rlcz4NCiAgPG1heF91c2Vycz4xMDA8\nL21heF91c2Vycz4NCjwvbGljZW5zZT4NCj09U0lHTkFUVVJFPT0NClJ5RHJv\nQS9WbTlreTFZQjVIbDhXU28xaTNOTW5kTkxZNE5ranVLTTVxa2JxUVMzV0Zz\ncWZsczlnZ3NIVg0KTG1WZENVcDBpUDZGMHpydDQyWis1TUs1eUJwVXRCc0Fl\nekt4eHlWQlY2Tk5jMEU5c0FCMXhGZjVQOTlQDQpVdW9VejFWNVIxREdJZFRM\nenhJQUxHSWZNekJMd21mODZxZGxwdTVFZlhIM3R1clZvYWRSVUlLd2tLZkwN\nCmw1MGtIcUZMcGNUQk9mTVNCcVpvNjdnTjNHZkZQY1NzZzdkdG5jTTFFRUhK\nRHltdGxMbGFvR1FCRm5YRg0KcDZLallxMHh3ZSt5R2pCMk9vNjZzM3MxR2Yz\nSjlNbkZsMzNrWEVZNWUzMTgxcTVoTUJaQTd5NUxodENmDQpQVlRkRkowQ1Jz\nbWwxMlh6MGxlMkk4OTMyNHk3TTNMSnlZY0xLUkgyRGc9PQ0K"}' -X PUT \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer access_token" \
-H "Host: example.org" \
-H "Cookie: "

Success Response Codes

Method Code
GET 200 OK
PUT 200 OK

Error Response Codes

Description of error is included in response body.

Method Error Reason
PUT 422 Unprocessable Entity Problem with digital signature in encoded license

Response Attributes

Name Type Description
expires boolean Whether or not the license expires
expires_at string Expiration date of the license. Null if the license does not expire
customer_id integer Customer ID of the license
license_id integer ID of the license
unlimited_nodes boolean Whether or not this license allows an unlimited number of nodes
max_nodes integer Maximum number of nodes this license allows. Null if unlimited

Show license information

GET /system/configuration/license

Request Example

curl -g "http://shares.example.com/system/configuration/license" -X GET

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"41685db11eef4aa74b5330a53ce4afda"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 6bd2c23a-03dd-4349-b221-98bcbc11cf98
X-Runtime: 0.018183
Content-Length: 113

Success Response Example

200 OK
{
"expires_at": "2067-06-30",
"expires": true,
"customer_id": 1,
"license_id": 123,
"unlimited_nodes": false,
"max_nodes": 5
}


Set or update license

PUT /system/configuration/license

Request Example

curl "http://shares.example.com/system/configuration/license" -d '{"encoded_license":"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxsaWNl\nbnNlIHZlcnNpb249IjEiPg0KICA8IS0tIFZvaWQgaWYgbW9kaWZpZWQgLS0+\nDQogIDxwcm9kdWN0X2lkPjI5PC9wcm9kdWN0X2lkPg0KICA8cHJvZHVjdF9u\nYW1lPlNoYXJlczwvcHJvZHVjdF9uYW1lPg0KICA8Y3VzdG9tZXJfaWQ+MTwv\nY3VzdG9tZXJfaWQ+DQogIDxsaWNlbnNlX2lkPjEyMzwvbGljZW5zZV9pZD4N\nCiAgPGV4cGlyYXRpb25fZGF0ZT4yMDY3LTA2LTMwPC9leHBpcmF0aW9uX2Rh\ndGU+DQogIDxzaGFyZXNfZW5hYmxlZD55ZXM8L3NoYXJlc19lbmFibGVkPg0K\nICA8bWF4X25vZGVzPjU8L21heF9ub2Rlcz4NCiAgPG1heF91c2Vycz4xMDA8\nL21heF91c2Vycz4NCjwvbGljZW5zZT4NCj09U0lHTkFUVVJFPT0NClJ5RHJv\nQS9WbTlreTFZQjVIbDhXU28xaTNOTW5kTkxZNE5ranVLTTVxa2JxUVMzV0Zz\ncWZsczlnZ3NIVg0KTG1WZENVcDBpUDZGMHpydDQyWis1TUs1eUJwVXRCc0Fl\nekt4eHlWQlY2Tk5jMEU5c0FCMXhGZjVQOTlQDQpVdW9VejFWNVIxREdJZFRM\nenhJQUxHSWZNekJMd21mODZxZGxwdTVFZlhIM3R1clZvYWRSVUlLd2tLZkwN\nCmw1MGtIcUZMcGNUQk9mTVNCcVpvNjdnTjNHZkZQY1NzZzdkdG5jTTFFRUhK\nRHltdGxMbGFvR1FCRm5YRg0KcDZLallxMHh3ZSt5R2pCMk9vNjZzM3MxR2Yz\nSjlNbkZsMzNrWEVZNWUzMTgxcTVoTUJaQTd5NUxodENmDQpQVlRkRkowQ1Jz\nbWwxMlh6MGxlMkk4OTMyNHk3TTNMSnlZY0xLUkgyRGc9PQ0K"}' -X PUT
        

Request Parameters

Name Required/Optional Type Description
encoded_license Optional string Encoded Shares license

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"41685db11eef4aa74b5330a53ce4afda"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: ce81e719-5465-49dc-9e7e-8c39e50d1bd3
X-Runtime: 0.046987
Content-Length: 113

Success Response Example

200 OK
{
  "expires_at": "2067-06-30",
  "expires": true,
  "customer_id": 1,
  "license_id": 123,
  "unlimited_nodes": false,
  "max_nodes": 5
}

Error Response Example

422 Unprocessable Entity
{
      "errors": {
        "base": [
          "Invalid signature"
        ]
      }
      }


Local User Security Settings

GET /system/configuration/local_user_security_setting

This endpoint allows you to manage local security settings and configurations.

Request Headers

Content-Type: application/json
Accept: application/json
Authorization: Bearer access_token
Host: example.org
Cookie: 

Request Example

curl "http://shares.example.com/system/configuration/local_user_security_setting" -d '{"password_strength_enforced":false,"passwords_expire":false,"password_lifetime_days":25,"passwords_must_change":false,"passwords_to_remember":2,"password_reset_token_lifetime_minutes":5,"lock_email_after_failed_login_attempts":false,"max_login_attempts_per_email":20,"lock_ip_after_failed_login_attempts":true,"max_login_attempts_per_address":30,"lockout_time_minutes":20}' -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer access_token" \
-H "Host: example.org" \
-H "Cookie: "

Request Parameters (POST and PUT)

Name Required/Optional Type Description
password_strength_enforced Required boolean Require strong passwords
password_strength_regex Optional string Regular expression to validate password strength
password_strength_description Optional string Description of password strength requirements
passwords_expire Required boolean Passwords expire
password_lifetime_days Required unsigned integer Password lifetime (days)
passwords_must_change Required boolean Restrict password reuse
passwords_to_remember Required unsigned integer How many previous passwords to remember
password_reset_token_lifetime_minutes Required unsigned integer Password reset token lifetime (minutes)
lock_email_after_failed_login_attempts Required boolean Lock login attempts for email account after excessive login attempts
max_login_attempts_per_email Required unsigned integer Maximum number of attempts for email before lockout
lock_ip_after_failed_login_attempts Required boolean Lock login attempts from IP address after excessive login attempts
max_login_attempts_per_address Required unsigned integer Maximum number of attempts from IP address before lockout
lockout_time_minutes Required unsigned integer Duration of lockout after excessive use

Success Response Codes

Method Code
GET 200 OK
POST 200 OK
PUT 200 OK
DELETE 204 No Content

Error Response Codes

Description of error is included in response body.

Method Error Reason
PUT 422 Unprocessable Entity Submitted a parameter with an invalid numerical value

Response Attributes

Name Type Description
password_strength_enforced boolean Require strong passwords
password_strength_regex string Regular expression to validate password strength
password_strength_description string Description of password strength requirements
passwords_expire boolean Passwords expire
password_lifetime_days unsigned integer Password lifetime (days)
passwords_must_change boolean Restrict password reuse
passwords_to_remember unsigned integer How many previous passwords to remember
password_reset_token_lifetime_minutes unsigned integer Password reset token lifetime (minutes)
lock_email_after_failed_login_attempts boolean Lock login attempts for email account after excessive login attempts
max_login_attempts_per_email unsigned integer Maximum number of attempts for email before lockout
lock_ip_after_failed_login_attempts boolean Lock login attempts from IP address after excessive login attempts
max_login_attempts_per_address unsigned integer Maximum number of attempts from IP address before lockout
lockout_time_minutes unsigned integer Duration of lockout after excessive use

Get all local user security settings

GET /system/configuration/local_user_security_setting

Request Example

curl -g "http://shares.example.com/system/configuration/local_user_security_setting" -X GET

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"34c234b72d6aecdf73d5a1ef96c00cbc"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 674c85de-552a-46d6-97ea-6b6cdd6504a8
X-Runtime: 0.027305
Content-Length: 474

Success Response Example

200 OK
{
"password_strength_enforced": true,
"password_strength_regex": "^.+{8,}$",
"password_strength_description": "must be at least 8 characters",
"passwords_expire": false,
"password_lifetime_days": 25,
"passwords_must_change": false,
"passwords_to_remember": 2,
"password_reset_token_lifetime_minutes": 5,
"lock_email_after_failed_login_attempts": false,
"max_login_attempts_per_email": 20,
"lock_ip_after_failed_login_attempts": false,
"max_login_attempts_per_address": 30,
"lockout_time_minutes": 20
}


Create local user configuration

POST /system/configuration/local_user_security_setting

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"353e14881160907900e96917c7e1abf6"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 28a9387c-33bf-4daa-8614-5b6ae1d21678
X-Runtime: 0.015413
Content-Length: 543

Success Response Example

200 OK
{
  "password_strength_enforced": false,
  "password_strength_regex": "(?=.*\\d)(?=.*([a-z]|[A-Z]))(?=.*(\\W|_)).{6,}",
  "password_strength_description": "must include at least one letter, one number, and one symbol",
  "passwords_expire": false,
  "password_lifetime_days": 25,
  "passwords_must_change": false,
  "passwords_to_remember": 2,
  "password_reset_token_lifetime_minutes": 5,
  "lock_email_after_failed_login_attempts": false,
  "max_login_attempts_per_email": 20,
  "lock_ip_after_failed_login_attempts": true,
  "max_login_attempts_per_address": 30,
  "lockout_time_minutes": 20
}


Update local user configuration

PUT /system/configuration/local_user_security_setting

Request Example

curl "http://shares.example.com/system/configuration/local_user_security_setting" -d '{"password_strength_enforced":true,"password_strength_regex":"^.+{8,}$","password_strength_description":"must be at least 8 characters","passwords_expire":true,"password_lifetime_days":15,"passwords_must_change":true,"passwords_to_remember":5,"password_reset_token_lifetime_minutes":2,"lock_email_after_failed_login_attempts":true,"max_login_attempts_per_email":5,"lock_ip_after_failed_login_attempts":true,"max_login_attempts_per_address":10,"lockout_time_minutes":30}' -X PUT

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"5e2407b075df9922e9fbef568c41a853"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 780a85bd-5784-4fe2-af0b-b695e7a37922
X-Runtime: 0.016799
Content-Length: 469

Success Response Example

200 OK
{
  "password_strength_enforced": true,
  "password_strength_regex": "^.+{8,}$",
  "password_strength_description": "must be at least 8 characters",
  "passwords_expire": true,
  "password_lifetime_days": 15,
  "passwords_must_change": true,
  "passwords_to_remember": 5,
  "password_reset_token_lifetime_minutes": 2,
  "lock_email_after_failed_login_attempts": true,
  "max_login_attempts_per_email": 5,
  "lock_ip_after_failed_login_attempts": true,
  "max_login_attempts_per_address": 10,
  "lockout_time_minutes": 30
}

Error Response Example

422 Unprocessable Entity
{
      "errors": {
        "password_lifetime_days": [
          "must be less than or equal to 365"
        ],
        "passwords_to_remember": [
          "must be less than or equal to 12"
        ],
        "password_reset_token_lifetime_minutes": [
          "must be less than or equal to 1440"
        ],
        "max_login_attempts_per_email": [
          "must be greater than or equal to 5"
        ],
        "max_login_attempts_per_address": [
          "must be less than or equal to 100"
        ],
        "lockout_time_minutes": [
          "must be less than or equal to 1440"
        ]
      }
    }


Delete user security setting

DELETE /system/configuration/local_user_security_setting

Request Example

curl "http://shares.example.com/system/configuration/local_user_security_setting" -d '' -X DELETE

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Cache-Control: no-cache
X-Request-Id: b0df866a-2b98-4927-bf10-48214aede7d7
X-Runtime: 0.012152

Success Response Example

204 No Content


SMTP Server Configuration

/system/configuration/smtp_server

This endpoint allows you to manage SMTP server configurations.

Request Headers

Content-Type: application/json
Accept: application/json
Authorization: Bearer access_token
Host: example.org
Cookie: 

Request Example

curl "http://shares.example.com/system/configuration/smtp_server" -d '{"server":"smtp.aspera.us","port":25,"domain":"aspera.us","tls":false,"from":"caitlyn@asperasoft.com","from_name":"Caitlyn Yoo"}' -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer access_token" \
-H "Host: example.org" \
-H "Cookie: "

Request Parameters (POST and PUT)

Name Required/Optional Type Description
server Required string Server
port Required unsigned integer Port
domain Required string Domain
tls Required boolean Using TLS
username Required string Username - not required if from email address is provided
password Optional string Password
from Required string From email address - not required if username is provided
from_name Required string From name
timeout Optional unsigned integer Timeout (seconds)

Success Response Codes

Method Code
GET 200 OK
POST 201 Created
PUT 200 OK
DELETE 204 No Content

Error Response Codes

Description of error is included in response body.

Method Error Reason
POST 422 Unprocessable Entity Submitted a parameter with an invalid or empty value
PUT 422 Unprocessable Entity Submitted a parameter with an invalid or empty value

Response Attributes

Name Type Description
server string Server
port unsigned integer Port
domain string Domain
tls boolean Using TLS
username string Username
password string Password
from string From email address
from_name string From name
timeout unsigned integer Timeout (seconds)

Get SMTP server configuration

GET /system/configuration/smtp_server

Request Example

curl -g "http://shares.example.com/system/configuration/smtp_server" -X GET

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"0082aea9744431ccad6e2ea644181fe0"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: b2a8615a-ea49-458d-8e93-b514d0ba30b1
X-Runtime: 0.011908
Content-Length: 169

Success Response Example

200 OK
{
"server": "smtp2.aspera.us",
"port": 25,
"domain": "aspera.us",
"tls": false,
"username": null,
"from": "qafaspex@asperasoft.net",
"from_name": "Aspera, an IBM company",
"timeout": 3
}


Create SMTP server configuration

POST /system/configuration/smtp_server

Request Example

curl "http://shares.example.com/system/configuration/smtp_server" -d '{"server":"smtp.aspera.us","port":25,"domain":"aspera.us","tls":false,"from":"caitlyn@asperasoft.com","from_name":"Caitlyn Yoo"}' -X POST 

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"576b0e877d8f41b01832fa7ccb0dff93"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 2801bad1-d412-489f-993e-6fd9213ee2ab
X-Runtime: 0.053815
Content-Length: 156

Success Response Example

201 Created
{
  "server": "smtp.aspera.us",
  "port": 25,
  "domain": "aspera.us",
  "tls": false,
  "username": null,
  "from": "caitlyn@asperasoft.com",
  "from_name": "Caitlyn Yoo",
  "timeout": 3
}

Error Response Example

422 Unprocessable Entity
{
            "errors": {
            "from": [
            "can't be blank, from or username must be provided"
            ],
            "username": [
            "can't be blank, username or from must be provided"
            ]
            }
            }


Update SMTP server configuration

PUT /system/configuration/smtp_server

Request Example

curl "http://shares.example.com/system/configuration/smtp_server" -d '{"server":"smtp.gmail.com","port":587,"domain":"gmail.com"}' -X PUT

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"175fd3c3f8739da8ef9a35a5383e6673"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 4516bb6b-dd8e-4816-a237-02d4e1747428
X-Runtime: 0.017308
Content-Length: 169

Success Response Example

200 OK
{
  "server": "smtp.gmail.com",
  "port": 587,
  "domain": "gmail.com",
  "tls": false,
  "username": null,
  "from": "qafaspex@asperasoft.net",
  "from_name": "Aspera, an IBM company",
  "timeout": 3
}

Error Response Example

422 Unprocessable Entity
{
              "errors": {
              "server": [
              "can't be blank"
              ],
              "port": [
              "is not a number"
              ],
              "domain": [
              "can't be blank"
              ],
              "password": [
              "can't be blank"
              ]
              }
              }


Delete SMTP server configuration

DELETE /system/configuration/smtp_server

Request Example

curl "http://shares.example.com/system/configuration/smtp_server" -d '' -X DELETE

Response Headers

X-Frame-Options: SAMEORIGIN
  X-XSS-Protection: 1; mode=block
  X-Content-Type-Options: nosniff
  Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
  Cache-Control: no-cache
  X-Request-Id: eb100dc3-9a0b-46d7-966a-0c6651431566
  X-Runtime: 0.012026

Success Response Example

204 No Content


User Security Settings

This endpoint allows you to manage user security settings.

Request Headers

Content-Type: application/json
Accept: application/json
Authorization: Bearer access_token
Cookie: 

Request Example

curl "http://shares.example.com/system/configuration/user_security_setting" -d '{"sessions_time_out":false,"session_inactivity_timeout_hours":4,"access_token_lifetime_hours":7,"refresh_tokens_expire":false,"refresh_token_lifetime_days":10,"max_access_tokens_allowed":10}' -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer access_token" \
-H "Host: example.org" \
-H "Cookie: "

Request Parameters (POST and PUT)

Name Required/Optional Type Description
sessions_time_out Optional boolean Sessions will timeout
session_inactivity_timeout_hours Optional unsigned integer Session inactivity lifetime (hours)
access_token_lifetime_hours Optional unsigned integer Access token lifetime (hours)
refresh_tokens_expire Optional boolean Refresh tokens will expire
refresh_token_lifetime_days Optional unsigned integer Refresh token lifetime (days)
max_access_tokens_allowed Optional unsigned integer Maximum access tokens allowed

Success Response Codes

Method Code
GET 200 OK
POST 200 Created
PUT 200 OK
DELETE 204 No Content

Error Response Codes

Description of error is included in response body.

Method Error Reason
PUT 422 Unprocessable Entity Submitted a parameter with invalid numerical value

Response Attributes

Name Type Description
sessions_time_out boolean Sessions will timeout
session_inactivity_timeout_hours unsigned integer Session inactivity lifetime (hours)
access_token_lifetime_hours unsigned integer Access token lifetime (hours)
refresh_tokens_expire boolean Refresh tokens will expire
refresh_token_lifetime_days unsigned integer Refresh token lifetime (days)
max_access_tokens_allowed unsigned integer Maximum access tokens allowed

Get user security settings

GET /system/configuration/user_security_setting

Request Example

curl -g "http://shares.example.com/system/configuration/user_security_setting" -X GET

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"49ede6980b2d5ecaf0cd311a8505cf5a"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 880c155e-3986-4839-9b4e-36fcf61cf075
X-Runtime: 0.042721
Content-Length: 190

Success Response Example

200 OK
{
  "sessions_time_out": false,
  "session_inactivity_timeout_hours": 4,
  "access_token_lifetime_hours": 7,
  "refresh_tokens_expire": false,
  "refresh_token_lifetime_days": 10,
  "max_access_tokens_allowed": 10
}


Create user security settings

POST /system/configuration/user_security_setting

Request Example

curl "http://shares.example.com/system/configuration/user_security_setting" -d '{"sessions_time_out":false,"session_inactivity_timeout_hours":4,"access_token_lifetime_hours":7,"refresh_tokens_expire":false,"refresh_token_lifetime_days":10,"max_access_tokens_allowed":10}' -X POST

Response Headers

X-Frame-Options: SAMEORIGIN
  X-XSS-Protection: 1; mode=block
  X-Content-Type-Options: nosniff
  Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
  Content-Type: application/json; charset=utf-8
  ETag: W/"49ede6980b2d5ecaf0cd311a8505cf5a"
  Cache-Control: max-age=0, private, must-revalidate
  X-Request-Id: db4cda2e-2ab8-4595-aee5-ef1426c66459
  X-Runtime: 0.037630
  Content-Length: 190

Success Response Example

200 OK
{
  "sessions_time_out": false,
  "session_inactivity_timeout_hours": 4,
  "access_token_lifetime_hours": 7,
  "refresh_tokens_expire": false,
  "refresh_token_lifetime_days": 10,
  "max_access_tokens_allowed": 10
  }


Update user security settings

PUT /system/configuration/user_security_setting

Request Example

curl "http://shares.example.com/system/configuration/user_security_setting" -d '{"sessions_time_out":true,"session_inactivity_timeout_hours":6,"access_token_lifetime_hours":7,"refresh_tokens_expire":true,"refresh_token_lifetime_days":6,"max_access_tokens_allowed":5}' -X PUT

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"c46f49ad36c1ae719e653eccc1b988fc"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: b4e99ecb-5fe3-4d91-8d9d-0f5de0efe055
X-Runtime: 0.019863
Content-Length: 186

Success Response Example

200 OK
{
  "sessions_time_out": true,
  "session_inactivity_timeout_hours": 6,
  "access_token_lifetime_hours": 7,
  "refresh_tokens_expire": true,
  "refresh_token_lifetime_days": 6,
  "max_access_tokens_allowed": 5
}

Error Response Example

422 Unprocessable Entity
{
        "errors": {
        "session_inactivity_timeout_hours": [
          "must be less than or equal to 168"
        ],
        "access_token_lifetime_hours": [
          "must be less than or equal to 24"
        ],
        "refresh_token_lifetime_days": [
          "must be less than or equal to 14"
        ]
        }
        }


Delete user security setting

DELETE /system/configuration/user_security_setting

Request Example

curl "http://shares.example.com/system/configuration/user_security_setting" -d '' -X DELETE

Response Headers

X-Frame-Options: SAMEORIGIN
  X-XSS-Protection: 1; mode=block
  X-Content-Type-Options: nosniff
  Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
  Cache-Control: no-cache
  X-Request-Id: 04dc563f-b3de-4c3a-a913-cdd3bc6ff2b7
  X-Runtime: 0.016443

Success Response Example

204 No Content


Web Interfaces

This endpoint allows you to manage web interfaces.

Request Headers

Content-Type: application/json
Accept: application/json
Authorization: Bearer access_token
Host: example.org
Cookie: 

Request Example

curl "http://shares.example.com/system/configuration/web_interfaces/710421772/make_default" -d '' -X POST \
	-H "Content-Type: application/json" \
	-H "Accept: application/json" \
	-H "Authorization: Bearer access_token" \
	-H "Host: example.org" \
	-H "Cookie: "

Success Response Codes

Method Code
GET 200 OK
POST 200 OK
PUT 200 OK

Error Response Codes

Description of error is included in response body.

Method Error Reason
PUT 422 Unprocessable Entity Submitted a parameter with an invalid or empty value

Response Attributes

Name Type Description
host string Host
port unsigned integer Port
tls boolean TLS
description string Description

Get web interfaces

GET /system/configuration/web_interfaces

Request Example

curl -g "http://shares.example.com/system/configuration/web_interfaces" -X GET

Response Headers

X-Frame-Options: SAMEORIGIN
                    X-XSS-Protection: 1; mode=block
                    X-Content-Type-Options: nosniff
                    Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
                    Content-Type: application/json; charset=utf-8
                    Link: 
                    X-Pagination: {"total_count":1,"total_pages":1,"first_page":true,"last_page":true,"previous_page":null,"next_page":null}
                    ETag: W/"cb0efa80db84fcce7e3c06e85023b8e9"
                    Cache-Control: max-age=0, private, must-revalidate
                    X-Request-Id: ad354d69-eed9-46c7-947d-d22c5f751621
                    X-Runtime: 0.014694
                    Content-Length: 114

Success Response Example

200 OK
[
                    {
                      "id": 710421772,
                      "host": "anchorage.alaska",
                      "port": 3000,
                      "tls": true,
                      "description": "Use this for internal networks"
                    }
                    ]


Make a web interface the default

POST /system/configuration/web_interfaces/{id}/make_default

Note: The "id" submitted in the POST request corresponds to the "id" returned from the GET request.

Request Example

curl "http://shares.example.com/system/configuration/web_interfaces/710421772/make_default" -d '' -X POST

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"c65991bcaf6ddc88bc3469577266a374"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 90f5419e-c384-4237-a664-05fa587664a1
X-Runtime: 0.030798
Content-Length: 98

Success Response Example

200 OK
{
  "host": "anchorage.alaska",
  "port": 2345,
  "tls": true,
  "description": "Description for web interface 2"
}


Update a web interface

PUT /system/configuration/web_interfaces/{id}

Request Example

curl "http://shares.example.com/system/configuration/web_interfaces/710421772" -d '{"host":"aspera.com","port":587}' -X PUT

Request Parameters

Name Required/Optional Type Description
host Required string Host
port Optional unsigned integer Port
tls Optional boolean TLS
description Optional string Description

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"082fdbcf532851f214c702aa9a365df8"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: ed552cc2-c536-46ec-9b1d-d18b8f8ed10d
X-Runtime: 0.014751
Content-Length: 90

Success Response Example

200 OK
{
  "host": "aspera.com",
  "port": 587,
  "tls": true,
  "description": "Use this for internal networks"
}

Error Response Example

422 Unprocessable Entity
{
        "errors": {
        "host": [
          "can't be blank"
        ]
        }
        }

Video player

Video

×