Rundeck (version v1.*.*)

Rundeck Platform API v34

abort_execution#

Abort a running execution.

Parameters

execution_id (required)#

Type: string

asUser#

specifies a username identifying the user who aborted the execution. Requires runAs permission.

Type: string

async_export_archive_for_project#

Export a zip archive of the project asynchronously. Requires export authorization for the project. Use the Token result to query the export status with get_status_for_async_project_export, and retrieve the result once ready with get_result_for_async_project_export.

Parameters

project_id (required)#

Type: string

executionIds#

A list (comma-separated) of execution IDs. If this is specified then the archive will contain only executions that are specified, and will not contain Jobs, ACLs, or project configuration/readme files.

Type: array

[ "string" ]

exportAcls#

Whether or not to include project ACL Policy files, if authorized

Type: boolean

exportAll#

Whether or not to include all project contents

Type: boolean

exportConfigs#

Whether or not to include project configuration

Type: boolean

exportExecutions#

Whether or not to include executions

Type: boolean

exportJobs#

Whether or not to include executions

Type: boolean

exportReadmes#

Whether or not to include project readme/motd files

Type: boolean

exportScm#

Whether or not to include project SCM configuration, if authorized

Type: boolean

exportWebhooks#

Whether or not to include project webhooks in the archive

Type: boolean

whkIncludeAuthTokens#

Whether or not to include the auth token information when exporting webhooks. If not included the auth tokens will be regenerated upon import.

Type: boolean

bulk_delete_executions#

Bulk Delete Executions

Parameters

ids#

list of Execution IDs to include

Type: array

[ "string" ]

bulk_disable_execution_for_jobs#

Bulk disable job execution

Parameters

idlist#

list of Job IDs to include

Type: array

[ "string" ]

bulk_disable_schedules_for_jobs#

Bulk disable job scheduling

Parameters

idlist#

list of Job IDs to include

Type: array

[ "string" ]

bulk_enable_execution_for_jobs#

Bulk enable job execution

Parameters

idlist#

list of Job IDs to include

Type: array

[ "string" ]

bulk_enable_schedules_for_jobs#

Bulk enable job scheduling

Parameters

idlist#

list of Job IDs to include

Type: array

[ "string" ]

configure_scm_plugin_for_project#

Configure and enable a plugin for a project. The request body is expected to contain entries for all of the required input fields for the plugin. If a validation error occurs with the configuration, then the response will include detail about the errors.

Parameters

integration_id (required)#

Type: string

project_id (required)#

Type: string

type_id (required)#

Type: string

$body#

Type: object

{
  "config" : { }
}

create_acl_for_project#

Create a project ACL policy. The policy should be in YAML format, wrapped into a JSON object.

Parameters

acl_name (required)#

Type: string

project_id (required)#

Type: string

$body#

Type: object

{
  "content" : "string"
}

create_acl_policy#

Create an ACL Policy. The policy should be in YAML format, wrapped into a JSON object.

Parameters

$body#

Type: object

{
  "content" : "string"
}

create_project#

Project Creation

Parameters

$body#

Type: object

{
  "name" : "string",
  "description" : "string",
  "id" : "integer",
  "config" : { },
  "url" : "string"
}

create_token_for_user#

Create a new token for a specific user. Specify custom roles and duration if authorized.

Parameters

$body#

Type: object

{
  "duration" : "string",
  "roles" : [ "string" ],
  "user" : "string"
}

create_webhook#

Add A Webhook

Parameters

project_id (required)#

Type: string

$body#

Type: object

{
  "roles" : "string",
  "name" : "string",
  "project" : "string",
  "eventPlugin" : "string",
  "id" : "integer",
  "config" : { },
  "enabled" : "boolean"
}

delete_acl_for_project#

Delete a Project ACL Policy

Parameters

acl_name (required)#

Type: string

project_id (required)#

Type: string

delete_acl_policy#

Delete an ACL Policy

This operation has no parameters

delete_all_executions_for_job#

Delete all Executions for a Job

Parameters

job_id (required)#

Type: string

