Get Configuration

Contents

My Cloud Home system uses a config endpoint to retrieve all service endpoints. The response will return endpoints that your application can use in different scenarios. The commonly used endpoints are as follows:

  
    "service.device.url": Endpoint for finding My Cloud Home device details like Device name, capacity, route URL, etc.
    "service.share.url": Endpoint for sharing My Cloud Home files with other users.
    "service.auth0.url": Endpoint for applications to log in, get user information, change password, etc. All the My Cloud Home APIs enforce authentication and require auth token in request.
    "service.client.url": Endpoint for creating user notifications.
  


Request Syntax


GET /v1/config



Request Headers

This implementation of the operation uses only request headers that are common to all operations

Request Query Parameters

Parameter Description Required
clienttype Value of type: string

Values: nas | portal

Default: nas
false


200 Response

successful operation

Response Payload

Parameter Description Required
data Object of type: Configuration true


Example

Sample request to list unique audio artists.

Request


GET /config/v1/config HTTP/1.1
Host: config.mycloud.com

Response


HTTP/1.1 200 OK
Content-Type: application/json
Etag: "nbt83IkgefJTl-JOWIBYbQ"
Vary: Origin
Date: Fri, 09 Sep 2016 23:42:59 GMT
Content-Length: 324

{
  "error": null,
  "data": {
    "configurationId": "global_default",
    "name": "default",
    "modelId": "0",
    "modifiedOn": 1469574008000,
    "createdOn": 1469574008000,
    "componentMap": {
      "cloud.service.urls": {
        "service.device.url": "https://device.mycloud.com",
        "service.share.url": "https://share.mycloud.com",
        "service.auth0.url": "https://wdc.auth0.com",
        "service.client.url": "https://client.mycloud.com"
      }
    }
  }
}

Have question about this section?