Page in development
This page is in development and as such, its contents may be incorrect
Internal API
This is an internal API used for communication between nodes and is not expected to be used by others
The worker node API provides functionality that allows a manager and worker nodes to communicate.
Releases all the items currently not being processed, setting their status to be available, so the worker node stops processing a seed promptly when that seed is paused/stopped, this endpoint need the at least the ADMINISTRATOR or MANAGER role to be executed.
PUT /aspire/_api/worker/release/seed/:id
PUT /aspire/_api/worker/release/seed
Path and Request Body Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier(s) of the seed to be released |
Examples
Release a single seed
PUT /aspire/_api/worker/release/seed/AAABcID5GBc= PUT /aspire/_api/worker/release/seed { "id": ["AAABcID5GBc="] }
Release multiple seeds
PUT /aspire/_api/worker/release/seed { "id": ["AAABcID5GBc=", "AAABcIueWUc="] }
Response
{ "message": "optional response message" }
Status
Response code | Description |
---|---|
200 | Success |
404 | The given seed id was not found |