{"_id":"59c32ab22262d50032e94161","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":19,"createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","categories":["59a7236e3fe4d90025117c10","59a72eb6cb0db3001b84cfe2","59a734eb757d030019b85af8","59c0243b1b2d07001a9d2b76","59c035e42126e10028effb12","59c06c40df5b3c0010584a13","59c1a5852cabe5002641a3e7","59c2fb00b2b45c0010b7a3d7","59c32ceb9aea850010ac4130","59c32e6e190c90003cb0d12f","59c33affb2b45c0010b7aa23","59c7dfa457bd8200105444dc","59c7e975c50cf30010d712a0","59cffdef0cd4dd0010294d54","59d0622ca91a810032c8f60c","59d06733c1aec60026253065","59d174d44ac471001a07b123","59d5a5e323e6e800103defb2","59ecf1d8ed507c001c52b255"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.0","version":"0"},"category":{"_id":"59c2fb00b2b45c0010b7a3d7","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-20T23:34:24.298Z","from_sync":false,"order":12,"slug":"environments-api","title":"Environments API"},"user":"58cc41f21751ce2f003be3b7","__v":2,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-21T02:57:54.007Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[]},"results":{"codes":[]},"settings":"59a75f6e757d030019b85f83","auth":"required","params":[{"_id":"59c32ab22262d50032e94163","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"claimCode"},{"_id":"59c32ab22262d50032e94162","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"claimType"}],"url":"/claim"},"isReference":false,"order":11,"body":"# Details\n\nClaim an environment as a user.\n\nIf a user claims an environment, they can control Edge devices in that environment. This endpoint associates the user represented by the token with the Edge device given. The claim code is the Edge ID the user wishes to control. The claim type, for now, must be “edgeId.”\n\nA user token may be used to run this endpoint.\n\n# Parameters\n\n## body\n\n- claimCode (required): The The ID of the Edge server.\n- claimType (required): The claim code type. For now, this must be “edgeId.”\n\n# Responses\n\n## 200\n\n- No content returned, only the status code. See the REST API [Standard Responses](https://docs.droplit.io/docs/rest-api-standard-responses) page.\n\n## 400\n\n- __Body Parameters Missing:__ The standard error structure defines this error as invalid parameters, and contains all required body parameters. If this error occurs when the JSON structure of the body parameters is syntactically correct, this means that the “content-type” header is incorrectly specified. The content-type header should be “application/json.”\n- __No Query String Allowed:__ The standard error structure defines this error as invalid parameters, with additional parameters in the query string. In this context, it means that no query string is allowed at all when calling this endpoint.\n- __Claim Type Invalid:__ This error means that the claim type given was not valid. Since the claim codes are Edge IDs, the claim type must be “edgeId.”\n\n## 404\n\n- __Claim Not Found:__ This error means that a claim with the given ID was not found.\n\n# Examples\n\n## HTTP\n\n```\nPOST https://ioe.droplit.io/api/environments/claim HTTP/1.1\nauthorization: TOKEN\ncontent-type: application/json\n{\n    \"claimCode\": \"CLAIM-CODE\",\n    \"claimType\": \"CLAIM-TYPE\"\n}\n```\n\n## Droplit Console\n\n```\nThis functionality does not exist in the Droplit console.\n```","excerpt":"","slug":"environments-claim","type":"endpoint","title":"Claim an environment as a user."}

postClaim an environment as a user.


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

claimCode:
required
string
claimType:
required
string

Documentation

# Details Claim an environment as a user. If a user claims an environment, they can control Edge devices in that environment. This endpoint associates the user represented by the token with the Edge device given. The claim code is the Edge ID the user wishes to control. The claim type, for now, must be “edgeId.” A user token may be used to run this endpoint. # Parameters ## body - claimCode (required): The The ID of the Edge server. - claimType (required): The claim code type. For now, this must be “edgeId.” # Responses ## 200 - No content returned, only the status code. See the REST API [Standard Responses](https://docs.droplit.io/docs/rest-api-standard-responses) page. ## 400 - __Body Parameters Missing:__ The standard error structure defines this error as invalid parameters, and contains all required body parameters. If this error occurs when the JSON structure of the body parameters is syntactically correct, this means that the “content-type” header is incorrectly specified. The content-type header should be “application/json.” - __No Query String Allowed:__ The standard error structure defines this error as invalid parameters, with additional parameters in the query string. In this context, it means that no query string is allowed at all when calling this endpoint. - __Claim Type Invalid:__ This error means that the claim type given was not valid. Since the claim codes are Edge IDs, the claim type must be “edgeId.” ## 404 - __Claim Not Found:__ This error means that a claim with the given ID was not found. # Examples ## HTTP ``` POST https://ioe.droplit.io/api/environments/claim HTTP/1.1 authorization: TOKEN content-type: application/json { "claimCode": "CLAIM-CODE", "claimType": "CLAIM-TYPE" } ``` ## Droplit Console ``` This functionality does not exist in the Droplit console. ```

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}