Public
Documentation Settings
Select option
Double Column
Select option
Bree API
Introduction
Overview
Authentication
Error Codes
GET
/v1/config
GET
/v1/jobs
POST
/v1/jobs
POST
/v1/start
POST
/v1/start/:jobName
POST
/v1/run/:jobName
POST
/v1/stop
POST
/v1/stop/:jobName
POST
/v1/restart
POST
/v1/restart/:jobName
GET
/v1/sse/:token

Bree API

An API for use with BreeJS

Overview

This is run as a plugin to BreeJS please see README for more information.

Authentication

A JWT Authorization is required.

Error Codes

Status codeDescription
200The request was processed successfully.
422The data sent was incorrect. This will return a specific message describing what went wrong.
5xxThe request failed due to a server error, it's safe to retry later.

GET/v1/config

/v1/config

Get configs for Bree. See Bree docs for more information.

GET/v1/jobs

/v1/jobs

Get jobs including status.

PARAMS
name

Name of a job

status

Status of current job

POST/v1/jobs

/v1/jobs

Add new jobs or duplicate existing jobs

Bodyraw (javascript)
javascript
{
    jobs: [{
        name: string,
        // any other appropriate job options
        // see BreeJS documents
    }],                 // could be an object
    copy?: boolean,     // OPTIONAL when true will duplicate jobs
    start?: boolean,    // OPTIONAL when true will immediately start jobs
}
Loading