Jump to

• Request
• Response

Retrieve a Job

get

/api/v2/jobs/{id}/

Make GET request to this resource to retrieve a single job record containing the following fields:

• id: Database ID for this job. (integer)
• type: Data type for this job. (choice)
• url: URL for this job. (string)
• related: Data structure with URLs of related resources. (object)
• summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
• created: Timestamp when this job was created. (datetime)
• modified: Timestamp when this job was last modified. (datetime)
• name: Name of this job. (string)
• description: Optional description of this job. (string)
• job_type: (choice)
  • run: Run
  • check: Check
  • scan: Scan
• inventory: (id)
• project: (id)
• playbook: (string)
• 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)
• forks: (integer)
• limit: (string)
• verbosity: (choice)
  • 0: 0 (Normal)
  • 1: 1 (Verbose)
  • 2: 2 (More Verbose)
  • 3: 3 (Debug)
  • 4: 4 (Connection Debug)
  • 5: 5 (WinRM Debug)
• extra_vars: (json)
• job_tags: (string)
• force_handlers: (boolean)
• skip_tags: (string)
• start_at_task: (string)
• timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
• 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)
• organization: The organization used to determine access to this unified job. (id)
• unified_job_template: (id)
• launch_type: (choice)
  • manual: Manual
  • relaunch: Relaunch
  • callback: Callback
  • scheduled: Scheduled
  • dependency: Dependency
  • workflow: Workflow
  • webhook: Webhook
  • sync: Sync
  • scm: SCM Update
• status: (choice)
  • new: New
  • pending: Pending
  • waiting: Waiting
  • running: Running
  • successful: Successful
  • failed: Failed
  • error: Error
  • canceled: Canceled
• execution_environment: The container image to be used for execution. (id)
• failed: (boolean)
• started: The date and time the job was queued for starting. (datetime)
• finished: The date and time the job finished execution. (datetime)
• canceled_on: The date and time when the cancel request was sent. (datetime)
• elapsed: Elapsed time in seconds that the job ran. (decimal)
• job_args: (string)
• job_cwd: (string)
• job_env: (json)
• job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
• execution_node: The node the job executed on. (string)
• controller_node: The instance that managed the execution environment. (string)
• result_traceback: (string)
• event_processing_finished: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)
• launched_by: (field)
• work_unit_id: The Receptor work unit ID associated with this job. (string)
• job_template: (id)
• passwords_needed_to_start: (field)
• allow_simultaneous: (boolean)
• artifacts: (json)
• scm_revision: The SCM Revision from the Project used for this job, if available (string)
• instance_group: The Instance group the job was run under (id)
• diff_mode: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)
• job_slice_number: If part of a sliced job, the ID of the inventory slice operated on. If not part of sliced job, parameter is not used. (integer)
• job_slice_count: If ran as part of sliced jobs, the total number of slices. If 1, job is not part of a sliced job. (integer)
• 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)
• webhook_guid: Unique identifier of the event that triggered this webhook (string)
• host_status_counts: Playbook stats from the Ansible playbook_on_stats event. (json)
• playbook_counts: A count of all plays and tasks for the job run. (field)
• custom_virtualenv: (string)

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : JobDetail

Type: object

Show Source

• allow_simultaneous: boolean
  Title: Allow simultaneous
• artifacts: string
  Title: Artifacts

  Read Only: true
• canceled_on: string(date-time)
  Title: Canceled on

  Read Only: true

  The date and time when the cancel request was sent.
• controller_node: string
  Title: Controller node

  Read Only: true

  Minimum Length: 1

  The instance that managed the execution environment.
• created: string
  Title: Created

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

  Read Only: true
• 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
• elapsed: string(decimal)
  Title: Elapsed

  Read Only: true

  Elapsed time in seconds that the job ran.
• event_processing_finished: boolean
  Title: Event processing finished

  Read Only: true

  Indicates whether all of the events generated by this unified job have been saved to the database.
• execution_environment: integer
  Title: Execution environment

  The container image to be used for execution.
• execution_node: string
  Title: Execution node

  Read Only: true

  Minimum Length: 1

  The node the job executed on.
• extra_vars: string
  Title: Extra vars
• failed: boolean
  Title: Failed

  Read Only: true
• finished: string(date-time)
  Title: Finished

  Read Only: true

  The date and time the job finished execution.
• force_handlers: boolean
  Title: Force handlers
• forks: integer
  Title: Forks

  Minimum Value: 0
• host_status_counts: object Host status counts
  Title: Host status counts

  Read Only: true

  Playbook stats from the Ansible playbook_on_stats event.