delete_bulk_jobs#

Bulk Job Delete

Parameters

idlist#

list of Job IDs to include

Type: array

[ "string" ]

delete_execution#

Delete an execution by ID.

Parameters

execution_id (required)#

Type: string

delete_job#

Deleting a Job Definition

Parameters

job_id (required)#

Type: string

delete_key#

Delete Keys

Parameters

file_id (required)#

Type: string

Potential values: readme.md, motd.md

path_id (required)#

Type: string

Content-type#

type of key

Type: string

Potential values: application/octet-stream, application/pgp-keys, application/x-rundeck-data-password

delete_motd#

Remove MOTD file

Parameters

project_id (required)#

Type: string

delete_project#

Delete an existing projects on the server. Requires 'delete' authorization.

Parameters

project_id (required)#

Type: string

delete_readme#

Remove README file

Parameters

project_id (required)#

Type: string

delete_token#

Delete a token

Parameters

token_id (required)#

Type: string

delete_value_for_configuration_key_for_project#

Delete a configuration key.

Parameters

key_id (required)#

Type: string

project_id (required)#

Type: string

delete_webhook#

Delete A Webhook

Parameters

project_id (required)#

Type: string

webhook_id (required)#

Type: string

disable_execution_mode#

Disables executions, preventing adhoc and manual and scheduled jobs from running.

This operation has no parameters

disable_executions_for_job#

Disable Executions for a Job

Parameters

job_id (required)#

Type: string

disable_scheduling_for_job#

Disable Scheduling for a Job

Parameters

job_id (required)#

Type: string

disable_scm_plugin_for_project#

Disable SCM for a project.

Parameters

integration_id (required)#

Type: string

project_id (required)#

Type: string

type_id (required)#

Type: string

enable_execution_mode#

Enables executions, allowing adhoc and manual and scheduled jobs to be run.

This operation has no parameters

enable_executions_for_job#

Enable Executions for a Job

Parameters

job_id (required)#

Type: string

enable_scheduling_for_job#

Enable Scheduling for a Job

Parameters

job_id (required)#

Type: string

enable_scm_plugin_for_project#

Enable SCM for a project.

Parameters

integration_id (required)#

Type: string

project_id (required)#

Type: string

type_id (required)#

Type: string

export_archive_for_project#

Export a zip archive of the project. Requires export authorization for the project. Performs the export synchronously.

Parameters

project_id (required)#

Type: string

executionIds#

Type: array

[ "string" ]

exportAcls#

Whether or not to include project ACL Policy files, if authorized

Type: boolean

exportAll#

Whether or not to include all project contents

Type: boolean

exportConfigs#

Whether or not to include project configuration

Type: boolean

exportExecutions#

Whether or not to include executions

Type: boolean

exportJobs#

Whether or not to include executions

Type: boolean

exportReadmes#

Whether or not to include project readme/motd files

Type: boolean

exportScm#

Whether or not to include project SCM configuration, if authorized

Type: boolean

exportWebhooks#

Whether or not to include project webhooks in the archive

Type: boolean

whkIncludeAuthTokens#

Whether or not to include the auth token information when exporting webhooks. If not included the auth tokens will be regenerated upon import.

Type: boolean

export_jobs#

Export the job definitions for in XML or YAML formats.

Parameters

project_id (required)#

Type: string

format#

can be "xml" or "yaml" to specify the output format. Default is "xml"

Type: string

Potential values: xml, yaml

groupPath#

specify a group or partial group path to include all jobs within that group path.

Type: string

idlist#

list of Job IDs to include

Type: array

[ "string" ]

jobFilter#

specify a filter for the job Name.

Type: string

get_acl_for_project#

Get a Project ACL Policy

Parameters

acl_name (required)#

Type: string

project_id (required)#

Type: string

get_acl_policy#

Retrieve the YAML text of the ACL Policy file. If YAML or text content is requested, the contents will be returned directly. Otherwise if XML or JSON is requested, the YAML text will be wrapped within that format.

This operation has no parameters

get_config_for_scm_plugin_for_project#

