API
API Version Numbers
| Current | Minimum |
|---|---|
40 |
11 |
- Current
- The current version number.
- Minimum
- Minimum supported version.
-
This means you must use at least the API version indicated to access the endpoint, unless otherwise noted. Some features or functionality for the endpoint may only be supported in later versions.
The API Version Number is required to be included in all API calls within the URL.
If the version number is not included or if the requested version number is unsupported, then the API call will fail. The error response will include the code "api-version-unsupported" and have HTTP status code of
400 Bad Request
Authentication
Authentication can be done in two different ways, either with Token based authentication, or with a username and password.
Token Authentication consists of including a string known as an "API Token" with every request to the Rundeck API.
To obtain an API Token, you must first log in to the Rundeck GUI using a user account. Click on your username in the header of the page, and you will be shown your User Profile page. From this page you can manage your API Tokens.
XML and JSON
The API supports both XML and JSON. Some import/export features support YAML or text/plain formatted documents, but XML and JSON are used for all API-level information.
Popular API Commands
No Comments