Jump to

• Request
• Response

Launch a Job Template

post

/api/v2/job_templates/{id}/launch/

Make a POST request to this resource to launch the job_template. If any passwords, inventory, or extra variables (extra_vars) are required, they must be passed via POST data, with extra_vars given as a YAML or JSON string and escaped parentheses. If the inventory_needed_to_start is True then the inventory is required.

If successful, the response status code will be 201. If any required passwords are not provided, a 400 status code will be returned. If the job cannot be launched, a 405 status code will be returned. If the provided credential or inventory are not allowed to be used by the user, then a 403 status code will be returned.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string

Body ()

Root Schema : JobLaunch

Type: object

Show Source

• ask_credential_on_launch: boolean
  Title: Ask credential on launch

  Read Only: true
• ask_diff_mode_on_launch: boolean
  Title: Ask diff mode on launch

  Read Only: true
• ask_execution_environment_on_launch: boolean
  Title: Ask execution environment on launch

  Read Only: true
• ask_forks_on_launch: boolean
  Title: Ask forks on launch

  Read Only: true
• ask_instance_groups_on_launch: boolean
  Title: Ask instance groups on launch

  Read Only: true
• ask_inventory_on_launch: boolean
  Title: Ask inventory on launch

  Read Only: true
• ask_job_slice_count_on_launch: boolean
  Title: Ask job slice count on launch

  Read Only: true
• ask_job_type_on_launch: boolean
  Title: Ask job type on launch

  Read Only: true
• ask_labels_on_launch: boolean
  Title: Ask labels on launch

  Read Only: true
• ask_limit_on_launch: boolean
  Title: Ask limit on launch

  Read Only: true
• ask_scm_branch_on_launch: boolean
  Title: Ask scm branch on launch

  Read Only: true
• ask_skip_tags_on_launch: boolean
  Title: Ask skip tags on launch

  Read Only: true
• ask_tags_on_launch: boolean
  Title: Ask tags on launch

  Read Only: true
• ask_timeout_on_launch: boolean
  Title: Ask timeout on launch

  Read Only: true
• ask_variables_on_launch: boolean
  Title: Ask variables on launch

  Read Only: true
• ask_verbosity_on_launch: boolean
  Title: Ask verbosity on launch

  Read Only: true
• can_start_without_user_input: boolean
  Title: Can start without user input

  Read Only: true
• credential_needed_to_start: string
  Title: Credential needed to start

  Read Only: true
• credential_passwords: string
  Title: Credential passwords
• credentials: array credentials
  Unique Items Required: true
• defaults: string
  Title: Defaults

  Read Only: true
• diff_mode: boolean
  Title: Diff mode
• execution_environment: integer
  Title: Execution environment
• extra_vars: object Extra vars
  Title: Extra vars
• forks: integer
  Title: Forks

  Minimum Value: 0
• instance_groups: array instance_groups
  Unique Items Required: true
• inventory: integer
  Title: Inventory
• inventory_needed_to_start: string
  Title: Inventory needed to start

  Read Only: true
• job_slice_count: integer
  Title: Job slice count

  Minimum Value: 0
• job_tags: string
  Title: Job tags
• job_template_data: string
  Title: Job template data

  Read Only: true
• job_type: string
  Title: Job type

  Allowed Values: [ "run", "check" ]
• labels: array labels
  Unique Items Required: true
• limit: string
  Title: Limit
• passwords_needed_to_start: string
  Title: Passwords needed to start

  Read Only: true
• scm_branch: string
  Title: Scm branch
• skip_tags: string
  Title: Skip tags
• survey_enabled: string
  Title: Survey enabled

  Read Only: true
• timeout: integer
  Title: Timeout
• variables_needed_to_start: string
  Title: Variables needed to start

  Read Only: true
• verbosity: integer
  Title: Verbosity

  Allowed Values: [ "0", "1", "2", "3", "4", "5" ]

