UPDATES - APRIL 2019

 

Dynamic Reference to Auth0

We have identified a documentation error that showed a direct use of the authentication server, Auth0. This was incorrect as this endpoint will be rotated over the next few months. Applications that have this endpoint hard-coded will stop working when the Auto0 address is rotated in the future. Please ensure your application makes use of the dynamic reference to Auth0 obtained from https://config.mycloud.com/config/v1/config. More details can be found here.

 

API Changes

The My Cloud Home hardware will be receiving a software update beyond version 5.0.7-103 as part of our ongoing improvement program, which is expected to occur in the June 2019 timeframe. This software update could impact your application as 1 API has been revised, 2 have changed in favor of other methods, and 4 APIs will no longer be supported. My Cloud Home applications that use these APIs will need updates.

The following symbols are used to describe variables that you would substitute in your application. Note the following presumes you have already been authenticated and have a valid Access Token.

·  {{auth_service}}
   This is the value returned by the Endpoint service.auth0.url

·  {{user_id}}
   This is the ‘sub’ (subscriber id) value returned from the {{auth_service}}/userinfo API

·  {{proxy_url}}
   The Proxy Url is address is a value returned from {{device_service}}/device/v1/user/{{user_id}}

·  {{device_service}}
   This is an endpoint value returned by https://config.mycloud.com/config/v1/config

·  {{external_uri}}
   The External Uri is a value returned by the endpoint {device_service}}/device/v1/user/{{user_id}}

 

1.  GET FILES CONTENT by ID

    [GET]{{proxy_url}}/sdk/v2/files/:id/content

 

The v2 endpoint is being deprecated in favor of v3 and should be migrated to beyond version 5.0.7-103, and will receive continued support in the next release:

    [GET]{{proxy_url}}/sdk/v3/files/:id/content

 

Example:

curl -v -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1N...' 'https://i-0d2bdfdb9bcb725a0.mycloud.com/a55ae22c-6ee6-4af3-92ab-dfb5224d5d38/sdk/v3/files/CPIZ_k595foIQ57wqxJU/content'

 

2.  PATCH A FILE

    [POST]{{proxy_url}}/v2/files/:id/patch

 

The endpoint will no longer be supported at 5.0.9-103 and will be replaced with:

    [PATCH]{{proxy_url}}/v2/files/:id

 

Example:

curl -v -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1N...' -H 'Content-Type: application/json' -X PATCH -d @patch_request 'https://i-0d2bdfdb9bcb725a0.mycloud.com/a55ae22c-6ee6-4af3-92ab-dfb5224d5d38/sdk/v2/files/lLnZzq_mfxYv_TT7GpNT'


NOTE
– When you Patch a file to move into a different folder, you will not see a response.  Use the {{proxy_url}}/sdk/v2/filesSearch/text?qfileextension to see the result of the move.

 

3.  PATCH A RESUMABLE FILE

    [POST]{{proxy_url}}/v2/files/:id/resumable/patch

 

The endpoint will no longer be supported at 5.0.9-103 and will be replaced with:

    [PATCH]{{proxy_url}}/v2/files/:id/resumable

 

Example:

curl -v -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1N...' -H 'Content-Type: application/json' -X PATCH -d '{ "name": "sample2_resume.txt"}' 'https://i-0d2bdfdb9bcb725a0.mycloud.com/a55ae22c-6ee6-4af3-92ab-dfb5224d5d38/sdk/v2/files/gc8qkaXocb1MfHKqUTCx/resumable'

 

4.  SAMPLE MEDIA FILE SEARCH (#get-files-search-media-time-sample)

    [GET]{{proxy_url}}/v2/filesSearch/mediaTimeSample

The endpoint will no longer be supported at 5.0.9-103.

 

5.  CREATE ACTIVITY START (#post-activity-start)

    [POST]{{proxy_url}}/v1/activityStart

The endpoint will no longer be supported at 5.0.9-103.

 

6.  GET ACTIVITIES (#get-activities)

    [POST]{{proxy_url}}/v1/activities

The endpoint will no longer be supported at 5.0.9-103.

 

7.  GET FILES ON ONE ACTIVITY (#get-files-activity)

    [GET]{{proxy_url}}/v1/activities/:id/files

The endpoint will no longer be supported at 5.0.9-103.

 

Do more with the
My Cloud Home SDK & API

Click the buttons below to visit the My Cloud Home Developer Home & Workflow pages

 

Developer
Home

Get started, view SDK & API, build your apps, & learn more


View Home

Developer
Workflow

Register & submit your app for review and contact support


View Workflow