Rundeck
Rundeck is a self-hosted job scheduling and runbook automation platform for running operational tasks. Its API exposes jobs, executions, projects, storage/secrets, system settings, and users, letting you automate and monitor operations work programmatically.
Power end-to-end data operations for your Rundeck API with Nexla. Our bi-directional Rundeck connector is purpose-built for Rundeck, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Rundeck or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Rundeck workflows fast, secure, and fully governed.
Features
Type: API
- Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
- Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
- API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
- Request optimization with intelligent batching, retry, and caching to minimize API calls and costs
Prerequisites
Before creating a Rundeck credential, you need the base URL of your self-hosted Rundeck server and a Rundeck API token. Rundeck authenticates API requests with a token sent in the X-Rundeck-Auth-Token header, and all API calls are made against your server at the path $RUNDECK_SERVER_URL/api/[VERSION].
To obtain your credentials, follow these steps:
-
Log in to the Rundeck GUI with a user account that has permission to use the API.
-
Click your username in the header of the page to open your User Profile.
-
In the User API Tokens section, click Generate API Token to create a new token. Optionally set a name/role and expiration according to your organization's policy.
-
Copy the generated token immediately and store it securely. Depending on your Rundeck configuration, the token value may not be shown again after you leave the page.
-
Note your Rundeck server base URL, including the protocol, host, and port (for example,
https://rundeck.example.com:4440). Do not include a trailing slash or the/apipath — Nexla appends the API path automatically.
Treat the API token as a secret: it grants access to your Rundeck jobs, executions, and stored keys based on the permissions of the user or role it is associated with. If a token is compromised, revoke it from the same User Profile page and generate a new one. For detailed information about API authentication, versions, and available endpoints, see the Rundeck API Documentation.
Authenticate
Credentials required
Authenticate with a Rundeck API token, sent as the X-Rundeck-Auth-Token header, against your self-hosted Rundeck server.
| Field | Required | Secret | Description |
|---|---|---|---|
| Rundeck Server Base URL | Yes | No | Your self-hosted Rundeck server URL, e.g. https://rundeck.example.com:4440 (no trailing slash). |
| API Token | Yes | Yes | Rundeck API token, generated from your user profile page in the Rundeck GUI. |
Create a credential in Nexla
-
After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.
-
Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.
-
Enter your Rundeck server URL in the Rundeck Server Base URL field. Include the protocol, host, and port (for example,
https://rundeck.example.com:4440), and omit any trailing slash. -
Enter your Rundeck API token in the API Token field. This token is sent in the
X-Rundeck-Auth-Tokenheader for all API requests and must be kept confidential.If your API token is compromised, revoke it from your Rundeck User Profile page and generate a new one. The token grants access to your Rundeck resources based on the permissions of the associated user or role.
For detailed information about API authentication, versions, and available endpoints, see the Rundeck API Documentation.
-
Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.
Use as a data source
To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Rundeck connector tile, then select the credential that will be used to connect to the Rundeck instance, and click Next; or, create a new Rundeck credential for use in this flow.
Endpoint templates
Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Rundeck endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.
Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.
Manual configuration
Rundeck data sources can also be manually configured to ingest data from any valid Rundeck API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.
Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Rundeck data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.
Use as a destination
Click the + icon on the Nexset that will be sent to the Rundeck destination, and select the Send to Destination option from the menu. Select the Rundeck connector from the list of available destination connectors, then select the credential that will be used to connect to the Rundeck instance, and click Next; or, create a new Rundeck credential for use in this flow.
Endpoint templates
Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Rundeck endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.
Manual configuration
Rundeck destinations can also be manually configured to send data to any valid Rundeck API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.
Save & activate
Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Rundeck endpoint, open the destination resource menu, and select Activate.
The Nexset data will not be sent to the Rundeck endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.