Tools

Get one tool's definition

A withdrawn tool answers 404 by default, the same as it is absent from GET /public/tools. Send enabled=false to fetch its record anyway.

get/public/tools/{name}

Request

  • Base URL: https://api.johnsessentials.com/api/v1
  • URL: https://api.johnsessentials.com/api/v1/public/tools/{name}
  • Auth: HTTP bearer

Path parameters

namestring required

Query parameters

enabledboolean

Leave it out (or send anything other than false) and a withdrawn tool answers 404. Send false to receive its record, which carries is_enabled: false. A tool that is offered is returned either way.

Response

Tool definition.

dataunknown
request_idstring uuid required
successboolean required

Example response

{
  "meta": {
    "version": "1.0"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.