Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Warning
titleInternal 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.

Table of Contents

Section

Release one or more seeds

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.

Panel
borderColorblack
bgColor#fafafb

PUT /aspire/_api/worker/release/seed/:id

PUT /aspire/_api/worker/release/seed

Path and Request Body Parameters

NameTypeRequiredDescription
idstringRequiredThe identifier(s) of the seed to be released

Examples

Release a single seed

Code Block
languagejs
themeRDark
PUT /aspire/_api/worker/release/seed/AAABcID5GBc=
 
PUT /aspire/_api/worker/release/seed
{
  "id": ["AAABcID5GBc="]
}

Release multiple seeds

Code Block
languagejs
themeRDark
PUT /aspire/_api/worker/release/seed
{
  "id": ["AAABcID5GBc=", "AAABcIueWUc="]
}

Response

Code Block
languagejs
themeRDark
{
  "message": "optional response message"
}

Status: 200, 404