goose/api_clients/bash/docs/ScheduleApi.md

ScheduleApi

All URIs are relative to **

Method	HTTP request	Description
createSchedule	POST /schedule/create
deleteSchedule	DELETE /schedule/delete/{id}
inspectRunningJob	GET /schedule/{id}/inspect
killRunningJob	POST /schedule/{id}/kill
listSchedules	GET /schedule/list
pauseSchedule	POST /schedule/{id}/pause
runNowHandler	POST /schedule/{id}/run_now
sessionsHandler	GET /schedule/{id}/sessions
unpauseSchedule	POST /schedule/{id}/unpause
updateSchedule	PUT /schedule/{id}

createSchedule

Example

goose-api createSchedule

Parameters

Name	Type	Description	Notes
createScheduleRequest	CreateScheduleRequest

Return type

ScheduledJob

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteSchedule

Example

goose-api deleteSchedule id=value

Parameters

Name	Type	Description	Notes
id	string	ID of the schedule to delete	[default to null]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not Applicable
• Accept: Not Applicable

[Back to top] [Back to API list] [Back to Model list] [Back to README]

inspectRunningJob

Example

goose-api inspectRunningJob id=value

Parameters

Name	Type	Description	Notes
id	string	ID of the schedule to inspect	[default to null]

Return type

InspectJobResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not Applicable
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

killRunningJob

Example

goose-api killRunningJob id=value

Parameters

Name	Type	Description	Notes
id	string		[default to null]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not Applicable
• Accept: Not Applicable

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listSchedules

Example

goose-api listSchedules

Parameters

This endpoint does not need any parameter.

Return type

ListSchedulesResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not Applicable
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pauseSchedule

Example

goose-api pauseSchedule id=value

Parameters

Name	Type	Description	Notes
id	string	ID of the schedule to pause	[default to null]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not Applicable
• Accept: Not Applicable

[Back to top] [Back to API list] [Back to Model list] [Back to README]

runNowHandler

Example

goose-api runNowHandler id=value

Parameters

Name	Type	Description	Notes
id	string	ID of the schedule to run	[default to null]

Return type

RunNowResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not Applicable
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sessionsHandler

Example

goose-api sessionsHandler id=value  limit=value

Parameters

Name	Type	Description	Notes
id	string	ID of the schedule	[default to null]
limit	integer		[optional] [default to null]

Return type

array[SessionDisplayInfo]

Authorization

No authorization required

HTTP request headers

• Content-Type: Not Applicable
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unpauseSchedule

Example

goose-api unpauseSchedule id=value

Parameters

Name	Type	Description	Notes
id	string	ID of the schedule to unpause	[default to null]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not Applicable
• Accept: Not Applicable

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateSchedule

Example

goose-api updateSchedule id=value

Parameters

Name	Type	Description	Notes
id	string	ID of the schedule to update	[default to null]
updateScheduleRequest	UpdateScheduleRequest

Return type

ScheduledJob

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]