Komrade's HTTP API

komrade-api.md

Komrade

Komrade is a message queue for your workers. Komrade will help you manage background jobs for web applications.

HTTP based queueing service.

• PUT Job
• POST Job's Heartbeat
• PUT Job Failure
• GET Jobs
• DELETE Job
• POST Delete All Jobs

PUT Job

> PUT https://service-1.komrade.io/jobs/:uuid
> Authorization: b64
> {"payload": {}}
< {"id": id, "payload": {}}

POST Job's Heartbeat

> POST https://service-1.komrade.io/jobs/:uuid/heartbeats
> Authorization: b64
< {"message": "OK"}

PUT Job Failure

> PUT https://service-1.komrade.io/jobs/:uuid/failures/:failure-id
> Authorization: b64
> {"error": "DBError", "message": "Table does not exist."}
< {"id": failure-id}

GET Jobs

> GET https://service-1.komrade.io/jobs?limit=1
> Authorization: b64
< [{"id": id, "payload": {}}]

DELETE Job

> DELETE https://service-1.komrade.io/jobs/:uuid
> Authorization: b64
< [{"id": id}]

POST Delete All Jobs

> POST https://service-1.komrade.io/delete-all-jobs
> Authorization: b64
< {"deleted": 42}

POST Worker's Heartbeat

> POST https://service-1.komrade.io/workers/:uuid/heartbeats
> Authorization: b64
< {"msg": "OK"}

Clients

• Ruby client