Jump to

• Request
• Response

Create a Job Template

post

/api/v2/job_templates/

Make a POST request to this resource with the following job template fields to create a new job template:

• name: Name of this job template. (string, required)
• description: Optional description of this job template. (string, default="")
• job_type: (choice)
  • run: Run (default)
  • check: Check
• inventory: (id, default=``)
• project: (id, default=``)
• playbook: (string, default="")
• scm_branch: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default="")
• forks: (integer, default=0)
• limit: (string, default="")
• verbosity: (choice)
  • 0: 0 (Normal) (default)
  • 1: 1 (Verbose)
  • 2: 2 (More Verbose)
  • 3: 3 (Debug)
  • 4: 4 (Connection Debug)
  • 5: 5 (WinRM Debug)
• extra_vars: (json, default=``)
• job_tags: (string, default="")
• force_handlers: (boolean, default=False)
• skip_tags: (string, default="")
• start_at_task: (string, default="")
• timeout: The amount of time (in seconds) to run before the task is canceled. (integer, default=0)

• use_fact_cache: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean, default=False)

• execution_environment: The container image to be used for execution. (id, default=``)

• host_config_key: (string, default="")
• ask_scm_branch_on_launch: (boolean, default=False)
• ask_diff_mode_on_launch: (boolean, default=False)
• ask_variables_on_launch: (boolean, default=False)
• ask_limit_on_launch: (boolean, default=False)
• ask_tags_on_launch: (boolean, default=False)
• ask_skip_tags_on_launch: (boolean, default=False)
• ask_job_type_on_launch: (boolean, default=False)
• ask_verbosity_on_launch: (boolean, default=False)
• ask_inventory_on_launch: (boolean, default=False)
• ask_credential_on_launch: (boolean, default=False)
• ask_execution_environment_on_launch: (boolean, default=False)
• ask_labels_on_launch: (boolean, default=False)
• ask_forks_on_launch: (boolean, default=False)
• ask_job_slice_count_on_launch: (boolean, default=False)
• ask_timeout_on_launch: (boolean, default=False)
• ask_instance_groups_on_launch: (boolean, default=False)
• survey_enabled: (boolean, default=False)
• become_enabled: (boolean, default=False)
• diff_mode: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean, default=False)

• allow_simultaneous: (boolean, default=False)

• job_slice_count: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer, default=1)

• webhook_service: Service that webhook requests will be accepted from (choice)
  • "": ---------
  • github: GitHub
  • gitlab: GitLab
  • bitbucket_dc: BitBucket DataCenter
• webhook_credential: Personal Access Token for posting back the status to the service API (id, default=``)
• prevent_instance_group_fallback: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=False)

Request

Supported Media Types

• application/json

Body ()

Root Schema : JobTemplate

Type: object

Show Source

• allow_simultaneous: boolean
  Title: Allow simultaneous
• ask_credential_on_launch: boolean
  Title: Ask credential on launch
• ask_diff_mode_on_launch: boolean
  Title: Ask diff mode on launch
• ask_execution_environment_on_launch: boolean
  Title: Ask execution environment on launch
• ask_forks_on_launch: boolean
  Title: Ask forks on launch
• ask_instance_groups_on_launch: boolean
  Title: Ask instance groups on launch
• ask_inventory_on_launch: boolean
  Title: Ask inventory on launch
• ask_job_slice_count_on_launch: boolean
  Title: Ask job slice count on launch
• ask_job_type_on_launch: boolean
  Title: Ask job type on launch
• ask_labels_on_launch: boolean
  Title: Ask labels on launch
• ask_limit_on_launch: boolean
  Title: Ask limit on launch
• ask_scm_branch_on_launch: boolean
  Title: Ask scm branch on launch
• ask_skip_tags_on_launch: boolean
  Title: Ask skip tags on launch
• ask_tags_on_launch: boolean
  Title: Ask tags on launch
• ask_timeout_on_launch: boolean
  Title: Ask timeout on launch
• ask_variables_on_launch: boolean
  Title: Ask variables on launch
• ask_verbosity_on_launch: boolean
  Title: Ask verbosity on launch
• become_enabled: boolean
  Title: Become enabled
• created: string
  Title: Created

  Read Only: true
• custom_virtualenv: string
  Title: Custom virtualenv

  Read Only: true

  Minimum Length: 1

  Local absolute file path containing a custom Python virtualenv to use
• description: string
  Title: Description
