Retrieve a Job Host Summary

get

/api/v2/jobs/{id}/

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

  • id: Database ID for this job host summary. (integer)
  • type: Data type for this job host summary. (choice)
  • url: URL for this job host summary. (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 host summary was created. (datetime)
  • modified: Timestamp when this job host summary was last modified. (datetime)
  • job: (id)
  • host: (id)
  • host_name: (string)
  • changed: (integer)
  • dark: (integer)
  • failures: (integer)
  • ok: (integer)
  • processed: (integer)
  • skipped: (integer)
  • failed: (boolean)
  • ignored: (integer)
  • rescued: (integer)

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Body
Example Response (application/json)
{
    "allow_simultaneous":false,
    "artifacts":{
    },
    "canceled_on":null,
    "controller_node":"",
    "created":"2018-02-01T08:00:00.000000Z",
    "custom_virtualenv":null,
    "description":"",
    "diff_mode":false,
    "elapsed":0,
    "event_processing_finished":false,
    "execution_node":"",
    "extra_vars":"{}",
    "failed":false,
    "finished":null,
    "force_handlers":false,
    "forks":0,
    "host_status_counts":{
    },
    "id":1,
    "instance_group":null,
    "inventory":null,
    "job_args":"",
    "job_cwd":"",
    "job_env":{
    },
    "job_explanation":"",
    "job_slice_count":1,
    "job_slice_number":0,
    "job_tags":"",
    "job_template":1,
    "job_type":"run",
    "launch_type":"manual",
    "limit":"",
    "modified":"2018-02-01T08:00:00.000000Z",
    "name":"",
    "organization":null,
    "passwords_needed_to_start":[
    ],
    "playbook":"",
    "playbook_counts":{
        "play_count":0,
        "task_count":0
    },
    "project":null,
    "related":{
        "activity_stream":"/api/v2/jobs/1/activity_stream/",
        "cancel":"/api/v2/jobs/1/cancel/",
        "create_schedule":"/api/v2/jobs/1/create_schedule/",
        "credentials":"/api/v2/jobs/1/credentials/",
        "job_events":"/api/v2/jobs/1/job_events/",
        "job_host_summaries":"/api/v2/jobs/1/job_host_summaries/",
        "job_template":"/api/v2/job_templates/1/",
        "labels":"/api/v2/jobs/1/labels/",
        "notifications":"/api/v2/jobs/1/notifications/",
        "relaunch":"/api/v2/jobs/1/relaunch/",
        "stdout":"/api/v2/jobs/1/stdout/",
        "unified_job_template":"/api/v2/job_templates/1/"
    },
    "result_traceback":"",
    "scm_branch":"",
    "scm_revision":"",
    "skip_tags":"",
    "start_at_task":"",
    "started":null,
    "status":"new",
    "summary_fields":{
        "credentials":[
        ],
        "job_template":{
            "description":"",
            "id":1,
            "name":""
        },
        "labels":{
            "count":0,
            "results":[
            ]
        },
        "unified_job_template":{
            "description":"",
            "id":1,
            "name":"",
            "unified_job_type":"job"
        },
        "user_capabilities":{
            "delete":true,
            "start":false
        }
    },
    "timeout":0,
    "type":"job",
    "unified_job_template":1,
    "url":"/api/v2/jobs/1/",
    "use_fact_cache":false,
    "verbosity":0,
    "webhook_credential":null,
    "webhook_guid":"",
    "webhook_service":""
}
Back to Top