Get SCM config for a project.

Parameters

integration_id (required)#

Type: string

project_id (required)#

Type: string

get_configuration_for_project#

GET Project Configuration

Parameters

project_id (required)#

Type: string

get_current_execution_mode#

Gets the current execution mode. Additionally, if the current mode is passive the response status will be HTTP 503 - Service Unavailable.

This operation has no parameters

get_current_user#

Get the current user's profile

This operation has no parameters

get_diff_for_scm_plugin_for_job#

Retrieve the file diff for the Job, if there are changes for the integration. The format of the diff content depends on the specific plugin. For the Git plugins, a unified diff format is used.

Parameters

integration_id (required)#

Type: string

job_id (required)#

Type: string

get_execution#

Get the status for an execution by ID.

Parameters

execution_id (required)#

Type: string

get_forecast_for_job#

Get a forecast for a specific amount of days of the job by ID.

Parameters

job_id (required)#

Type: string

max#

Type: integer

past#

true to return an inverse forecast, that is, considering the current scheduler, when it should have run.

Type: boolean

time#

Time lapse to search the forecast (default is 1d). The format is "XY" where X is an integer, and "Y" is one of "s|n|h|d|w|m|y".

Type: string

get_healthcheck#

Returns results of some health checks.

This operation has no parameters

get_info_for_uploaded_file#

Get Info About an Uploaded File

Parameters

file_id (required)#

Type: string

Potential values: readme.md, motd.md

get_job#

Export a single job definition in XML or YAML formats.

Parameters

job_id (required)#

Type: string

format#

Type: string

Potential values: xml, yaml

get_key#

Get key contents or metadata. If Accept header is set to / or application/pgp-keys, public key content is returned.

Parameters

file_id (required)#

Type: string

Potential values: readme.md, motd.md

path_id (required)#

Type: string

Accept#

Provides the public key content if the Accept request header matches / or application/pgp-keys.

Type: string

Content-type#

type of key

Type: string

Potential values: application/octet-stream, application/pgp-keys, application/x-rundeck-data-password

get_log_storage#

Get Log Storage information and stats.

This operation has no parameters

get_metadata_for_job#

Get Job Metadata

Parameters

job_id (required)#

Type: string

get_metrics_data#

Return the metrics data.

This operation has no parameters

get_metrics_for_queried_executions#

Execution Query Metrics

This operation has no parameters

get_metrics_for_queried_executions_in_project#

Execution Query Metrics

Parameters

project_id (required)#

Type: string

abortedbyFilter#

Username who aborted an execution

Type: string

adhoc#

If true, include only Adhoc executions, if false return only Job executions.

Type: boolean

begin#

Specify exact date for earliest execution completion time. The format for the end, and begin filters is either a unix millisecond timestamp, or a W3C dateTime string in the format "yyyy-MM-ddTHH:mm:ssZ".

Type: string

end#

Specify exact date for latest execution completion time

Type: string

excludeGroupPath#

specify a group or partial group path to exclude all jobs within that group path. Set to the special value "-" to match the top level jobs only.

Type: string

excludeGroupPathExact#

specify an exact group path to exclude. Set to the special value "-" to match the top level jobs only.

Type: string

excludeJobExactFilter#

specify an exact job name to exclude.

Type: string

excludeJobFilter#

specify a filter for the job Name. Exclude any job name that matches this value.

Type: string

excludeJobIdListFilter#

specify a Job ID to exclude, can be specified multiple times

Type: string

excludeJobListFilter#

specify a full Job group/name to exclude, can be specified multiple times. the job's group and name separated by a '/' character, such as "group1/job name", or "my job" if there is no group.

Type: string

executionTypeFilter#

specify the execution type

Type: string

Potential values: scheduled, user, user-scheduled

groupPath#

specify a group or partial group path to include all jobs within that group path. Set to the special value "-" to match the top level jobs only.

Type: string

groupPathExact#

specify an exact group path to match. Set to the special value "-" to match the top level jobs only.

Type: string

jobExactFilter#

specify an exact job name to match.