• diff_mode: boolean
  Title: Diff mode

  If enabled, textual changes made to any templated files on the host are shown in the standard output
• execution_environment: integer
  Title: Execution environment

  The container image to be used for execution.
• extra_vars: string
  Title: Extra vars
• force_handlers: boolean
  Title: Force handlers
• forks: integer
  Title: Forks

  Minimum Value: 0
• host_config_key: string
  Title: Host config key

  Maximum Length: 1024
• id: integer
  Title: ID

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

  Minimum Value: 0

  Default Value: 1

  The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1.
• job_tags: string
  Title: Job tags
• job_type: string
  Title: Job type

  Default Value: run

  Allowed Values: [ "run", "check" ]
• last_job_failed: boolean
  Title: Last job failed

  Read Only: true
• last_job_run: string(date-time)
  Title: Last job run

  Read Only: true
• limit: string
  Title: Limit
• modified: string
  Title: Modified

  Read Only: true
• name(required): string
  Title: Name

  Minimum Length: 1

  Maximum Length: 512
• next_job_run: string(date-time)
  Title: Next job run

  Read Only: true
• organization: integer
  Title: Organization

  Read Only: true

  The organization used to determine access to this template.
• playbook: string
  Title: Playbook

  Maximum Length: 1024
• prevent_instance_group_fallback: boolean
  Title: Prevent instance group fallback

  If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied.
• project: string
  Title: Project
• related: string
  Title: Related

  Read Only: true
• scm_branch: string
  Title: Scm branch

  Maximum Length: 1024

  Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true.
• skip_tags: string
  Title: Skip tags

  Maximum Length: 1024
• start_at_task: string
  Title: Start at task

  Maximum Length: 1024
