Skip to content

cloud-manual-register.md

Latest commit

 

History

History
66 lines (48 loc) · 1.27 KB

cloud-manual-register.md

File metadata and controls

66 lines (48 loc) · 1.27 KB
Raw
description Manually register a workspace

Cloud Manual Register

URL Requires Auth HTTP Method
api/v1/cloud.manualRegister YES POST

Headers

Argument Example Required Description
X-User-Id myuser-name Required Your username hash (returned after you log in through the API)
X-Auth-Token myauth-token Required Your token (returned after you log in through the API)

Example Call

curl --location --request POST 'http://localhost:3000/api/v1/cloud.manualRegister\
--header 'X-Auth-Token: myauth-token' \
--header 'X-User-Id: myuser-name'
 -d "cloudBlob="

Result

Success

{
    "success": True,
    
}

Errors

Any of the following errors can occur upon the endpoint.

  • Authorization: Requires an authentication token for the request to be made.
  • Registration Status: Requires a new (non-registered) for the request to be made.

{% tabs %} {% tab title=" Authorization" %}

{
    "success": false,
    "error": "unauthorized"
}

{% endtab %}

{% tab title="Registration Status" %}

{
    "success": false,
    "error": "Workspace is already registered"
}

{% endtab %} {% endtabs %}