Type: string

jobFilter#

specify a filter for the job Name. Include any job name that matches this value.

Type: string

jobIdListFilter#

specify a Job ID to include, can be specified multiple times

Type: string

jobListFilter#

specify a full Job group/name to include, can be specified multiple times. the job's group and name separated by a '/' character, such as "group1/job name", or "my job" if there is no group.

Type: string

olderFilter#

(same format as recentFilter) return executions that completed before the specified relative period of time. E.g. a value of 30d returns executions older than 30 days.

Type: string

recentFilter#

Use a simple text format to filter executions that completed within a period of time. The format is "XY" where X is an integer, and "Y" is one of h|d|w|m|y. So a value of 2w would return executions that completed within the last two weeks.

Type: string

statusFilter#

execution status

Type: string

Potential values: running, succeeded, failed, aborted

userFilter#

Username who started the execution

Type: string

get_motd#

Get MOTD file

Parameters

project_id (required)#

Type: string

get_output_for_execution#

Get the output for an execution by ID. The execution can be currently running or may have already completed.

Parameters

execution_id (required)#

Type: string

compacted#

if true, results will be in compacted form.

Type: boolean

format#

output format

Type: string

Potential values: json, xml, text

lastlines#

number of lines to retrieve from the end of the available output. If specified it will override the offset value and return only the specified number of lines at the end of the log.

Type: integer

lastmod#

epoch datestamp in milliseconds, return results only if modification changed since the specified date OR if more data is available at the given offset

Type: number

maxlines#

maximum number of lines to retrieve forward from the specified offset.

Type: integer

offset#

byte offset to read from in the file. 0 indicates the beginning.

Type: integer

get_output_for_node_in_execution#

Get the output for a node in an execution by ID. The execution can be currently running or may have already completed.

Parameters

execution_id (required)#

Type: string

node_id (required)#

Type: string

compacted#

if true, results will be in compacted form.

Type: boolean

format#

output format

Type: string

Potential values: json, xml, text

lastlines#

number of lines to retrieve from the end of the available output. If specified it will override the offset value and return only the specified number of lines at the end of the log.

Type: integer

lastmod#

epoch datestamp in milliseconds, return results only if modification changed since the specified date OR if more data is available at the given offset

Type: number

maxlines#

maximum number of lines to retrieve forward from the specified offset.

Type: integer

offset#

byte offset to read from in the file. 0 indicates the beginning.

Type: integer

get_output_for_step_in_execution#

Get the output for a workflow step in an execution by ID. The execution can be currently running or may have already completed.

Parameters

execution_id (required)#

Type: string

stepctx_id (required)#

Type: string

compacted#

if true, results will be in compacted form.

Type: boolean

format#

output format

Type: string

Potential values: json, xml, text

lastlines#

number of lines to retrieve from the end of the available output. If specified it will override the offset value and return only the specified number of lines at the end of the log.

Type: integer

lastmod#

epoch datestamp in milliseconds, return results only if modification changed since the specified date OR if more data is available at the given offset

Type: number

maxlines#

maximum number of lines to retrieve forward from the specified offset.

Type: integer

offset#

byte offset to read from in the file. 0 indicates the beginning.

Type: integer

get_output_for_step_in_node_in_execution#

Get the output for a step in a node in execution by ID. The execution can be currently running or may have already completed.

Parameters

execution_id (required)#

Type: string

node_id (required)#

Type: string

stepctx_id (required)#

Type: string

compacted#

if true, results will be in compacted form.

Type: boolean

format#

output format

Type: string

Potential values: json, xml, text

lastlines#

number of lines to retrieve from the end of the available output. If specified it will override the offset value and return only the specified number of lines at the end of the log.

Type: integer

lastmod#

epoch datestamp in milliseconds, return results only if modification changed since the specified date OR if more data is available at the given offset

Type: number

maxlines#

maximum number of lines to retrieve forward from the specified offset.

Type: integer

offset#

byte offset to read from in the file. 0 indicates the beginning.

Type: integer

get_project#

Get information about a project.

Parameters

