Jump to

• Request
• Response

Retrieve a Job Host Summary

get

/api/v2/job_host_summaries/{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)
• constructed_host: Only for jobs run against constructed inventories, this links to the host inside the constructed inventory. (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

• application/json

Path Parameters

• id(required): string

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : JobHostSummary

Type: object

Show Source

• changed: integer
  Title: Changed

  Read Only: true

  Minimum Value: 0
• constructed_host: integer
  Title: Constructed host

  Read Only: true

  Only for jobs run against constructed inventories, this links to the host inside the constructed inventory.
• created: string
  Title: Created

  Read Only: true
• dark: integer
  Title: Dark

  Read Only: true

  Minimum Value: 0
• failed: boolean
  Title: Failed

  Read Only: true
• failures: integer
  Title: Failures

  Read Only: true

  Minimum Value: 0
• host: integer
  Title: Host

  Read Only: true
• host_name: string
  Title: Host name

  Read Only: true

  Minimum Length: 1
• id: integer
  Title: ID

  Read Only: true
• ignored: integer
  Title: Ignored

  Read Only: true

  Minimum Value: 0
• job: string
  Title: Job

  Read Only: true
• modified: string
  Title: Modified

  Read Only: true
• ok: integer
  Title: Ok

  Read Only: true

  Minimum Value: 0
• processed: integer
  Title: Processed

  Read Only: true

  Minimum Value: 0
• related: string
  Title: Related

  Read Only: true
• rescued: integer
  Title: Rescued

  Read Only: true

  Minimum Value: 0
• skipped: integer
  Title: Skipped

  Read Only: true

  Minimum Value: 0
• summary_fields: string
  Title: Summary fields

  Read Only: true
• type: string
  Title: Type

  Read Only: true
• url: string
  Title: Url

  Read Only: true

{
    "properties":{
        "changed":{
            "minimum":"0",
            "readOnly":true,
            "title":"Changed",
            "type":"integer"
        },
        "constructed_host":{
            "description":"Only for jobs run against constructed inventories, this links to the host inside the constructed inventory.",
            "readOnly":true,
            "title":"Constructed host",
            "type":"integer",
            "x-nullable":true
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "dark":{
            "minimum":"0",
            "readOnly":true,
            "title":"Dark",
            "type":"integer"
        },
        "failed":{
            "readOnly":true,
            "title":"Failed",
            "type":"boolean"
        },
        "failures":{
            "minimum":"0",
            "readOnly":true,
            "title":"Failures",
            "type":"integer"
        },
        "host":{
            "readOnly":true,
            "title":"Host",
            "type":"integer",
            "x-nullable":true
        },
        "host_name":{
            "minLength":"1",
            "readOnly":true,
            "title":"Host name",
            "type":"string"
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "ignored":{
            "minimum":"0",
            "readOnly":true,
            "title":"Ignored",
            "type":"integer"
        },
        "job":{
            "readOnly":true,
            "title":"Job",
            "type":"string"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "ok":{
            "minimum":"0",
            "readOnly":true,
            "title":"Ok",
            "type":"integer"
        },
        "processed":{
            "minimum":"0",
            "readOnly":true,
            "title":"Processed",
            "type":"integer"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "rescued":{
            "minimum":"0",
            "readOnly":true,
            "title":"Rescued",
            "type":"integer"
        },
        "skipped":{
            "minimum":"0",
            "readOnly":true,
            "title":"Skipped",
            "type":"integer"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top