• id: integer
  Title: ID

  Read Only: true
• instance_group: integer
  Title: Instance group

  The Instance group the job was run under
• inventory: integer
  Title: Inventory
• job_args: string
  Title: Job args

  Read Only: true

  Minimum Length: 1
• job_cwd: string
  Title: Job cwd

  Read Only: true

  Minimum Length: 1
• job_env: object job_env
  Title: job_env

  Read Only: true
• job_explanation: string
  Title: Job explanation

  Read Only: true

  Minimum Length: 1

  A status field to indicate the state of the job if it wasn't able to run and capture stdout
• job_slice_count: integer
  Title: Job slice count

  Minimum Value: 0

  Default Value: 1

  If ran as part of sliced jobs, the total number of slices. If 1, job is not part of a sliced job.
• job_slice_number: integer
  Title: Job slice number

  Minimum Value: 0

  If part of a sliced job, the ID of the inventory slice operated on. If not part of sliced job, parameter is not used.
• job_tags: string
  Title: Job tags
• job_template: string
  Title: Job template
• job_type: string
  Title: Job type

  Default Value: run

  Allowed Values: [ "run", "check", "scan" ]
• launch_type: string
  Title: Launch type

  Read Only: true

  Allowed Values: [ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ]
• launched_by: string
  Title: Launched by

  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
• organization: integer
  Title: Organization

  Read Only: true

  The organization used to determine access to this unified job.
• passwords_needed_to_start: string
  Title: Passwords needed to start

  Read Only: true
• playbook: string
  Title: Playbook

  Maximum Length: 1024
• playbook_counts: string
  Title: Playbook counts

  Read Only: true

  A count of all plays and tasks for the job run.
• project: string
  Title: Project
• related: string
  Title: Related

  Read Only: true
• result_traceback: string
  Title: Result traceback

  Read Only: true

  Minimum Length: 1
• 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.
• scm_revision: string
  Title: SCM Revision

  Read Only: true

  Minimum Length: 1

  The SCM Revision from the Project used for this job, if available
• skip_tags: string
  Title: Skip tags

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

  Maximum Length: 1024
• started: string(date-time)
  Title: Started

  Read Only: true

  The date and time the job was queued for starting.
• status: string
  Title: Status

  Read Only: true

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

  Read Only: true
• timeout: integer
  Title: Timeout

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

  Read Only: true
• unified_job_template: string
  Title: unified job template

  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_guid: string
  Title: Webhook guid

  Maximum Length: 128

  Unique identifier of the event that triggered this webhook
• webhook_service: string
  Title: Webhook service

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

  Service that webhook requests will be accepted from
• work_unit_id: string
  Title: Work unit id

  Read Only: true

  Minimum Length: 1

  The Receptor work unit ID associated with this job.