project_id (required)#

Type: string

get_readme#

Get README file

Parameters

project_id (required)#

Type: string

get_resource_for_project#

Getting Resource Info

Parameters

name_id (required)#

Type: string

project_id (required)#

Type: string

format#

Result format. Can use "xml", "yaml" or "json", or an installed ResourceFormat plugin name.

Type: string

get_result_for_async_export#

Get the result of an async export request.

Parameters

project_id (required)#

Type: string

token_id (required)#

Type: string

get_source_for_project#

/api/34/project/{project_id}/source/{index_id}

Parameters

index_id (required)#

Type: string

project_id (required)#

Type: string

get_state_for_execution#

Get detail about the node and step state of an execution by ID. The execution can be currently running or completed.

Parameters

execution_id (required)#

Type: string

stateOnly#

Type: boolean

get_status_for_async_export#

Get the status of an async export request.

Parameters

project_id (required)#

Type: string

token_id (required)#

Type: string

get_status_of_scm_plugin_for_job#

Get SCM status for a Job

Parameters

integration_id (required)#

Type: string

job_id (required)#

Type: string

get_status_of_scm_plugin_for_project#

Get SCM status for a project.

Parameters

integration_id (required)#

Type: string

project_id (required)#

Type: string

get_system_info#

System Info

This operation has no parameters

get_token#

Get a specified auth token.

Parameters

token_id (required)#

Type: string

get_user#

Get another user's profile

Parameters

user_id (required)#

Type: string

get_value_for_configuration_key_for_project#

Retrieve the value for a configuration key.

Parameters

key_id (required)#

Type: string

project_id (required)#

Type: string

get_webhook#

Get A Webhook

Parameters

project_id (required)#

Type: string

webhook_id (required)#

Type: string

get_workflow_for_job#

Get the workflow tree for a job. It will traverse referenced jobs to a depth of 3.

Parameters

job_id (required)#

Type: string

import_jobs#

Import job definitions in XML or YAML formats.

Parameters

project_id (required)#

Type: string

$body#

Type: object

{
  "scheduleEnabled" : "boolean",
  "scheduled" : "boolean",
  "name" : "string",
  "index" : "number",
  "project" : "string",
  "description" : "string",
  "id" : "string",
  "href" : "string",
  "permalink" : "string",
  "enabled" : "boolean",
  "group" : "string"
}

Content-Type#

Type: string

Potential values: x-www-form-urlencoded, multipart/form-data, application/xml, application/yaml

dupeOption#

A value to indicate the behavior when importing jobs which already exist.

Type: string

Potential values: skip, create, update

fileformat#

Type: string

Potential values: xml, yaml

uuidOption#

Whether to preserve or remove UUIDs from the imported jobs.

Type: string

Potential values: preserve, remove

list_acl_policies#

List System ACL Policies

This operation has no parameters

list_acls_for_project#

List Project ACL Policies

Parameters

project_id (required)#

Type: string

list_all_tokens#

List all tokens.

This operation has no parameters

list_event_history_for_project#

List the event history for a project.

Parameters

project_id (required)#

Type: string

begin#

Type: string

end#

Specify exact date for latest execution completion time

Type: string

excludeJobListFilter#

exclude events for the job by name, format 'group/name'. To use multiple values, include this parameter multiple times.

Type: string

jobIdFilter#

Include events for a job ID.

Type: string

jobListFilter#

include events for the job by name, format 'group/name'. To use multiple values, include this parameter multiple times.

Type: string

recentFilter#

Type: string

reportIdFilter#

Include events for an event Name.

Type: string

statFilter#

include events based on result status.

Type: string

Potential values: succeed, fail, cancel

userFilter#

include events created by a user

Type: string

list_executions_for_job#

List executions for a job

Parameters

job_id (required)#

Type: string

status#

the status of executions you want to be returned. If this parameter is blank or unset, include all executions.

Type: string

Potential values: succeeded, failed, aborted, running

list_executions_with_incomplete_log_storage#

List all executions with incomplete log storage.

This operation has no parameters

