put https://ioe.droplit.io/v0/api/ecosystems/
Details
Update an ecosystem.
Both account and server tokens may be used to run this endpoint.
Parameters
path
- id (required): The ID of the ecosystem.
body
- domain (optional): The domain of the ecosystem, used as an alias.
- meta (optional): The metadata associated with the ecosystem.
header
- x-system-metadata-prefix (optional): A customized metadata prefix. The default is “$.”
Responses
200
- No content returned, only the status code. See the REST API Standard Responses page.
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.”
- Metadata Format Invalid: The standard error structure defines this error as invalid parameters. In this context, it means that metadata, when specified, should have been formatted as a valid JSON object, and it was not formatted that way.
- Domain Invalid: The standard error structure defines this error as invalid parameters, with an invalid domain. In this context, it means that the domain given does not match its proper format.
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.
Examples
HTTP
PUT https://ioe.droplit.io/api/ecosystems/ECOSYSTEM-ID HTTP/1.1
authorization: TOKEN
content-type: application/json
{
"meta": {}
}
Droplit Console
droplit ecosystem update ECOSYSTEM-ID PROPERTY-NAME PROPERTY-VALUE
Droplit SDK
droplit.ecosystems.update("ECOSYSTEM-ID", META);