Pulsarr

Get job schedule by name

GET
/v1/scheduler/schedules/{name}

Retrieve a specific job schedule by its name

Authorization

headerX-API-Key<token>

API key authentication using X-API-Key header

Path Parameters

name*string

Response Body

Default Response

application/json
  1. response

A scheduled job and its run state

id*number
name*string
type*string
config*
enabled*boolean
last_run*|null
next_run*|null
created_at*string
updated_at*string
running*boolean

True while a run of the job is in progress

Example Request
curl -X GET 'http://localhost:3003/v1/scheduler/schedules/string'
Example Response
{  "id": 0,  "name": "string",  "type": "interval",  "config": {    "days": 1,    "hours": 1,    "minutes": 1,    "seconds": 1,    "runImmediately": true  },  "enabled": true,  "last_run": {    "time": "string",    "status": "completed",    "error": "string",    "estimated": true  },  "next_run": {    "time": "string",    "status": "completed",    "error": "string",    "estimated": true  },  "created_at": "string",  "updated_at": "string",  "running": true}