list_files_uploaded_for_job#

List Files Uploaded for a Job

Parameters

job_id (required)#

Type: string

fileState#

state of file upload record

Type: string

Potential values: temp, deleted, expired, retained

list_input_fields_for_scm_action#

Get the input fields and selectable items for a specific action.

Parameters

action_id (required)#

Type: string

integration_id (required)#

Type: string

project_id (required)#

Type: string

list_input_fields_for_scm_action_for_job#

Get the input fields and selectable items for a specific action for a job.

Parameters

action_id (required)#

Type: string

integration_id (required)#

Type: string

job_id (required)#

Type: string

list_input_fields_for_scm_plugin#

Get SCM plugin setup input fields.

Parameters

integration_id (required)#

Type: string

project_id (required)#

Type: string

type_id (required)#

Type: string

list_input_files_for_execution#

List Input Files for an Execution

Parameters

execution_id (required)#

Type: string

list_installed_plugins#

List Installed Plugins

This operation has no parameters

list_jobs_for_project#

List the jobs that exist for a project.

Parameters

project_id (required)#

Type: string

groupPath#

specify a group or partial group path to include all jobs within that group path. (Default value: "*", all groups). Set to the special value "-" to match the top level jobs only

Type: string

groupPathExact#

specify an exact group path to match. Set to the special value "-" to match the top level jobs only

Type: string

idlist#

list of Job IDs to include

Type: array

[ "string" ]

jobExactFilter#

specify an exact job name to match.

Type: string

jobFilter#

specify a filter for the job Name. Matches any job name that contains this value.

Type: string

scheduledFilter#

specify whether to return only scheduled or only not scheduled jobs.

Type: boolean

serverNodeUUIDFilter#

In cluster mode, use to select scheduled jobs assigned to the server with given UUID.

Type: string

list_keys#

List keys

Parameters

path_id (required)#

Type: string

list_metrics#

List Metrics

This operation has no parameters

list_projects#

List existing projects

This operation has no parameters

list_resources_for_project#

List all resources for a project

Parameters

project_id (required)#

Type: string

filter#

url-encoded string in form of "attribute: value attribute2: value2"

Type: string

format#

Result format. Can use "xml", "yaml" or "json", or an installed ResourceFormat plugin name.

Type: string

list_resources_for_source_for_project#

List Resources for a Resource Model Source

Parameters

index_id (required)#

Type: string

project_id (required)#

Type: string

list_roles_for_current_user#

Get a list of the authenticated user's roles

This operation has no parameters

list_running_executions#

List the currently running executions for a project

Parameters

project_id (required)#

Type: string

jobIdFilter#

Type: string

list_running_jvm_threads#

Returns a dump of running JVM Threads.

This operation has no parameters

list_scheduled_jobs_for_current_server#

List the scheduled Jobs with their schedule owned by the target cluster server.

This operation has no parameters

list_scheduled_jobs_for_uuid#

List the scheduled Jobs with their schedule owned by the cluster server with the specified UUID.

Parameters

uuid (required)#

Type: string

list_scm_plugins_for_project#

List SCM plugins for a project.

Parameters

integration_id (required)#

Type: string

project_id (required)#

Type: string

list_sources_for_project#

List Resource Model Sources for a Project

Parameters

project_id (required)#

Type: string

list_tokens_for_user#

List all tokens for a specific user.

Parameters

user_id (required)#

Type: string

list_users#

Get a list of all the users.

This operation has no parameters

list_webhooks_for_project#

List Webhooks

Parameters

project_id (required)#

Type: string

perform_scm_action_for_job#

Perform the action for the SCM integration plugin with a set of input parameters.

Parameters

action_id (required)#

Type: string

integration_id (required)#

Type: string

job_id (required)#

Type: string

$body#

Type: object

{
  "input" : {
    "message" : "string"
  }
}

perform_scm_action_for_project#