{
    "properties":{
        "ask_credential_on_launch":{
            "readOnly":true,
            "title":"Ask credential on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_diff_mode_on_launch":{
            "readOnly":true,
            "title":"Ask diff mode on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_execution_environment_on_launch":{
            "readOnly":true,
            "title":"Ask execution environment on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_forks_on_launch":{
            "readOnly":true,
            "title":"Ask forks on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_instance_groups_on_launch":{
            "readOnly":true,
            "title":"Ask instance groups on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_inventory_on_launch":{
            "readOnly":true,
            "title":"Ask inventory on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_job_slice_count_on_launch":{
            "readOnly":true,
            "title":"Ask job slice count on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_job_type_on_launch":{
            "readOnly":true,
            "title":"Ask job type on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_labels_on_launch":{
            "readOnly":true,
            "title":"Ask labels on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_limit_on_launch":{
            "readOnly":true,
            "title":"Ask limit on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_scm_branch_on_launch":{
            "readOnly":true,
            "title":"Ask scm branch on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_skip_tags_on_launch":{
            "readOnly":true,
            "title":"Ask skip tags on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_tags_on_launch":{
            "readOnly":true,
            "title":"Ask tags on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_timeout_on_launch":{
            "readOnly":true,
            "title":"Ask timeout on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_variables_on_launch":{
            "readOnly":true,
            "title":"Ask variables on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_verbosity_on_launch":{
            "readOnly":true,
            "title":"Ask verbosity on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "can_start_without_user_input":{
            "readOnly":true,
            "title":"Can start without user input",
            "type":"boolean"
        },
        "credential_needed_to_start":{
            "readOnly":true,
            "title":"Credential needed to start",
            "type":"string"
        },
        "credential_passwords":{
            "title":"Credential passwords",
            "type":"string"
        },
        "credentials":{
            "items":{
                "type":"integer"
            },
            "type":"array",
            "uniqueItems":true
        },
        "defaults":{
            "readOnly":true,
            "title":"Defaults",
            "type":"string"
        },
        "diff_mode":{
            "title":"Diff mode",
            "type":"boolean"
        },
        "execution_environment":{
            "title":"Execution environment",
            "type":"integer"
        },
        "extra_vars":{
            "title":"Extra vars",
            "type":"object"
        },
        "forks":{
            "minimum":"0",
            "title":"Forks",
            "type":"integer"
        },
        "instance_groups":{
            "items":{
                "type":"integer"
            },
            "type":"array",
            "uniqueItems":true
        },
        "inventory":{
            "title":"Inventory",
            "type":"integer"
        },
        "inventory_needed_to_start":{
            "readOnly":true,
            "title":"Inventory needed to start",
            "type":"string"
        },
        "job_slice_count":{
            "minimum":"0",
            "title":"Job slice count",
            "type":"integer"
        },
        "job_tags":{
            "title":"Job tags",
            "type":"string"
        },
        "job_template_data":{
            "readOnly":true,
            "title":"Job template data",
            "type":"string"
        },
        "job_type":{
            "enum":[
                "run",
                "check"
            ],
            "title":"Job type",
            "type":"string"
        },
        "labels":{
            "items":{
                "type":"integer"
            },
            "type":"array",
            "uniqueItems":true
        },
        "limit":{
            "title":"Limit",
            "type":"string"
        },
        "passwords_needed_to_start":{
            "readOnly":true,
            "title":"Passwords needed to start",
            "type":"string"
        },
        "scm_branch":{
            "title":"Scm branch",
            "type":"string"
        },
        "skip_tags":{
            "title":"Skip tags",
            "type":"string"
        },
        "survey_enabled":{
            "readOnly":true,
            "title":"Survey enabled",
            "type":"string"
        },
        "timeout":{
            "title":"Timeout",
            "type":"integer"
        },
        "variables_needed_to_start":{
            "readOnly":true,
            "title":"Variables needed to start",
            "type":"string"
        },
        "verbosity":{
            "enum":[
                "0",
                "1",
                "2",
                "3",
                "4",
                "5"
            ],
            "title":"Verbosity",
            "type":"integer"
        }
    },
    "type":"object"
}

Nested Schema : credentials

Type: array

Unique Items Required: true

Show Source

• Array of: integer

{
    "items":{
        "type":"integer"
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : Extra vars

Type: object

Title: Extra vars

Nested Schema : instance_groups

Type: array

Unique Items Required: true

Show Source

• Array of: integer

{
    "items":{
        "type":"integer"
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : labels

Type: array

Unique Items Required: true

Show Source

• Array of: integer

{
    "items":{
        "type":"integer"
    },
    "type":"array",
    "uniqueItems":true
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Body ()

Root Schema : JobLaunch

Type: object

Show Source

• ask_credential_on_launch: boolean
  Title: Ask credential on launch

  Read Only: true
• ask_diff_mode_on_launch: boolean
  Title: Ask diff mode on launch

  Read Only: true
• ask_execution_environment_on_launch: boolean
  Title: Ask execution environment on launch

  Read Only: true
• ask_forks_on_launch: boolean
  Title: Ask forks on launch

  Read Only: true
• ask_instance_groups_on_launch: boolean
  Title: Ask instance groups on launch

  Read Only: true
• ask_inventory_on_launch: boolean
  Title: Ask inventory on launch

  Read Only: true
• ask_job_slice_count_on_launch: boolean
  Title: Ask job slice count on launch

  Read Only: true
• ask_job_type_on_launch: boolean
  Title: Ask job type on launch

  Read Only: true
• ask_labels_on_launch: boolean
  Title: Ask labels on launch

  Read Only: true
• ask_limit_on_launch: boolean
  Title: Ask limit on launch

  Read Only: true
• ask_scm_branch_on_launch: boolean
  Title: Ask scm branch on launch

  Read Only: true
• ask_skip_tags_on_launch: boolean
  Title: Ask skip tags on launch

  Read Only: true
• ask_tags_on_launch: boolean
  Title: Ask tags on launch

  Read Only: true
• ask_timeout_on_launch: boolean
  Title: Ask timeout on launch

  Read Only: true
• ask_variables_on_launch: boolean
  Title: Ask variables on launch

  Read Only: true
• ask_verbosity_on_launch: boolean
  Title: Ask verbosity on launch

  Read Only: true
• can_start_without_user_input: boolean
  Title: Can start without user input

  Read Only: true
• credential_needed_to_start: string
  Title: Credential needed to start

  Read Only: true
• credential_passwords: string
  Title: Credential passwords
• credentials: array credentials
  Unique Items Required: true
• defaults: string
  Title: Defaults

  Read Only: true
• diff_mode: boolean
  Title: Diff mode
• execution_environment: integer
  Title: Execution environment
• extra_vars: object Extra vars
  Title: Extra vars
• forks: integer
  Title: Forks

  Minimum Value: 0
• instance_groups: array instance_groups
  Unique Items Required: true
• inventory: integer
  Title: Inventory
• inventory_needed_to_start: string
  Title: Inventory needed to start

  Read Only: true
• job_slice_count: integer
  Title: Job slice count

  Minimum Value: 0
• job_tags: string
  Title: Job tags
• job_template_data: string
  Title: Job template data

  Read Only: true
• job_type: string
  Title: Job type

  Allowed Values: [ "run", "check" ]
• labels: array labels
  Unique Items Required: true
• limit: string
  Title: Limit
• passwords_needed_to_start: string
  Title: Passwords needed to start

  Read Only: true
• scm_branch: string
  Title: Scm branch
• skip_tags: string
  Title: Skip tags
• survey_enabled: string
  Title: Survey enabled

  Read Only: true
• timeout: integer
  Title: Timeout
• variables_needed_to_start: string
  Title: Variables needed to start

  Read Only: true
• verbosity: integer
  Title: Verbosity

  Allowed Values: [ "0", "1", "2", "3", "4", "5" ]

{
    "properties":{
        "ask_credential_on_launch":{
            "readOnly":true,
            "title":"Ask credential on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_diff_mode_on_launch":{
            "readOnly":true,
            "title":"Ask diff mode on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_execution_environment_on_launch":{
            "readOnly":true,
            "title":"Ask execution environment on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_forks_on_launch":{
            "readOnly":true,
            "title":"Ask forks on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_instance_groups_on_launch":{
            "readOnly":true,
            "title":"Ask instance groups on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_inventory_on_launch":{
            "readOnly":true,
            "title":"Ask inventory on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_job_slice_count_on_launch":{
            "readOnly":true,
            "title":"Ask job slice count on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_job_type_on_launch":{
            "readOnly":true,
            "title":"Ask job type on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_labels_on_launch":{
            "readOnly":true,
            "title":"Ask labels on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_limit_on_launch":{
            "readOnly":true,
            "title":"Ask limit on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_scm_branch_on_launch":{
            "readOnly":true,
            "title":"Ask scm branch on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_skip_tags_on_launch":{
            "readOnly":true,
            "title":"Ask skip tags on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_tags_on_launch":{
            "readOnly":true,
            "title":"Ask tags on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_timeout_on_launch":{
            "readOnly":true,
            "title":"Ask timeout on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_variables_on_launch":{
            "readOnly":true,
            "title":"Ask variables on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_verbosity_on_launch":{
            "readOnly":true,
            "title":"Ask verbosity on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "can_start_without_user_input":{
            "readOnly":true,
            "title":"Can start without user input",
            "type":"boolean"
        },
        "credential_needed_to_start":{
            "readOnly":true,
            "title":"Credential needed to start",
            "type":"string"
        },
        "credential_passwords":{
            "title":"Credential passwords",
            "type":"string"
        },
        "credentials":{
            "items":{
                "type":"integer"
            },
            "type":"array",
            "uniqueItems":true
        },
        "defaults":{
            "readOnly":true,
            "title":"Defaults",
            "type":"string"
        },
        "diff_mode":{
            "title":"Diff mode",
            "type":"boolean"
        },
        "execution_environment":{
            "title":"Execution environment",
            "type":"integer"
        },
        "extra_vars":{
            "title":"Extra vars",
            "type":"object"
        },
        "forks":{
            "minimum":"0",
            "title":"Forks",
            "type":"integer"
        },
        "instance_groups":{
            "items":{
                "type":"integer"
            },
            "type":"array",
            "uniqueItems":true
        },
        "inventory":{
            "title":"Inventory",
            "type":"integer"
        },
        "inventory_needed_to_start":{
            "readOnly":true,
            "title":"Inventory needed to start",
            "type":"string"
        },
        "job_slice_count":{
            "minimum":"0",
            "title":"Job slice count",
            "type":"integer"
        },
        "job_tags":{
            "title":"Job tags",
            "type":"string"
        },
        "job_template_data":{
            "readOnly":true,
            "title":"Job template data",
            "type":"string"
        },
        "job_type":{
            "enum":[
                "run",
                "check"
            ],
            "title":"Job type",
            "type":"string"
        },
        "labels":{
            "items":{
                "type":"integer"
            },
            "type":"array",
            "uniqueItems":true
        },
        "limit":{
            "title":"Limit",
            "type":"string"
        },
        "passwords_needed_to_start":{
            "readOnly":true,
            "title":"Passwords needed to start",
            "type":"string"
        },
        "scm_branch":{
            "title":"Scm branch",
            "type":"string"
        },
        "skip_tags":{
            "title":"Skip tags",
            "type":"string"
        },
        "survey_enabled":{
            "readOnly":true,
            "title":"Survey enabled",
            "type":"string"
        },
        "timeout":{
            "title":"Timeout",
            "type":"integer"
        },
        "variables_needed_to_start":{
            "readOnly":true,
            "title":"Variables needed to start",
            "type":"string"
        },
        "verbosity":{
            "enum":[
                "0",
                "1",
                "2",
                "3",
                "4",
                "5"
            ],
            "title":"Verbosity",
            "type":"integer"
        }
    },
    "type":"object"
}

Nested Schema : credentials

Type: array

Unique Items Required: true

Show Source

• Array of: integer

{
    "items":{
        "type":"integer"
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : Extra vars

Type: object

Title: Extra vars

Nested Schema : instance_groups

Type: array

Unique Items Required: true

Show Source

• Array of: integer

{
    "items":{
        "type":"integer"
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : labels

Type: array

Unique Items Required: true

Show Source

• Array of: integer

{
    "items":{
        "type":"integer"
    },
    "type":"array",
    "uniqueItems":true
}

Back to Top