Skip to content

Latest commit

 

History

History
221 lines (132 loc) · 4.59 KB

api-slaves.md

File metadata and controls

221 lines (132 loc) · 4.59 KB
Raw

Overview

Manages Singularity slaves.

POST /api/slaves/slave/{slaveId}/freeze

Freeze tasks on a specific slave

Parameters

path

Parameter Required Description Data Type
slaveId true Slave ID string
body
Parameter Required Description Data Type
body false SingularityMachineChangeRequest
Response
Errors
Status Code Reason Response Model
- - -

DELETE /api/slaves/slave/{slaveId}/expiring

Delete any expiring machine state changes for this slave

Parameters

path

Parameter Required Description Data Type
slaveId true Active slaveId string
Response
Errors
Status Code Reason Response Model
- - -

GET /api/slaves/slave/{slaveId}/details

Get information about a particular slave

Parameters

path

Parameter Required Description Data Type
slaveId true Slave ID string
Response

SingularitySlave

Errors
Status Code Reason Response Model
- - -

POST /api/slaves/slave/{slaveId}/decommission

Begin decommissioning a specific active slave

Parameters

path

Parameter Required Description Data Type
slaveId true Active slaveId string
body
Parameter Required Description Data Type
body false SingularityMachineChangeRequest
Response
Errors
Status Code Reason Response Model
- - -

POST /api/slaves/slave/{slaveId}/activate

Activate a decomissioning slave, canceling decomission without erasing history

Parameters

path

Parameter Required Description Data Type
slaveId true Active slaveId string
body
Parameter Required Description Data Type
body false SingularityMachineChangeRequest
Response
Errors
Status Code Reason Response Model
- - -

GET /api/slaves/slave/{slaveId}

Retrieve the history of a given slave

Parameters

path

Parameter Required Description Data Type
slaveId true Slave ID string
Response

List[SingularityMachineStateHistoryUpdate]

Errors
Status Code Reason Response Model
- - -

DELETE /api/slaves/slave/{slaveId}

Remove a known slave, erasing history. This operation will cancel decomissioning of the slave

Parameters

path

Parameter Required Description Data Type
slaveId true Active SlaveId string
Response
Errors
Status Code Reason Response Model
- - -

GET /api/slaves/expiring

Get all expiring state changes for all slaves

Parameters
  • No parameters
Response

List[SingularityExpiringMachineState]

Errors
Status Code Reason Response Model
- - -

GET /api/slaves/

Retrieve the list of all known slaves, optionally filtering by a particular state

Parameters

query

Parameter Required Description Data Type
state false Optionally specify a particular state to filter slaves by string
Response

List[SingularitySlave]

Errors
Status Code Reason Response Model
- - -