{ "added": "2020-08-04T11:05:46.892Z", "info": { "contact": { "email": "dev@rudder.io", "name": "Rudder developers", "url": "https://www.rudder.io" }, "description": "Download OpenAPI specification: [openapi.yml](openapi.yml)\n\n# Introduction\n\nRudder exposes a REST API, enabling the user to interact with Rudder without using the webapp, for example in scripts or cronjobs.\n\n## Versioning\n\nEach time the API is extended with new features (new functions, new parameters, new responses, ...), it will be assigned a new version number. This will allow you\nto keep your existing scripts (based on previous behavior). Versions will always be integers (no 2.1 or 3.3, just 2, 3, 4, ...) or `latest`.\n\nYou can change the version of the API used by setting it either within the url or in a header:\n\n* the URL: each URL is prefixed by its version id, like `/api/version/function`.\n\n```bash\n# Version 10\ncurl -X GET -H \"X-API-Token: yourToken\" https://rudder.example.com/rudder/api/10/rules\n# Latest\ncurl -X GET -H \"X-API-Token: yourToken\" https://rudder.example.com/rudder/api/latest/rules\n# Wrong (not an integer) => 404 not found\ncurl -X GET -H \"X-API-Token: yourToken\" https://rudder.example.com/rudder/api/3.14/rules\n```\n\n* the HTTP headers. You can add the **X-API-Version** header to your request. The value needs to be an integer or `latest`.\n\n```bash\n# Version 10\ncurl -X GET -H \"X-API-Token: yourToken\" -H \"X-API-Version: 10\" https://rudder.example.com/rudder/api/rules\n# Wrong => Error response indicating which versions are available\ncurl -X GET -H \"X-API-Token: yourToken\" -H \"X-API-Version: 3.14\" https://rudder.example.com/rudder/api/rules\n```\n\nIn the future, we may declare some versions as deprecated, in order to remove them in a later version of Rudder, but we will never remove any versions without warning, or without a safe\nperiod of time to allow migration from previous versions.\n\n\n

Existing versions

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
VersionRudder versions it appeared inDescription
1Never released (for internal use only)Experimental version
2 to 10 (deprecated)4.3 and beforeThese versions provided the core set of API features for rules, directives, nodes global parameters, change requests and compliance, rudder settings and system API
115.0New system API (replacing old localhost v1 api): status, maintenance operations and server behavior
126.0 and 6.1Node key management
136.2
    \n
  • Node status endpoint
    • \n
  • System health check
    • \n
  • System maintenance job to purge software [that endpoint was back-ported in 6.1]
    • \n
147.0
    \n
  • Secret management
    • \n
  • Directive tree
    • \n
  • Improve techniques management
    • \n
  • Demote a relay
    • \n
157.1
    \n
  • Package updates in nodes
    • \n
167.2
    \n
  • Create node API included from plugin
    • \n
  • Configuration archive import/export
    • \n
\n\n\n## Response format\n\nAll responses from the API are in the JSON format.\n\n```json\n{\n \"action\": \"The name of the called function\",\n \"id\": \"The ID of the element you want, if relevant\",\n \"result\": \"The result of your action: success or error\",\n \"data\": \"Only present if this is a success and depends on the function, it's usually a JSON object\",\n \"errorDetails\": \"Only present if this is an error, it contains the error message\"\n}\n```\n\n\n* __Success__ responses are sent with the 200 HTTP (Success) code\n\n* __Error__ responses are sent with a HTTP error code (mostly 5xx...)\n\n\n## HTTP method\n\nRudder's REST API is based on the usage of [HTTP methods](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html). We use them to indicate what action will be done by the request. Currently, we use four of them:\n\n\n* **GET**: search or retrieve information (get rule details, get a group, ...)\n\n* **PUT**: add new objects (create a directive, clone a Rule, ...)\n\n* **DELETE**: remove objects (delete a node, delete a parameter, ...)\n\n* **POST**: update existing objects (update a directive, reload a group, ...)\n\n\n## Parameters\n\n### General parameters\n\nSome parameters are available for almost all API functions. They will be described in this section.\nThey must be part of the query and can't be submitted in a JSON form.\n\n#### Available for all requests\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
FieldTypeDescription
prettifyboolean
optional		\n Determine if the answer should be prettified (human friendly) or not. We recommend using this for debugging purposes, but not for general script usage as this does add some unnecessary load on the server side.\n

Default value: false

\n
\n\n\n#### Available for modification requests (PUT/POST/DELETE)\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
FieldTypeDescription
reasonstring
optional or required		\n Set a message to explain the change. If you set the reason messages to be mandatory in the web interface, failing to supply this value will lead to an error.\n

Default value: \"\"

\n
changeRequestNamestring
optional		\n Set the change request name, is used only if workflows are enabled. The default value depends on the function called\n

Default value: A default string for each function

\n
changeRequestDescriptionstring
optional		\n Set the change request description, is used only if workflows are enabled.\n

Default value: \"\"

\n
\n\n\n### Passing parameters\n\nParameters to the API can be sent:\n\n* As part of the URL for resource identification\n\n* As data for POST/PUT requests\n\n * Directly in JSON format\n\n * As request arguments\n\n#### As part of the URL for resource identification\n\nParameters in URLs are used to indicate which resource you want to interact with. The function will not work if this resource is missing.\n\n```bash\n# Get the Rule of ID \"id\"\ncurl -H \"X-API-Token: yourToken\" https://rudder.example.com/rudder/api/latest/rules/id\n```\n\n\n\nCAUTION: To avoid surprising behavior, do not put a '/' at the end of an URL: it would be interpreted as '/[empty string parameter]' and redirected to '/index', likely not what you wanted to do.\n\n\n#### Sending data for POST/PUT requests\n\n##### Directly in JSON format\n\nJSON format is the preferred way to interact with Rudder API for creating or updating resources.\nYou'll also have to set the *Content-Type* header to **application/json** (without it the JSON content would be ignored).\nIn a `curl` `POST` request, that header can be provided with the `-H` parameter:\n\n```bash\ncurl -X POST -H \"Content-Type: application/json\" ...\n```\n\nThe supplied file must contain a valid JSON: strings need quotes, booleans and integers don't, etc.\n\nThe (human readable) format is:\n\n```json\n{\n \"key1\": \"value1\",\n \"key2\": false,\n \"key3\": 42\n}\n```\n\n\nHere is an example with inlined data:\n\n```bash\n# Update the Rule 'id' with a new name, disabled, and setting it one directive\ncurl -X POST -H \"X-API-Token: yourToken\" -H \"Content-Type: application/json\"\nhttps://rudder.example.com/rudder/api/rules/latest/{id}\n -d '{ \"displayName\": \"new name\", \"enabled\": false, \"directives\": \"directiveId\"}'\n```\n\nYou can also pass a supply the JSON in a file:\n\n```bash\n# Update the Rule 'id' with a new name, disabled, and setting it one directive\ncurl -X POST -H \"X-API-Token: yourToken\" -H \"Content-Type: application/json\" https://rudder.example.com/rudder/api/rules/latest/{id} -d @jsonParam\n```\n\nNote that the general parameters view in the previous chapter cannot be passed in a JSON, and you will need to pass them a URL parameters if you want them to be taken into account (you can't mix JSON and request parameters):\n\n```bash\n# Update the Rule 'id' with a new name, disabled, and setting it one directive with reason message \"Reason used\"\ncurl -X POST -H \"X-API-Token: yourToken\" -H \"Content-Type: application/json\" \"https://rudder.example.com/rudder/api/rules/latest/{id}?reason=Reason used\" -d @jsonParam -d \"reason=Reason ignored\"\n```\n\n##### Request parameters\n\nIn some cases, when you have little, simple data to update, JSON can feel bloated. In such cases, you can use\nrequest parameters. You will need to pass one parameter for each data you want to change.\n\nParameters follow the following schema:\n\n```\nkey=value\n```\n\nYou can pass parameters by two means:\n\n* As query parameters: At the end of your url, put a **?** then your first parameter and then a **&** before next parameters. In that case, parameters need to be https://en.wikipedia.org/wiki/Percent-encoding[URL encoded]\n\n```bash\n# Update the Rule 'id' with a new name, disabled, and setting it one directive\ncurl -X POST -H \"X-API-Token: yourToken\" https://rudder.example.com/rudder/api/rules/latest/{id}?\"displayName=my new name\"&\"enabled=false\"&\"directives=aDirectiveId\"\n```\n\n* As request data: You can pass those parameters in the request data, they won't figure in the URL, making it lighter to read, You can pass a file that contains data.\n\n```bash\n# Update the Rule 'id' with a new name, disabled, and setting it one directive (in file directive-info.json)\ncurl -X POST -H \"X-API-Token: yourToken\"\nhttps://rudder.example.com/rudder/api/rules/latest/{id} -d \"displayName=my new name\" -d \"enabled=false\" -d @directive-info.json\n```\n", "license": { "name": "CC-BY-SA 2.0", "url": "https://spdx.org/licenses/CC-BY-SA-2.0.html" }, "title": "Rudder API", "version": "16", "x-apisguru-categories": [ "developer_tools" ], "x-logo": { "url": "https://api.apis.guru/v2/cache/logo/https_www.rudder.io_wp-content_uploads_2019_11_color_logo_horizontal_dark_bg-1024x176.png" }, "x-origin": [ { "format": "openapi", "url": "https://docs.rudder.io/api/openapi.yml", "version": "3.0" } ], "x-providerName": "rudder.example.local" }, "externalDocs": { "description": "Learn more about Rudder.", "url": "https://docs.rudder.io" }, "updated": "2023-03-06T07:12:59.965Z", "swaggerUrl": "https://api.apis.guru/v2/specs/rudder.example.local/16/openapi.json", "swaggerYamlUrl": "https://api.apis.guru/v2/specs/rudder.example.local/16/openapi.yaml", "openapiVer": "3.0.3", "link": "https://api.apis.guru/v2/specs/rudder.example.local/16.json" }