{"body": "
\n

# API Reference\u00b6

\n
\n

\n

\n
\n

\n
\n`GET` `/api/workers`\u00b6
\n

  List workers

  \n

  Example request:

  \n

      GET /api/workers HTTP/1.1\nHost: localhost:5555\n

  \n
  \n

  Example response:

  \n

      HTTP/1.1 200 OK\nContent-Length: 1526\nContent-Type: application/json; charset=UTF-8\nDate: Tue, 28 Jul 2015 01:32:38 GMT\nEtag: "fcdd75d85a82b4052275e28871d199aac1ece21c"\nServer: TornadoServer/4.0.2\n\n{\n    "celery@worker1": {\n        "active_queues": [\n            {\n                "alias": null,\n                "auto_delete": false,\n                "binding_arguments": null,\n                "bindings": [],\n                "durable": true,\n                "exchange": {\n                    "arguments": null,\n                    "auto_delete": false,\n                    "delivery_mode": 2,\n                    "durable": true,\n                    "name": "celery",\n                    "passive": false,\n                    "type": "direct"\n                },\n                "exclusive": false,\n                "name": "celery",\n                "no_ack": false,\n                "queue_arguments": null,\n                "routing_key": "celery"\n            }\n        ],\n        "conf": {\n            "CELERYBEAT_SCHEDULE": {},\n            "CELERY_INCLUDE": [\n                "celery.app.builtins",\n                "__main__"\n            ],\n            "CELERY_SEND_TASK_SENT_EVENT": true,\n            "CELERY_TIMEZONE": "UTC"\n        },\n        "registered": [\n            "tasks.add",\n            "tasks.echo",\n            "tasks.error",\n            "tasks.retry",\n            "tasks.sleep"\n        ],\n        "stats": {\n            "broker": {\n                "alternates": [],\n                "connect_timeout": 4,\n                "heartbeat": null,\n                "hostname": "127.0.0.1",\n                "insist": false,\n                "login_method": "AMQPLAIN",\n                "port": 5672,\n                "ssl": false,\n                "transport": "amqp",\n                "transport_options": {},\n                "uri_prefix": null,\n                "userid": "guest",\n                "virtual_host": "/"\n            },\n            "clock": "918",\n            "pid": 90494,\n            "pool": {\n                "max-concurrency": 4,\n                "max-tasks-per-child": "N/A",\n                "processes": [\n                    90499,\n                    90500,\n                    90501,\n                    90502\n                ],\n                "put-guarded-by-semaphore": false,\n                "timeouts": [\n                    0,\n                    0\n                ],\n                "writes": {\n                    "all": "100.00%",\n                    "avg": "100.00%",\n                    "inqueues": {\n                        "active": 0,\n                        "total": 4\n                    },\n                    "raw": "1",\n                    "total": 1\n                }\n            },\n            "prefetch_count": 16,\n            "rusage": {\n                "idrss": 0,\n                "inblock": 211,\n                "isrss": 0,\n                "ixrss": 0,\n                "majflt": 6,\n                "maxrss": 26996736,\n                "minflt": 11450,\n                "msgrcv": 4968,\n                "msgsnd": 1227,\n                "nivcsw": 1367,\n                "nsignals": 0,\n                "nswap": 0,\n                "nvcsw": 1855,\n                "oublock": 93,\n                "stime": 0.414564,\n                "utime": 0.975726\n            },\n            "total": {\n                "tasks.add": 1\n            }\n        },\n        "timestamp": 1438049312.073402\n    }\n}\n

  \n
  \n

  \n\n\n
  \n
  Query Parameters:
  \n
  | \n refresh – run inspect to get updated list of workers \n workername – get info for workername \n status – only get worker status info \n \n\n
  \n
  Request Headers:
  \n
  | \n Authorization – optional OAuth token to authenticate \n \n\n
  \n
  Status Codes: | \n 200 OK – no error \n 401 Unauthorized – unauthorized request \n \n\n
  \n
  \n

  \n

\n\n

\n
\n`POST` `/api/worker/shutdown/(.+)`\u00b6
\n

  Shut down a worker

  \n

  Example request:

  \n

      POST /api/worker/shutdown/celery@worker2 HTTP/1.1\nContent-Length: 0\nHost: localhost:5555\n

  \n
  \n

  Example response:

  \n

      HTTP/1.1 200 OK\nContent-Length: 29\nContent-Type: application/json; charset=UTF-8\n\n{\n    "message": "Shutting down!"\n}\n

  \n
  \n

  \n\n\n
  \n
  Request Headers:
  \n
  | \n Authorization – optional OAuth token to authenticate \n \n\n
  \n
  Status Codes: | \n 200 OK – no error \n 401 Unauthorized – unauthorized request \n 404 Not Found – unknown worker \n \n\n
  \n
  \n

  \n

\n\n

\n
\n`POST` `/api/worker/pool/restart/(.+)`\u00b6
\n

  Restart worker’s pool

  \n

  Example request:

  \n

      POST /api/worker/pool/restart/celery@worker2 HTTP/1.1\nContent-Length: 0\nHost: localhost:5555\n

  \n
  \n

  Example response:

  \n

      HTTP/1.1 200 OK\nContent-Length: 56\nContent-Type: application/json; charset=UTF-8\n\n{\n    "message": "Restarting 'celery@worker2' worker's pool"\n}\n

  \n
  \n

  \n\n\n
  \n
  Request Headers:
  \n
  | \n Authorization – optional OAuth token to authenticate \n \n\n
  \n
  Status Codes: | \n 200 OK – no error \n 401 Unauthorized – unauthorized request \n 403 Forbidden – pool restart is not enabled (see CELERYD_POOL_RESTARTS) \n 404 Not Found – unknown worker \n \n\n
  \n
  \n

  \n

\n\n

\n
\n`POST` `/api/worker/pool/grow/(.+)`\u00b6
\n

  Grow worker’s pool

  \n

  Example request:

  \n

      POST /api/worker/pool/grow/celery@worker2?n=3 HTTP/1.1\nContent-Length: 0\nHost: localhost:5555\n

  \n
  \n

  Example response:

  \n

      HTTP/1.1 200 OK\nContent-Length: 58\nContent-Type: application/json; charset=UTF-8\n\n{\n    "message": "Growing 'celery@worker2' worker's pool by 3"\n}\n

  \n
  \n

  \n\n\n
  \n
  Query Parameters:
  \n
  | \n n – number of pool processes to grow, default is 1 \n \n\n
  \n
  Request Headers:
  \n
  | \n Authorization – optional OAuth token to authenticate \n \n\n
  \n
  Status Codes: | \n 200 OK – no error \n 401 Unauthorized – unauthorized request \n 403 Forbidden – failed to grow \n 404 Not Found – unknown worker \n \n\n
  \n
  \n

  \n

\n\n

\n
\n`POST` `/api/worker/pool/shrink/(.+)`\u00b6
\n

  Shrink worker’s pool

  \n

  Example request:

  \n

      POST /api/worker/pool/shrink/celery@worker2 HTTP/1.1\nContent-Length: 0\nHost: localhost:5555\n

  \n
  \n

  Example response:

  \n

      HTTP/1.1 200 OK\nContent-Length: 60\nContent-Type: application/json; charset=UTF-8\n\n{\n    "message": "Shrinking 'celery@worker2' worker's pool by 1"\n}\n

  \n
  \n

  \n\n\n
  \n
  Query Parameters:
  \n
  | \n n – number of pool processes to shrink, default is 1 \n \n\n
  \n
  Request Headers:
  \n
  | \n Authorization – optional OAuth token to authenticate \n \n\n
  \n
  Status Codes: | \n 200 OK – no error \n 401 Unauthorized – unauthorized request \n 403 Forbidden – failed to shrink \n 404 Not Found – unknown worker \n \n\n
  \n
  \n

  \n

\n\n

\n
\n`POST` `/api/worker/pool/autoscale/(.+)`\u00b6
\n

  Autoscale worker pool

  \n

  Example request:

  \n

      POST /api/worker/pool/autoscale/celery@worker2?min=3&max=10 HTTP/1.1\nContent-Length: 0\nContent-Type: application/x-www-form-urlencoded; charset=utf-8\nHost: localhost:5555\n

  \n
  \n

  Example response:

  \n

      HTTP/1.1 200 OK\nContent-Length: 66\nContent-Type: application/json; charset=UTF-8\n\n{\n    "message": "Autoscaling 'celery@worker2' worker (min=3, max=10)"\n}\n

  \n
  \n

  \n\n\n
  \n
  Query Parameters:
  \n
  | \n min – minimum number of pool processes \n max – maximum number of pool processes \n \n\n
  \n
  Request Headers:
  \n
  | \n Authorization – optional OAuth token to authenticate \n \n\n
  \n
  Status Codes: | \n 200 OK – no error \n 401 Unauthorized – unauthorized request \n 403 Forbidden – autoscaling is not enabled (see CELERYD_AUTOSCALER) \n 404 Not Found – unknown worker \n \n\n
  \n
  \n

  \n

\n\n

\n
\n`POST` `/api/worker/queue/add-consumer/(.+)`\u00b6
\n

  Start consuming from a queue

  \n

  Example request:

  \n

      POST /api/worker/queue/add-consumer/celery@worker2?queue=sample-queue\nContent-Length: 0\nContent-Type: application/x-www-form-urlencoded; charset=utf-8\nHost: localhost:5555\n

  \n
  \n

  Example response:

  \n

      HTTP/1.1 200 OK\nContent-Length: 40\nContent-Type: application/json; charset=UTF-8\n\n{\n    "message": "add consumer sample-queue"\n}\n

  \n
  \n

  \n\n\n
  \n
  Query Parameters:
  \n
  | \n queue – the name of a new queue \n \n\n
  \n
  Request Headers:
  \n
  | \n Authorization – optional OAuth token to authenticate \n \n\n
  \n
  Status Codes: | \n 200 OK – no error \n 401 Unauthorized – unauthorized request \n 403 Forbidden – failed to add consumer \n 404 Not Found – unknown worker \n \n\n
  \n
  \n

  \n

\n\n

\n
\n`POST` `/api/worker/queue/cancel-consumer/(.+)`\u00b6
\n

  Stop consuming from a queue

  \n

  Example request:

  \n

      POST /api/worker/queue/cancel-consumer/celery@worker2?queue=sample-queue\nContent-Length: 0\nContent-Type: application/x-www-form-urlencoded; charset=utf-8\nHost: localhost:5555\n

  \n
  \n

  Example response:

  \n

      HTTP/1.1 200 OK\nContent-Length: 52\nContent-Type: application/json; charset=UTF-8\n\n{\n    "message": "no longer consuming from sample-queue"\n}\n

  \n
  \n

  \n\n\n
  \n
  Query Parameters:
  \n
  | \n queue – the name of queue \n \n\n
  \n
  Request Headers:
  \n
  | \n Authorization – optional OAuth token to authenticate \n \n\n
  \n
  Status Codes: | \n 200 OK – no error \n 401 Unauthorized – unauthorized request \n 403 Forbidden – failed to cancel consumer \n 404 Not Found – unknown worker \n \n\n
  \n
  \n

  \n

\n\n

\n
\n`GET` `/api/tasks`\u00b6
\n

  List tasks

  \n

  Example request:

  \n

      GET /api/tasks HTTP/1.1\nHost: localhost:5555\nUser-Agent: HTTPie/0.8.0\n

  \n
  \n

  Example response:

  \n

      HTTP/1.1 200 OK\nContent-Length: 1109\nContent-Type: application/json; charset=UTF-8\nEtag: "b2478118015c8b825f7b88ce6b660e5449746c37"\nServer: TornadoServer/3.1.1\n\n{\n    "e42ceb2d-8730-47b5-8b4d-8e0d2a1ef7c9": {\n        "args": "[3, 4]",\n        "client": null,\n        "clock": 1079,\n        "eta": null,\n        "exception": null,\n        "exchange": null,\n        "expires": null,\n        "failed": null,\n        "kwargs": "{}",\n        "name": "tasks.add",\n        "received": 1398505411.107885,\n        "result": "'7'",\n        "retried": null,\n        "retries": 0,\n        "revoked": null,\n        "routing_key": null,\n        "runtime": 0.01610181899741292,\n        "sent": null,\n        "started": 1398505411.108985,\n        "state": "SUCCESS",\n        "succeeded": 1398505411.124802,\n        "timestamp": 1398505411.124802,\n        "traceback": null,\n        "uuid": "e42ceb2d-8730-47b5-8b4d-8e0d2a1ef7c9"\n    },\n    "f67ea225-ae9e-42a8-90b0-5de0b24507e0": {\n        "args": "[1, 2]",\n        "client": null,\n        "clock": 1042,\n        "eta": null,\n        "exception": null,\n        "exchange": null,\n        "expires": null,\n        "failed": null,\n        "kwargs": "{}",\n        "name": "tasks.add",\n        "received": 1398505395.327208,\n        "result": "'3'",\n        "retried": null,\n        "retries": 0,\n        "revoked": null,\n        "routing_key": null,\n        "runtime": 0.012884548006695695,\n        "sent": null,\n        "started": 1398505395.3289,\n        "state": "SUCCESS",\n        "succeeded": 1398505395.341089,\n        "timestamp": 1398505395.341089,\n        "traceback": null,\n        "uuid": "f67ea225-ae9e-42a8-90b0-5de0b24507e0"\n    }\n}\n

  \n
  \n

  \n\n\n
  \n
  Query Parameters:
  \n
  | \n limit – maximum number of tasks \n workername – filter task by workername \n taskname – filter tasks by taskname \n state – filter tasks by state \n \n\n
  \n
  Request Headers:
  \n
  | \n Authorization – optional OAuth token to authenticate \n \n\n
  \n
  Status Codes: | \n 200 OK – no error \n 401 Unauthorized – unauthorized request \n \n\n
  \n
  \n

  \n

\n\n

\n
\n`GET` `/api/task/types`\u00b6
\n

  List (seen) task types

  \n

  Example request:

  \n

      GET /api/task/types HTTP/1.1\nHost: localhost:5555\n

  \n
  \n

  Example response:

  \n

      HTTP/1.1 200 OK\nContent-Length: 44\nContent-Type: application/json; charset=UTF-8\n\n{\n    "task-types": [\n        "tasks.add",\n        "tasks.sleep"\n    ]\n}\n

  \n
  \n

  \n\n\n
  \n
  Request Headers:
  \n
  | \n Authorization – optional OAuth token to authenticate \n \n\n
  \n
  Status Codes: | \n 200 OK – no error \n 401 Unauthorized – unauthorized request \n \n\n
  \n
  \n

  \n

\n\n

\n
\n`GET` `/api/task/info/(.*)`\u00b6
\n

  Get a task info

  \n

  Example request:

  \n

      GET /api/task/info/91396550-c228-4111-9da4-9d88cfd5ddc6 HTTP/1.1\nAccept: */*\nAccept-Encoding: gzip, deflate, compress\nHost: localhost:5555\n

  \n
  \n

  Example response:

  \n

      HTTP/1.1 200 OK\nContent-Length: 575\nContent-Type: application/json; charset=UTF-8\n\n{\n    "args": "[2, 2]",\n    "client": null,\n    "clock": 25,\n    "eta": null,\n    "exception": null,\n    "exchange": null,\n    "expires": null,\n    "failed": null,\n    "kwargs": "{}",\n    "name": "tasks.add",\n    "received": 1400806241.970742,\n    "result": "'4'",\n    "retried": null,\n    "retries": null,\n    "revoked": null,\n    "routing_key": null,\n    "runtime": 2.0037889280356467,\n    "sent": null,\n    "started": 1400806241.972624,\n    "state": "SUCCESS",\n    "succeeded": 1400806243.975336,\n    "task-id": "91396550-c228-4111-9da4-9d88cfd5ddc6",\n    "timestamp": 1400806243.975336,\n    "traceback": null,\n    "worker": "celery@worker1"\n}\n

  \n
  \n

  \n\n\n
  \n
  Request Headers:
  \n
  | \n Authorization – optional OAuth token to authenticate \n \n\n
  \n
  Status Codes: | \n 200 OK – no error \n 401 Unauthorized – unauthorized request \n 404 Not Found – unknown task \n \n\n
  \n
  \n

  \n

\n\n

\n
\n`POST` `/api/task/apply/(.+)`\u00b6
\n

  Execute a task by name and wait results

  \n

  Example request:

  \n

      POST /api/task/apply/tasks.add HTTP/1.1\nAccept: application/json\nAccept-Encoding: gzip, deflate, compress\nContent-Length: 16\nContent-Type: application/json; charset=utf-8\nHost: localhost:5555\n\n{\n    "args": [1, 2]\n}\n

  \n
  \n

  Example response:

  \n

      HTTP/1.1 200 OK\nContent-Length: 71\nContent-Type: application/json; charset=UTF-8\n\n{\n    "state": "SUCCESS",\n    "task-id": "c60be250-fe52-48df-befb-ac66174076e6",\n    "result": 3\n}\n

  \n
  \n

  \n\n\n
  \n
  Query Parameters:
  \n
  | \n args – a list of arguments \n kwargs – a dictionary of arguments \n \n\n
  \n
  Request Headers:
  \n
  | \n Authorization – optional OAuth token to authenticate \n \n\n
  \n
  Status Codes: | \n 200 OK – no error \n 401 Unauthorized – unauthorized request \n 404 Not Found – unknown task \n \n\n
  \n
  \n

  \n

\n\n

\n
\n`POST` `/api/task/async-apply/(.+)`\u00b6
\n

  Execute a task

  \n

  Example request:

  \n

      POST /api/task/async-apply/tasks.add HTTP/1.1\nAccept: application/json\nAccept-Encoding: gzip, deflate, compress\nContent-Length: 16\nContent-Type: application/json; charset=utf-8\nHost: localhost:5555\n\n{\n    "args": [1, 2]\n}\n

  \n
  \n

  Example response:

  \n

      HTTP/1.1 200 OK\nContent-Length: 71\nContent-Type: application/json; charset=UTF-8\nDate: Sun, 13 Apr 2014 15:55:00 GMT\n\n{\n    "state": "PENDING",\n    "task-id": "abc300c7-2922-4069-97b6-a635cc2ac47c"\n}\n

  \n
  \n

  \n\n\n
  \n
  Query Parameters:
  \n
  | \n args – a list of arguments \n kwargs – a dictionary of arguments \n options – a dictionary of apply_async keyword arguments \n \n\n
  \n
  Request Headers:
  \n
  | \n Authorization – optional OAuth token to authenticate \n \n\n
  \n
  Status Codes: | \n 200 OK – no error \n 401 Unauthorized – unauthorized request \n 404 Not Found – unknown task \n \n\n
  \n
  \n

  \n

\n\n

\n
\n`POST` `/api/task/send-task/(.+)`\u00b6
\n

  Execute a task by name (doesn’t require task sources)

  \n

  Example request:

  \n

      POST /api/task/send-task/tasks.add HTTP/1.1\nAccept: application/json\nAccept-Encoding: gzip, deflate, compress\nContent-Length: 16\nContent-Type: application/json; charset=utf-8\nHost: localhost:5555\n\n{\n    "args": [1, 2]\n}\n

  \n
  \n

  Example response:

  \n

      HTTP/1.1 200 OK\nContent-Length: 71\nContent-Type: application/json; charset=UTF-8\n\n{\n    "state": "SUCCESS",\n    "task-id": "c60be250-fe52-48df-befb-ac66174076e6"\n}\n

  \n
  \n

  \n\n\n
  \n
  Query Parameters:
  \n
  | \n args – a list of arguments \n kwargs – a dictionary of arguments \n \n\n
  \n
  Request Headers:
  \n
  | \n Authorization – optional OAuth token to authenticate \n \n\n
  \n
  Status Codes: | \n 200 OK – no error \n 401 Unauthorized – unauthorized request \n 404 Not Found – unknown task \n \n\n
  \n
  \n

  \n

\n\n

\n
\n`GET` `/api/task/result/(.+)`\u00b6
\n

  Get a task result

  \n

  Example request:

  \n

      GET /api/task/result/c60be250-fe52-48df-befb-ac66174076e6 HTTP/1.1\nHost: localhost:5555\n

  \n
  \n

  Example response:

  \n

      HTTP/1.1 200 OK\nContent-Length: 84\nContent-Type: application/json; charset=UTF-8\n\n{\n    "result": 3,\n    "state": "SUCCESS",\n    "task-id": "c60be250-fe52-48df-befb-ac66174076e6"\n}\n

  \n
  \n

  \n\n\n
  \n
  Query Parameters:
  \n
  | \n timeout – how long to wait, in seconds, before the operation times out \n \n\n
  \n
  Request Headers:
  \n
  | \n Authorization – optional OAuth token to authenticate \n \n\n
  \n
  Status Codes: | \n 200 OK – no error \n 401 Unauthorized – unauthorized request \n 503 Service Unavailable – result backend is not configured \n \n\n
  \n
  \n

  \n

\n\n

\n
\n`POST` `/api/task/abort/(.+)`\u00b6
\n

  Abort a running task

  \n

  Example request:

  \n

      POST /api/task/abort/c60be250-fe52-48df-befb-ac66174076e6 HTTP/1.1\nHost: localhost:5555\n

  \n
  \n

  Example response:

  \n

      HTTP/1.1 200 OK\nContent-Length: 61\nContent-Type: application/json; charset=UTF-8\n\n{\n    "message": "Aborted '1480b55c-b8b2-462c-985e-24af3e9158f9'"\n}\n

  \n
  \n

  \n\n\n
  \n
  Request Headers:
  \n
  | \n Authorization – optional OAuth token to authenticate \n \n\n
  \n
  Status Codes: | \n 200 OK – no error \n 401 Unauthorized – unauthorized request \n 503 Service Unavailable – result backend is not configured \n \n\n
  \n
  \n

  \n

\n\n

\n
\n`POST` `/api/task/timeout/(.+)`\u00b6
\n

  Change soft and hard time limits for a task

  \n

  Example request:

  \n

      POST /api/task/timeout/tasks.sleep HTTP/1.1\nContent-Length: 44\nContent-Type: application/x-www-form-urlencoded; charset=utf-8\nHost: localhost:5555\n\nsoft=30&hard=100&workername=celery%40worker1\n

  \n
  \n

  Example response:

  \n

      HTTP/1.1 200 OK\nContent-Length: 46\nContent-Type: application/json; charset=UTF-8\n\n{\n    "message": "new rate limit set successfully"\n}\n

  \n
  \n

  \n\n\n
  \n
  Query Parameters:
  \n
  | \n workername – worker name \n \n\n
  \n
  Request Headers:
  \n
  | \n Authorization – optional OAuth token to authenticate \n \n\n
  \n
  Status Codes: | \n 200 OK – no error \n 401 Unauthorized – unauthorized request \n 404 Not Found – unknown task/worker \n \n\n
  \n
  \n

  \n

\n\n

\n
\n`POST` `/api/task/rate-limit/(.+)`\u00b6
\n

  Change rate limit for a task

  \n

  Example request:

  \n

      POST /api/task/rate-limit/tasks.sleep HTTP/1.1\nContent-Length: 41\nContent-Type: application/x-www-form-urlencoded; charset=utf-8\nHost: localhost:5555\n\nratelimit=200&workername=celery%40worker1\n

  \n
  \n

  Example response:

  \n

      HTTP/1.1 200 OK\nContent-Length: 61\nContent-Type: application/json; charset=UTF-8\n\n{\n    "message": "Revoked '1480b55c-b8b2-462c-985e-24af3e9158f9'"\n}\n

  \n
  \n

  \n\n\n
  \n
  Query Parameters:
  \n
  | \n workername – worker name \n \n\n
  \n
  Request Headers:
  \n
  | \n Authorization – optional OAuth token to authenticate \n \n\n
  \n
  Status Codes: | \n 200 OK – no error \n 401 Unauthorized – unauthorized request \n 404 Not Found – unknown task/worker \n \n\n
  \n
  \n

  \n

\n\n

\n
\n`POST` `/api/task/revoke/(.+)`\u00b6
\n

  Revoke a task

  \n

  Example request:

  \n

      POST /api/task/revoke/1480b55c-b8b2-462c-985e-24af3e9158f9?terminate=true\nContent-Length: 0\nContent-Type: application/x-www-form-urlencoded; charset=utf-8\nHost: localhost:5555\n

  \n
  \n

  Example response:

  \n

      HTTP/1.1 200 OK\nContent-Length: 61\nContent-Type: application/json; charset=UTF-8\n\n{\n    "message": "Revoked '1480b55c-b8b2-462c-985e-24af3e9158f9'"\n}\n

  \n
  \n

  \n\n\n
  \n
  Query Parameters:
  \n
  | \n terminate – terminate the task if it is running \n \n\n
  \n
  Request Headers:
  \n
  | \n Authorization – optional OAuth token to authenticate \n \n\n
  \n
  Status Codes: | \n 200 OK – no error \n 401 Unauthorized – unauthorized request \n \n\n
  \n
  \n

  \n

\n\n
\n", "alabaster_version": "0.7.7", "display_toc": false, "title": "API Reference", "sourcename": "api.txt", "customsidebar": null, "metatags": "", "current_page_name": "api", "next": {"link": "../auth/", "title": "Authentication"}, "rellinks": [["auth", "Authentication", "N", "next"], ["tasks_filter", "Tasks filtering", "P", "previous"]], "meta": {}, "parents": [], "sidebars": ["sidebarlogo.html", "localtoc.html", "relations.html", "sourcelink.html", "searchbox.html"], "toc": "

\n
- API Reference
\n

\n", "prev": {"link": "../tasks_filter/", "title": "Tasks filtering"}, "page_source_suffix": ".rst"}