{"info":{"_postman_id":"c8fce5f1-54be-4d4f-9e2f-00d9dfab4d33","name":"Bree API","description":"

An API for use with BreeJS

\n

Overview

\n

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

\n

Authentication

\n

A JWT Authorization is required.

\n

Error Codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
\n
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"Error Codes","slug":"error-codes"}],"owner":"17142435","collectionId":"c8fce5f1-54be-4d4f-9e2f-00d9dfab4d33","publishedId":"TzzDLbNG","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-08-23T14:44:41.000Z"},"item":[{"name":"/v1/config","id":"58cfcb3e-e008-411e-b5e3-3da9c3f4a021","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"/v1/config","description":"

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

\n","urlObject":{"path":["v1","config"],"query":[],"variable":[]}},"response":[],"_postman_id":"58cfcb3e-e008-411e-b5e3-3da9c3f4a021"},{"name":"/v1/jobs","id":"4aa9e143-7309-4b31-a8fe-5f562a6faf7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"/v1/jobs","description":"

Get jobs including status.

\n","urlObject":{"path":["v1","jobs"],"query":[{"disabled":true,"description":{"content":"

Name of a job

\n","type":"text/plain"},"key":"name","value":null},{"disabled":true,"description":{"content":"

Status of current job

\n","type":"text/plain"},"key":"status","value":null}],"variable":[]}},"response":[],"_postman_id":"4aa9e143-7309-4b31-a8fe-5f562a6faf7f"},{"name":"/v1/jobs","id":"0a5ba7cf-0b65-4caa-b9cd-721409b660e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n jobs: [{\n name: string,\n // any other appropriate job options\n // see BreeJS documents\n }], // could be an object\n copy?: boolean, // OPTIONAL when true will duplicate jobs\n start?: boolean, // OPTIONAL when true will immediately start jobs\n}","options":{"raw":{"language":"javascript"}}},"url":"/v1/jobs","description":"

Add new jobs or duplicate existing jobs

\n","urlObject":{"path":["v1","jobs"],"query":[],"variable":[]}},"response":[],"_postman_id":"0a5ba7cf-0b65-4caa-b9cd-721409b660e6"},{"name":"/v1/start","id":"4c8ad0d9-ec9d-4259-8723-4dfb42dee022","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"/v1/start","description":"

Start all jobs. This will setup schedules.

\n","urlObject":{"path":["v1","start"],"query":[],"variable":[]}},"response":[],"_postman_id":"4c8ad0d9-ec9d-4259-8723-4dfb42dee022"},{"name":"/v1/start/:jobName","id":"547a123a-228d-4b0d-bf1d-49d077149cac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"/v1/start/:jobName","description":"

Start a specific job. This will setup schedules.

\n","urlObject":{"path":["v1","start",":jobName"],"query":[],"variable":[{"id":"70b985b0-b682-42b1-a8cb-daa1e4e6648d","type":"any","key":"jobName"}]}},"response":[],"_postman_id":"547a123a-228d-4b0d-bf1d-49d077149cac"},{"name":"/v1/run/:jobName","id":"38c77be7-f1a4-4d2c-b499-df151cd5c434","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"/v1/run/:jobName","description":"

Run a specific job. This will run immediately and not setup schedules.

\n","urlObject":{"path":["v1","run",":jobName"],"query":[],"variable":[{"id":"1b60e768-63d9-4e9c-83ca-dab60d28e760","type":"any","key":"jobName"}]}},"response":[],"_postman_id":"38c77be7-f1a4-4d2c-b499-df151cd5c434"},{"name":"/v1/stop","id":"da036d23-c9a6-4c7e-8319-d78ffd7c6761","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"/v1/stop","description":"

Stop all jobs.

\n","urlObject":{"path":["v1","stop"],"query":[],"variable":[]}},"response":[],"_postman_id":"da036d23-c9a6-4c7e-8319-d78ffd7c6761"},{"name":"/v1/stop/:jobName","id":"75314b18-9c7c-441c-a2fa-293834e9f07c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"/v1/stop/:jobName","description":"

Stop a specific job.

\n","urlObject":{"path":["v1","stop",":jobName"],"query":[],"variable":[{"id":"8f9614b4-530c-4812-9af4-33d0c5229e19","type":"any","key":"jobName"}]}},"response":[],"_postman_id":"75314b18-9c7c-441c-a2fa-293834e9f07c"},{"name":"/v1/restart","id":"ce00d635-b542-4eb7-bf89-27e095b6168a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"/v1/restart","description":"

Restart all jobs.

\n","urlObject":{"path":["v1","restart"],"query":[],"variable":[]}},"response":[],"_postman_id":"ce00d635-b542-4eb7-bf89-27e095b6168a"},{"name":"/v1/restart/:jobName","id":"46535c56-5217-478d-b69c-583e38bd538d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"/v1/restart/:jobName","description":"

Retart a specific job. This will setup schedules.

\n","urlObject":{"path":["v1","restart",":jobName"],"query":[],"variable":[{"id":"70b985b0-b682-42b1-a8cb-daa1e4e6648d","type":"any","key":"jobName"}]}},"response":[],"_postman_id":"46535c56-5217-478d-b69c-583e38bd538d"},{"name":"/v1/sse/:token","id":"76ef6a2c-9338-4867-8ae6-222a4c03efaf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v1/sse/:token","description":"

Server-sent events endpoint for worker created and worker deleted events.

\n","urlObject":{"path":["v1","sse",":token"],"query":[],"variable":[{"description":{"content":"

JWT Token

\n","type":"text/plain"},"type":"any","value":null,"key":"token"}]}},"response":[],"_postman_id":"76ef6a2c-9338-4867-8ae6-222a4c03efaf"}],"event":[{"listen":"prerequest","script":{"id":"02489cbf-1dc9-4b57-9309-f4f5650f1de6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ff1f2906-cd1b-498e-bbf3-dc181ab97d97","type":"text/javascript","exec":[""]}}]}