Perform the action for the SCM integration plugin, with a set of input parameters, selected Jobs, or Items, or Items to delete.
Depending on the available Input Fields for the action, the action will expect a set of input values.
The set of jobs and items to choose from will be included in the Input Fields response, however where an Item has an associated Job, you can supply either the Job ID, or the Item ID.
When there are items to be deleted on export integration, you can specify the Item IDs in the deleted section. However, if the item is associated with a renamed Job, including the Job ID will have the same effect.
When there are items to be deleted on import integration, you must specify the Job IDs in the deletedJobs section.

Parameters

action_id (required)#

Type: string

integration_id (required)#

Type: string

project_id (required)#

Type: string

$body#

Type: object

{
  "input" : {
    "message" : "string"
  },
  "deleted" : [ "string" ],
  "jobs" : [ "string" ],
  "deletedJobs" : [ "string" ],
  "items" : [ "string" ]
}

ping_server#

Returns a simple text response.

This operation has no parameters

put_motd#

Update MOTD file

Parameters

project_id (required)#

Type: string

$body#

Type: object

{
  "content" : "string"
}

put_readme#

Update README file

Parameters

project_id (required)#

Type: string

$body#

Type: object

{
  "content" : "string"
}

query_executions#

Query for Executions based on Job or Execution details.

Parameters

project_id (required)#

Type: string

abortedbyFilter#

Username who aborted an execution

Type: string

adhoc#

If true, include only Adhoc executions, if false return only Job executions.

Type: boolean

begin#

Type: string

end#

Specify exact date for latest execution completion time

Type: string

excludeGroupPath#

specify a group or partial group path to exclude all jobs within that group path. Set to the special value "-" to match the top level jobs only.

Type: string

excludeGroupPathExact#

specify an exact group path to exclude. Set to the special value "-" to match the top level jobs only.

Type: string

excludeJobExactFilter#

specify an exact job name to exclude.

Type: string

excludeJobFilter#

specify a filter for the job Name. Exclude any job name that matches this value.

Type: string

excludeJobIdListFilter#

specify a Job ID to exclude, can be specified multiple times

Type: string

excludeJobListFilter#

specify a full Job group/name to exclude, can be specified multiple times. the job's group and name separated by a '/' character, such as "group1/job name", or "my job" if there is no group.

Type: string

executionTypeFilter#

specify the execution type

Type: string

Potential values: scheduled, user, user-scheduled

groupPath#

specify a group or partial group path to include all jobs within that group path. Set to the special value "-" to match the top level jobs only.

Type: string

groupPathExact#

specify an exact group path to match. Set to the special value "-" to match the top level jobs only.

Type: string

jobExactFilter#

specify an exact job name to match.

Type: string

jobFilter#

specify a filter for the job Name. Include any job name that matches this value.

Type: string

jobIdListFilter#

specify a Job ID to include, can be specified multiple times

Type: string

jobListFilter#

specify a full Job group/name to include, can be specified multiple times. the job's group and name separated by a '/' character, such as "group1/job name", or "my job" if there is no group.

Type: string

olderFilter#

(same format as recentFilter) return executions that completed before the specified relative period of time. E.g. a value of 30d returns executions older than 30 days.

Type: string

recentFilter#

Type: string

statusFilter#

execution status

Type: string

Potential values: running, succeeded, failed, aborted

userFilter#

Username who started the execution

Type: string

resume_processing_incomplete_log_storage#

Resume processing incomplete Log Storage uploads.

This operation has no parameters

retry_job#

Retry a Job Based on Execution

Parameters

exec_id (required)#

Type: string

job_id (required)#

Type: string

$body#

Type: object

{
  "argString" : "argument string to pass to the job, of the form: -opt value -opt2 value ....",
  "loglevel" : "argument specifying the loglevel to use",
  "failedNodes" : "false to run on the same nodes as the original execution, true or empty to run only on failed nodes.",
  "asUser" : "specifies a username identifying the user who ran the job. Requires runAs permission.",
  "option" : { }
}

run_adhoc_command#

Run a command string

Parameters

project_id (required)#

Type: string

$body#

Type: object