{
    "properties":{
        "allow_simultaneous":{
            "title":"Allow simultaneous",
            "type":"boolean",
            "x-nullable":true
        },
        "artifacts":{
            "readOnly":true,
            "title":"Artifacts",
            "type":"string"
        },
        "canceled_on":{
            "description":"The date and time when the cancel request was sent.",
            "format":"date-time",
            "readOnly":true,
            "title":"Canceled on",
            "type":"string",
            "x-nullable":true
        },
        "controller_node":{
            "description":"The instance that managed the execution environment.",
            "minLength":"1",
            "readOnly":true,
            "title":"Controller node",
            "type":"string"
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "custom_virtualenv":{
            "readOnly":true,
            "title":"Custom virtualenv",
            "type":"string"
        },
        "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
        },
        "elapsed":{
            "description":"Elapsed time in seconds that the job ran.",
            "format":"decimal",
            "readOnly":true,
            "title":"Elapsed",
            "type":"string"
        },
        "event_processing_finished":{
            "description":"Indicates whether all of the events generated by this unified job have been saved to the database.",
            "readOnly":true,
            "title":"Event processing finished",
            "type":"boolean"
        },
        "execution_environment":{
            "description":"The container image to be used for execution.",
            "title":"Execution environment",
            "type":"integer",
            "x-nullable":true
        },
        "execution_node":{
            "description":"The node the job executed on.",
            "minLength":"1",
            "readOnly":true,
            "title":"Execution node",
            "type":"string"
        },
        "extra_vars":{
            "title":"Extra vars",
            "type":"string",
            "x-nullable":true
        },
        "failed":{
            "readOnly":true,
            "title":"Failed",
            "type":"boolean"
        },
        "finished":{
            "description":"The date and time the job finished execution.",
            "format":"date-time",
            "readOnly":true,
            "title":"Finished",
            "type":"string",
            "x-nullable":true
        },
        "force_handlers":{
            "title":"Force handlers",
            "type":"boolean",
            "x-nullable":true
        },
        "forks":{
            "minimum":"0",
            "title":"Forks",
            "type":"integer"
        },
        "host_status_counts":{
            "description":"Playbook stats from the Ansible playbook_on_stats event.",
            "readOnly":true,
            "title":"Host status counts",
            "type":"object",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "instance_group":{
            "description":"The Instance group the job was run under",
            "title":"Instance group",
            "type":"integer",
            "x-nullable":true
        },
        "inventory":{
            "title":"Inventory",
            "type":"integer",
            "x-nullable":true
        },
        "job_args":{
            "minLength":"1",
            "readOnly":true,
            "title":"Job args",
            "type":"string"
        },
        "job_cwd":{
            "minLength":"1",
            "readOnly":true,
            "title":"Job cwd",
            "type":"string"
        },
        "job_env":{
            "readOnly":true,
            "title":"job_env",
            "type":"object"
        },
        "job_explanation":{
            "description":"A status field to indicate the state of the job if it wasn't able to run and capture stdout",
            "minLength":"1",
            "readOnly":true,
            "title":"Job explanation",
            "type":"string"
        },
        "job_slice_count":{
            "default":"1",
            "description":"If ran as part of sliced jobs, the total number of slices. If 1, job is not part of a sliced job.",
            "minimum":"0",
            "title":"Job slice count",
            "type":"integer"
        },
        "job_slice_number":{
            "description":"If part of a sliced job, the ID of the inventory slice operated on. If not part of sliced job, parameter is not used.",
            "minimum":"0",
            "title":"Job slice number",
            "type":"integer"
        },
        "job_tags":{
            "title":"Job tags",
            "type":"string",
            "x-nullable":true
        },
        "job_template":{
            "title":"Job template",
            "type":"string",
            "x-nullable":true
        },
        "job_type":{
            "default":"run",
            "enum":[
                "run",
                "check",
                "scan"
            ],
            "title":"Job type",
            "type":"string",
            "x-nullable":true
        },
        "launch_type":{
            "enum":[
                "manual",
                "relaunch",
                "callback",
                "scheduled",
                "dependency",
                "workflow",
                "webhook",
                "sync",
                "scm"
            ],
            "readOnly":true,
            "title":"Launch type",
            "type":"string"
        },
        "launched_by":{
            "readOnly":true,
            "title":"Launched by",
            "type":"string"
        },
        "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
        },
        "organization":{
            "description":"The organization used to determine access to this unified job.",
            "readOnly":true,
            "title":"Organization",
            "type":"integer",
            "x-nullable":true
        },
        "passwords_needed_to_start":{
            "readOnly":true,
            "title":"Passwords needed to start",
            "type":"string"
        },
        "playbook":{
            "maxLength":"1024",
            "title":"Playbook",
            "type":"string",
            "x-nullable":true
        },
        "playbook_counts":{
            "description":"A count of all plays and tasks for the job run.",
            "readOnly":true,
            "title":"Playbook counts",
            "type":"string"
        },
        "project":{
            "title":"Project",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "result_traceback":{
            "minLength":"1",
            "readOnly":true,
            "title":"Result traceback",
            "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
        },
        "scm_revision":{
            "description":"The SCM Revision from the Project used for this job, if available",
            "minLength":"1",
            "readOnly":true,
            "title":"SCM Revision",
            "type":"string"
        },
        "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
        },
        "started":{
            "description":"The date and time the job was queued for starting.",
            "format":"date-time",
            "readOnly":true,
            "title":"Started",
            "type":"string",
            "x-nullable":true
        },
        "status":{
            "enum":[
                "new",
                "pending",
                "waiting",
                "running",
                "successful",
                "failed",
                "error",
                "canceled"
            ],
            "readOnly":true,
            "title":"Status",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "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"
        },
        "unified_job_template":{
            "readOnly":true,
            "title":"unified job template",
            "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_guid":{
            "description":"Unique identifier of the event that triggered this webhook",
            "maxLength":"128",
            "title":"Webhook guid",
            "type":"string",
            "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
        },
        "work_unit_id":{
            "description":"The Receptor work unit ID associated with this job.",
            "minLength":"1",
            "readOnly":true,
            "title":"Work unit id",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}

Nested Schema : Host status counts

Type: object

Title: Host status counts

Read Only: true

Playbook stats from the Ansible playbook_on_stats event.

Nested Schema : job_env

Type: object

Title: job_env

Read Only: true

Back to Top