• status: string
  Title: Status

  Read Only: true

  Allowed Values: [ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated" ]
• summary_fields: string
  Title: Summary fields

  Read Only: true
• survey_enabled: boolean
  Title: Survey enabled
• timeout: integer
  Title: Timeout

  The amount of time (in seconds) to run before the task is canceled.
• type: string
  Title: Type

  Read Only: true
• url: string
  Title: Url

  Read Only: true
• use_fact_cache: boolean
  Title: Use fact cache

  If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible.
• verbosity: integer
  Title: Verbosity

  Allowed Values: [ "0", "1", "2", "3", "4", "5" ]
• webhook_credential: integer
  Title: Webhook credential

  Personal Access Token for posting back the status to the service API
• webhook_service: string
  Title: Webhook service

  Allowed Values: [ "github", "gitlab", "bitbucket_dc" ]

  Service that webhook requests will be accepted from

{
    "properties":{
        "allow_simultaneous":{
            "title":"Allow simultaneous",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_credential_on_launch":{
            "title":"Ask credential on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_diff_mode_on_launch":{
            "title":"Ask diff mode on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_execution_environment_on_launch":{
            "title":"Ask execution environment on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_forks_on_launch":{
            "title":"Ask forks on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_instance_groups_on_launch":{
            "title":"Ask instance groups on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_inventory_on_launch":{
            "title":"Ask inventory on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_job_slice_count_on_launch":{
            "title":"Ask job slice count on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_job_type_on_launch":{
            "title":"Ask job type on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_labels_on_launch":{
            "title":"Ask labels on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_limit_on_launch":{
            "title":"Ask limit on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_scm_branch_on_launch":{
            "title":"Ask scm branch on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_skip_tags_on_launch":{
            "title":"Ask skip tags on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_tags_on_launch":{
            "title":"Ask tags on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_timeout_on_launch":{
            "title":"Ask timeout on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_variables_on_launch":{
            "title":"Ask variables on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_verbosity_on_launch":{
            "title":"Ask verbosity on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "become_enabled":{
            "title":"Become enabled",
            "type":"boolean",
            "x-nullable":true
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "custom_virtualenv":{
            "description":"Local absolute file path containing a custom Python virtualenv to use",
            "minLength":"1",
            "readOnly":true,
            "title":"Custom virtualenv",
            "type":"string",
            "x-nullable":true
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "diff_mode":{
            "description":"If enabled, textual changes made to any templated files on the host are shown in the standard output",
            "title":"Diff mode",
            "type":"boolean",
            "x-nullable":true
        },
        "execution_environment":{
            "description":"The container image to be used for execution.",
            "title":"Execution environment",
            "type":"integer",
            "x-nullable":true
        },
        "extra_vars":{
            "title":"Extra vars",
            "type":"string",
            "x-nullable":true
        },
        "force_handlers":{
            "title":"Force handlers",
            "type":"boolean",
            "x-nullable":true
        },
        "forks":{
            "minimum":"0",
            "title":"Forks",
            "type":"integer"
        },
        "host_config_key":{
            "maxLength":"1024",
            "title":"Host config key",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "inventory":{
            "title":"Inventory",
            "type":"integer",
            "x-nullable":true
        },
        "job_slice_count":{
            "default":"1",
            "description":"The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1.",
            "minimum":"0",
            "title":"Job slice count",
            "type":"integer"
        },
        "job_tags":{
            "title":"Job tags",
            "type":"string",
            "x-nullable":true
        },
        "job_type":{
            "default":"run",
            "enum":[
                "run",
                "check"
            ],
            "title":"Job type",
            "type":"string",
            "x-nullable":true
        },
        "last_job_failed":{
            "readOnly":true,
            "title":"Last job failed",
            "type":"boolean"
        },
        "last_job_run":{
            "format":"date-time",
            "readOnly":true,
            "title":"Last job run",
            "type":"string",
            "x-nullable":true
        },
        "limit":{
            "title":"Limit",
            "type":"string",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "next_job_run":{
            "format":"date-time",
            "readOnly":true,
            "title":"Next job run",
            "type":"string",
            "x-nullable":true
        },
        "organization":{
            "description":"The organization used to determine access to this template.",
            "readOnly":true,
            "title":"Organization",
            "type":"integer",
            "x-nullable":true
        },
        "playbook":{
            "maxLength":"1024",
            "title":"Playbook",
            "type":"string",
            "x-nullable":true
        },
        "prevent_instance_group_fallback":{
            "description":"If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied.",
            "title":"Prevent instance group fallback",
            "type":"boolean",
            "x-nullable":true
        },
        "project":{
            "title":"Project",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "scm_branch":{
            "description":"Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true.",
            "maxLength":"1024",
            "title":"Scm branch",
            "type":"string",
            "x-nullable":true
        },
        "skip_tags":{
            "maxLength":"1024",
            "title":"Skip tags",
            "type":"string",
            "x-nullable":true
        },
        "start_at_task":{
            "maxLength":"1024",
            "title":"Start at task",
            "type":"string",
            "x-nullable":true
        },
        "status":{
            "enum":[
                "new",
                "pending",
                "waiting",
                "running",
                "successful",
                "failed",
                "error",
                "canceled",
                "never updated"
            ],
            "readOnly":true,
            "title":"Status",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "survey_enabled":{
            "title":"Survey enabled",
            "type":"boolean",
            "x-nullable":true
        },
        "timeout":{
            "description":"The amount of time (in seconds) to run before the task is canceled.",
            "title":"Timeout",
            "type":"integer"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "use_fact_cache":{
            "description":"If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible.",
            "title":"Use fact cache",
            "type":"boolean",
            "x-nullable":true
        },
        "verbosity":{
            "enum":[
                "0",
                "1",
                "2",
                "3",
                "4",
                "5"
            ],
            "title":"Verbosity",
            "type":"integer"
        },
        "webhook_credential":{
            "description":"Personal Access Token for posting back the status to the service API",
            "title":"Webhook credential",
            "type":"integer",
            "x-nullable":true
        },
        "webhook_service":{
            "description":"Service that webhook requests will be accepted from",
            "enum":[
                "github",
                "gitlab",
                "bitbucket_dc"
            ],
            "title":"Webhook service",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Body ()

Root Schema : JobTemplate

Type: object

Show Source

• allow_simultaneous: boolean
  Title: Allow simultaneous
• ask_credential_on_launch: boolean
  Title: Ask credential on launch
• ask_diff_mode_on_launch: boolean
  Title: Ask diff mode on launch
• ask_execution_environment_on_launch: boolean
  Title: Ask execution environment on launch
• ask_forks_on_launch: boolean
  Title: Ask forks on launch
• ask_instance_groups_on_launch: boolean
  Title: Ask instance groups on launch
• ask_inventory_on_launch: boolean
  Title: Ask inventory on launch
• ask_job_slice_count_on_launch: boolean
  Title: Ask job slice count on launch
• ask_job_type_on_launch: boolean
  Title: Ask job type on launch
• ask_labels_on_launch: boolean
  Title: Ask labels on launch
• ask_limit_on_launch: boolean
  Title: Ask limit on launch
• ask_scm_branch_on_launch: boolean
  Title: Ask scm branch on launch
• ask_skip_tags_on_launch: boolean
  Title: Ask skip tags on launch
• ask_tags_on_launch: boolean
  Title: Ask tags on launch
• ask_timeout_on_launch: boolean
  Title: Ask timeout on launch
• ask_variables_on_launch: boolean
  Title: Ask variables on launch
• ask_verbosity_on_launch: boolean
  Title: Ask verbosity on launch
• become_enabled: boolean
  Title: Become enabled
• created: string
  Title: Created

  Read Only: true
• custom_virtualenv: string
  Title: Custom virtualenv

  Read Only: true

  Minimum Length: 1

  Local absolute file path containing a custom Python virtualenv to use
• description: string
  Title: Description
• diff_mode: boolean
  Title: Diff mode

  If enabled, textual changes made to any templated files on the host are shown in the standard output
• execution_environment: integer
  Title: Execution environment

  The container image to be used for execution.
• extra_vars: string
  Title: Extra vars
• force_handlers: boolean
  Title: Force handlers
• forks: integer
  Title: Forks

  Minimum Value: 0
• host_config_key: string
  Title: Host config key

  Maximum Length: 1024
• id: integer
  Title: ID

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

  Minimum Value: 0

  Default Value: 1

  The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1.
• job_tags: string
  Title: Job tags
• job_type: string
  Title: Job type

  Default Value: run

  Allowed Values: [ "run", "check" ]
• last_job_failed: boolean
  Title: Last job failed

  Read Only: true
• last_job_run: string(date-time)
  Title: Last job run

  Read Only: true
• limit: string
  Title: Limit
• modified: string
  Title: Modified

  Read Only: true
• name(required): string
  Title: Name

  Minimum Length: 1

  Maximum Length: 512
• next_job_run: string(date-time)
  Title: Next job run

  Read Only: true
• organization: integer
  Title: Organization

  Read Only: true

  The organization used to determine access to this template.
• playbook: string
  Title: Playbook

  Maximum Length: 1024
• prevent_instance_group_fallback: boolean
  Title: Prevent instance group fallback

  If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied.
• project: string
  Title: Project
• related: string
  Title: Related

  Read Only: true
• scm_branch: string
  Title: Scm branch

  Maximum Length: 1024

  Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true.
• skip_tags: string
  Title: Skip tags

  Maximum Length: 1024
• start_at_task: string
  Title: Start at task

  Maximum Length: 1024
• status: string
  Title: Status

  Read Only: true

  Allowed Values: [ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated" ]
• summary_fields: string
  Title: Summary fields

  Read Only: true
• survey_enabled: boolean
  Title: Survey enabled
• timeout: integer
  Title: Timeout

  The amount of time (in seconds) to run before the task is canceled.
• type: string
  Title: Type

  Read Only: true
• url: string
  Title: Url

  Read Only: true
• use_fact_cache: boolean
  Title: Use fact cache

  If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible.
• verbosity: integer
  Title: Verbosity

  Allowed Values: [ "0", "1", "2", "3", "4", "5" ]
• webhook_credential: integer
  Title: Webhook credential

  Personal Access Token for posting back the status to the service API
• webhook_service: string
  Title: Webhook service

  Allowed Values: [ "github", "gitlab", "bitbucket_dc" ]

  Service that webhook requests will be accepted from

{
    "properties":{
        "allow_simultaneous":{
            "title":"Allow simultaneous",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_credential_on_launch":{
            "title":"Ask credential on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_diff_mode_on_launch":{
            "title":"Ask diff mode on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_execution_environment_on_launch":{
            "title":"Ask execution environment on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_forks_on_launch":{
            "title":"Ask forks on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_instance_groups_on_launch":{
            "title":"Ask instance groups on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_inventory_on_launch":{
            "title":"Ask inventory on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_job_slice_count_on_launch":{
            "title":"Ask job slice count on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_job_type_on_launch":{
            "title":"Ask job type on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_labels_on_launch":{
            "title":"Ask labels on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_limit_on_launch":{
            "title":"Ask limit on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_scm_branch_on_launch":{
            "title":"Ask scm branch on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_skip_tags_on_launch":{
            "title":"Ask skip tags on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_tags_on_launch":{
            "title":"Ask tags on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_timeout_on_launch":{
            "title":"Ask timeout on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_variables_on_launch":{
            "title":"Ask variables on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_verbosity_on_launch":{
            "title":"Ask verbosity on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "become_enabled":{
            "title":"Become enabled",
            "type":"boolean",
            "x-nullable":true
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "custom_virtualenv":{
            "description":"Local absolute file path containing a custom Python virtualenv to use",
            "minLength":"1",
            "readOnly":true,
            "title":"Custom virtualenv",
            "type":"string",
            "x-nullable":true
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "diff_mode":{
            "description":"If enabled, textual changes made to any templated files on the host are shown in the standard output",
            "title":"Diff mode",
            "type":"boolean",
            "x-nullable":true
        },
        "execution_environment":{
            "description":"The container image to be used for execution.",
            "title":"Execution environment",
            "type":"integer",
            "x-nullable":true
        },
        "extra_vars":{
            "title":"Extra vars",
            "type":"string",
            "x-nullable":true
        },
        "force_handlers":{
            "title":"Force handlers",
            "type":"boolean",
            "x-nullable":true
        },
        "forks":{
            "minimum":"0",
            "title":"Forks",
            "type":"integer"
        },
        "host_config_key":{
            "maxLength":"1024",
            "title":"Host config key",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "inventory":{
            "title":"Inventory",
            "type":"integer",
            "x-nullable":true
        },
        "job_slice_count":{
            "default":"1",
            "description":"The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1.",
            "minimum":"0",
            "title":"Job slice count",
            "type":"integer"
        },
        "job_tags":{
            "title":"Job tags",
            "type":"string",
            "x-nullable":true
        },
        "job_type":{
            "default":"run",
            "enum":[
                "run",
                "check"
            ],
            "title":"Job type",
            "type":"string",
            "x-nullable":true
        },
        "last_job_failed":{
            "readOnly":true,
            "title":"Last job failed",
            "type":"boolean"
        },
        "last_job_run":{
            "format":"date-time",
            "readOnly":true,
            "title":"Last job run",
            "type":"string",
            "x-nullable":true
        },
        "limit":{
            "title":"Limit",
            "type":"string",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "next_job_run":{
            "format":"date-time",
            "readOnly":true,
            "title":"Next job run",
            "type":"string",
            "x-nullable":true
        },
        "organization":{
            "description":"The organization used to determine access to this template.",
            "readOnly":true,
            "title":"Organization",
            "type":"integer",
            "x-nullable":true
        },
        "playbook":{
            "maxLength":"1024",
            "title":"Playbook",
            "type":"string",
            "x-nullable":true
        },
        "prevent_instance_group_fallback":{
            "description":"If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied.",
            "title":"Prevent instance group fallback",
            "type":"boolean",
            "x-nullable":true
        },
        "project":{
            "title":"Project",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "scm_branch":{
            "description":"Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true.",
            "maxLength":"1024",
            "title":"Scm branch",
            "type":"string",
            "x-nullable":true
        },
        "skip_tags":{
            "maxLength":"1024",
            "title":"Skip tags",
            "type":"string",
            "x-nullable":true
        },
        "start_at_task":{
            "maxLength":"1024",
            "title":"Start at task",
            "type":"string",
            "x-nullable":true
        },
        "status":{
            "enum":[
                "new",
                "pending",
                "waiting",
                "running",
                "successful",
                "failed",
                "error",
                "canceled",
                "never updated"
            ],
            "readOnly":true,
            "title":"Status",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "survey_enabled":{
            "title":"Survey enabled",
            "type":"boolean",
            "x-nullable":true
        },
        "timeout":{
            "description":"The amount of time (in seconds) to run before the task is canceled.",
            "title":"Timeout",
            "type":"integer"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "use_fact_cache":{
            "description":"If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible.",
            "title":"Use fact cache",
            "type":"boolean",
            "x-nullable":true
        },
        "verbosity":{
            "enum":[
                "0",
                "1",
                "2",
                "3",
                "4",
                "5"
            ],
            "title":"Verbosity",
            "type":"integer"
        },
        "webhook_credential":{
            "description":"Personal Access Token for posting back the status to the service API",
            "title":"Webhook credential",
            "type":"integer",
            "x-nullable":true
        },
        "webhook_service":{
            "description":"Service that webhook requests will be accepted from",
            "enum":[
                "github",
                "gitlab",
                "bitbucket_dc"
            ],
            "title":"Webhook service",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}

Back to Top