{
  "filter" : "node filter string",
  "nodeKeepgoing" : "if \"true\", continue executing on other nodes even if some fail.",
  "nodeThreadcount" : "threadcount to use",
  "exec" : "the shell command string to run, e.g. \"echo hello\".",
  "asUser" : "specifies a username identifying the user who ran the command. Requires runAs permission."
}

run_job#

Running a Job

Parameters

job_id (required)#

Type: string

$body#

Type: object

{
  "filter" : "node filter string",
  "argString" : "argument string to pass to the job, of the form: -opt value -opt2 value ....",
  "loglevel" : "argument specifying the loglevel to use",
  "asUser" : "specifies a username identifying the user who ran the job. Requires runAs permission.",
  "runAtTime" : "a time to run the job",
  "option" : { }
}

run_script#

Running Adhoc Scripts

Parameters

project_id (required)#

Type: string

$body#

Type: object

{
  "filter" : "node filter string",
  "fileExtension" : "extension of the script file on the remote node",
  "argString" : "Arguments to pass to the script when executed.",
  "project" : "project ID",
  "nodeKeepgoing" : "if \"true\", continue executing on other nodes even if some fail.",
  "interpreterArgsQuoted" : "if true, the script file and arguments will be quoted as the last argument to the scriptInterpreter.",
  "nodeThreadcount" : "threadcount to use",
  "script" : "script contents",
  "asUser" : "specifies a username identifying the user who ran the command. Requires runAs permission.",
  "scriptInterpreter" : "a command to use to run the script"
}

run_script_from_url#

Run a script downloaded from a URL.

Parameters

project_id (required)#

Type: string

$body#

Type: object

{
  "filter" : "node filter string",
  "fileExtension" : "extension of the script file on the remote node",
  "argString" : "Arguments to pass to the script when executed.",
  "project" : "project ID",
  "nodeKeepgoing" : "if \"true\", continue executing on other nodes even if some fail.",
  "interpreterArgsQuoted" : "if true, the script file and arguments will be quoted as the last argument to the scriptInterpreter.",
  "nodeThreadcount" : "threadcount to use",
  "url" : "URL with script contents",
  "asUser" : "specifies a username identifying the user who ran the command. Requires runAs permission.",
  "scriptInterpreter" : "a command to use to run the script"
}

send_webhook_event#

Send Webhook Event. You may post whatever data you wish to the webhook endpoint, however the plugin you are using must be able to handle the data you post. If the webhook plugin associated with the webhook can't handle the content type posted you will get an error response.

Parameters

auth_token_id (required)#

Type: string

$body#

Type: object

{ }

takeover_schedule_for_cluster_server#

Tell a Rundeck server in cluster mode to claim all scheduled jobs from another cluster server.

This operation has no parameters

update_acl_for_project#

Update a project ACL policy. The policy should be in YAML format, wrapped into a JSON object.

Parameters

acl_name (required)#

Type: string

project_id (required)#

Type: string

$body#

Type: object

{
  "content" : "string"
}

update_acl_policy#

Update an ACL Policy. The policy should be in YAML format, wrapped into a JSON object.

Parameters

$body#

Type: object

{
  "content" : "string"
}

update_configuration_for_project#

PUT Project Configuration

Parameters

project_id (required)#

Type: string

$body#

Type: object

{ }

update_current_user#

Modify current user's profile

This operation has no parameters

update_resources_for_source_for_project#

Update Resources for a Resource Model Source

Parameters

index_id (required)#

Type: string

project_id (required)#

Type: string

$body#

Type: object

{ }

update_user#

Modify another user's profile

Parameters

user_id (required)#

Type: string

update_value_for_configuration_key_for_project#

Set the value for a configuration key.

Parameters

key_id (required)#

Type: string

project_id (required)#

Type: string

$body#

Type: object

{ }

update_webhook#

Update A Webhook

Parameters

project_id (required)#

Type: string

webhook_id (required)#

Type: string

$body#

Type: object

{
  "roles" : "string",
  "name" : "string",
  "project" : "string",
  "eventPlugin" : "string",
  "id" : "integer",
  "config" : { },
  "enabled" : "boolean"
}