Versions Compared

Old Version 5

changes.mady.by.user Steve Denny

Saved on

compared with

New Version Current

changes.mady.by.user Petr Podsednik

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Warning
titlePage in development

This page is in development and as such, its contents may be incorrect

Warning
titleInternal API

This is an internal API used for communication between nodes and is not expected to be used by others

The manager worker node API provides functionality that allows a manager and worker nodes to communicate.

toc
Easy Heading Free
navigationTitleOn this Page
navigationExpandOptionexpand-all-by-default

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

POST /aspire/_api/manager/release/seed/:id

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

PUT /aspire/_api/managerworker/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="
},
{
  "id": "AAABcIueWUc="]
}]

ResponseRelease multiple seeds (alternative form)

Code Block
languagejs
themeRDark
{
  "idmessage": ["AAABcID5GBc=", "AAABcIueWUc="]
}"optional response message"
}

Status: 200, 404


The given seed id was not found

: 200, 404


Section

Throttle notification (Aspire 5.3)

Releases all the items currently not being processed, setting their status to be available, this endpoint need the at least the ADMINISTRATOR or MANAGER role to be executed.

Panel
borderColorblack
bgColor#fafafb

PUT /aspire/_api/worker/throttle/:seedId

Path and Request Body Parameters

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

Examples

Code Block
languagejs
themeRDark
PUT /aspire/_api/worker/throttle/AAABcID5GBc=

Response

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

Status

Response codeDescription
200Success
404