{"_id":"59c1e859b378260038611cdd","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":"59c1a5852cabe5002641a3e7","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-19T23:17:25.014Z","from_sync":false,"order":11,"slug":"ecosystems-a","title":"Ecosystems API"},"user":"58cc41f21751ce2f003be3b7","__v":5,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-20T04:02:33.871Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[]},"results":{"codes":[]},"settings":"59a75ffc4836990031f5ec2f","auth":"required","params":[{"_id":"59c1e859b378260038611cdf","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"id"},{"_id":"59c1e859b378260038611cde","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"edgeId"}],"url":"/:id/claims"},"isReference":false,"order":6,"body":"# Details\n\nCreate a server ecosystem claim.\n\nAn account token may be used to run this endpoint.\n\n# Parameters\n\n## path\n\n- id (required): The ID of the [ecosystem](https://docs.droplit.io/docs/containers#section-ecosystems).\n\n## body\n\n- edgeId (required): The ID of the Edge server.\n\n# Responses\n\n## 201\n\n```\n{\n    \"claimType\": \"CLAIM-TYPE\",\n    \"ecosystemId\": \"ECOSYSTEM-ID\",\n    \"edgeId\": \"EDGE-ID\",\n    \"environmentId\": \"ENVIRONMENT-ID\",\n    \"id\": \"ECOSYSTEM-ID;EDGE-ID;CLAIM-TYPE\"\n}\n```\n\n## 400\n\n- __Ecosystem Invalid:__ The standard error structure defines this error as invalid parameters, with an invalid ID linked to the parameter that designates the ecosystem ID. In this context, it means that the ID given for an ecosystem was not valid.\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- __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\n## 404\n\n- __Ecosystem Not Found:__ This error means that an ecosystem with the given ID was not found. This is distinct from an invalid ecosystem ID being specified; this means that the ecosystem ID once existed, but no longer does.\n- __Edge ID Invalid:__ The standard error structure defines this error as invalid parameters, with an invalid ID. In this context, it means that the Edge ID given is not valid.\n\n# Examples\n\n## HTTP\n\n```\nPOST https://ioe.droplit.io/api/ecosystems/ECOSYSTEM-ID/claims HTTP/1.1\nauthorization: TOKEN\ncontent-type: application/json\n{\n    \"edgeId\": \"EDGE-ID\"\n}\n```\n\n## Droplit Console\n\n```\ndroplit ecosystem create-claim ECOSYSTEM-ID EDGE-ID\n```","excerpt":"","slug":"ecosystems-claims-create","type":"endpoint","title":"Create a server ecosystem claim."}

postCreate a server ecosystem claim.


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string

Body Params

edgeId:
required
string

Documentation

# Details Create a server ecosystem claim. An account token may be used to run this endpoint. # Parameters ## path - id (required): The ID of the [ecosystem](https://docs.droplit.io/docs/containers#section-ecosystems). ## body - edgeId (required): The ID of the Edge server. # Responses ## 201 ``` { "claimType": "CLAIM-TYPE", "ecosystemId": "ECOSYSTEM-ID", "edgeId": "EDGE-ID", "environmentId": "ENVIRONMENT-ID", "id": "ECOSYSTEM-ID;EDGE-ID;CLAIM-TYPE" } ``` ## 400 - __Ecosystem Invalid:__ The standard error structure defines this error as invalid parameters, with an invalid ID linked to the parameter that designates the ecosystem ID. In this context, it means that the ID given for an ecosystem was not valid. - __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. - __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.” ## 404 - __Ecosystem Not Found:__ This error means that an ecosystem with the given ID was not found. This is distinct from an invalid ecosystem ID being specified; this means that the ecosystem ID once existed, but no longer does. - __Edge ID Invalid:__ The standard error structure defines this error as invalid parameters, with an invalid ID. In this context, it means that the Edge ID given is not valid. # Examples ## HTTP ``` POST https://ioe.droplit.io/api/ecosystems/ECOSYSTEM-ID/claims HTTP/1.1 authorization: TOKEN content-type: application/json { "edgeId": "EDGE-ID" } ``` ## Droplit Console ``` droplit ecosystem create-claim ECOSYSTEM-ID EDGE-ID ```

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 }}