Scheduler REST Endpoints

Sort by

Task Path Method

Scheduler

The operations from the Scheduler category.

Cancel an ongoing request

Method: post

Path: ess/rest/scheduler/v1/requests/{requestId}/cancel

Cancel callback subscription

Method: delete

Path: ess/rest/scheduler/v1/requests/{requestId}/subscribe

Force cancel an operation

Method: post

Path: ess/rest/scheduler/v1/requests/{requestId}/forceCancel

Get ESS Cluster Quiesce State

Method: get

Path: ess/rest/scheduler/v1/server/quiesceState

Get job request information

Method: get

Path: ess/rest/scheduler/v1/requests/{requestId}

Get permission details

Method: get

Path: ess/rest/scheduler/v1/requests/{requestId}/permissions

Hold operation

Method: post

Path: ess/rest/scheduler/v1/requests/{requestId}/hold

List the resources

Method: get

Path: ess/rest/scheduler/v1

Mark a submitted request as deleted

Method: delete

Path: ess/rest/scheduler/v1/requests/{requestId}

Query job requests

Method: get

Path: ess/rest/scheduler/v1/requests

Query job requests with pageIndex

Method: get

Path: ess/rest/scheduler/v1/requests/search/{pageIndex}

Query job requests with pagination

Method: get

Path: ess/rest/scheduler/v1/query/{application}/requests

Registers the callback URL

Method: post

Path: ess/rest/scheduler/v1/requests/{requestId}/subscribe

Release operation

Method: post

Path: ess/rest/scheduler/v1/requests/{requestId}/release

Set Step Args

Method: post

Path: ess/rest/scheduler/v1/requests/submitArgs

Set the status of the request execution

Method: post

Path: ess/rest/scheduler/v1/requests/{requestId}/executionStatus

Submit a new job request

Method: post

Path: ess/rest/scheduler/v1/requests

Update the scheduler request

Method: patch

Path: ess/rest/scheduler/v1/requests/{requestId}

Validate the cancellation state

Method: post

Path: ess/rest/scheduler/v1/requests/{requestId}/checkInCancelling