Timers

The timers API allows you to manage timers in Firebot.

GET/timers

List all timers

Retrieves a list of all timers

Request

GET

/timers

curl http://localhost:7472/api/v1/timers

Response

[
  {
    "id": "timer1",
    "name": "Timer 1",
    "active": true
  },
  {
    "id": "timer2",
    "name": "Timer 2",
    "active": false
  }
]

GET/timers/:timerId

Retrieve a timer

Fetches a specific timer by its timerId.

URL Parameters

Name
timerId
Type
string
Description
The unique identifier of the timer

Request

GET

/timers/timer1

curl http://localhost:7472/api/v1/timers/timer1

Response

{
  "id": "timer1",
  "name": "Timer 1",
  "active": true
}

POST/timers/:timerId/enable

Enable a timer

Enables a timer.

URL Parameters

Name
timerId
Type
string
Description
The unique identifier of the timer to enable

Request

POST

/timers/timer1/enable

curl -X POST http://localhost:7472/api/v1/timers/timer1/enable

Response

HTTP Status 200 No Content

POST/timers/:timerId/disable

Disable a timer

Disables a timer.

URL Parameters

Name
timerId
Type
string
Description
The unique identifier of the timer to disable

Request

POST

/timers/timer1/disable

curl -X POST http://localhost:7472/api/v1/timers/timer1/disable

Response

HTTP Status 200 No Content

POST/timers/:timerId/toggle

Toggle a timer

Toggles the active state of a timer.

URL Parameters

Name
timerId
Type
string
Description
The unique identifier of the timer to toggle

Request

POST

/timers/timer1/toggle

curl -X POST http://localhost:7472/api/v1/timers/timer1/toggle

Response

HTTP Status 200 No Content

POST/timers/:timerId/clear

Clear a timer

Clears a timer's interval.

URL Parameters

Name
timerId
Type
string
Description
The unique identifier of the timer to clear

Request

POST

/timers/timer1/clear

curl -X POST http://localhost:7472/api/v1/timers/timer1/clear

Response

HTTP Status 200 No Content