Jump to

• Request
• Response

Retrieve a Host

get

/api/v2/hosts/{id}/

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

• id: Database ID for this host. (integer)
• type: Data type for this host. (choice)
• url: URL for this host. (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 host was created. (datetime)
• modified: Timestamp when this host was last modified. (datetime)
• name: Name of this host. (string)
• description: Optional description of this host. (string)
• inventory: (id)
• enabled: Is this host online and available for running jobs? (boolean)
• instance_id: The value used by the remote inventory source to uniquely identify the host (string)
• variables: Host variables in JSON or YAML format. (json)
• has_active_failures: (field)
• has_inventory_sources: (field)
• last_job: (id)
• last_job_host_summary: (id)
• ansible_facts_modified: The date and time ansible_facts was last modified. (datetime)

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 : Host

Type: object

Show Source

• ansible_facts_modified: string(date-time)
  Title: Ansible facts modified

  Read Only: true

  The date and time ansible_facts was last modified.
• created: string
  Title: Created

  Read Only: true
• description: string
  Title: Description
• enabled: boolean
  Title: Enabled

  Default Value: true

  Is this host online and available for running jobs?
• has_active_failures: string
  Title: Has active failures

  Read Only: true
• has_inventory_sources: string
  Title: Has inventory sources

  Read Only: true
• id: integer
  Title: ID

  Read Only: true
• instance_id: string
  Title: Instance id

  Maximum Length: 1024

  The value used by the remote inventory source to uniquely identify the host
• inventory(required): integer
  Title: Inventory
• last_job: string
  Title: Last job

  Read Only: true
• last_job_host_summary: integer
  Title: Last job host summary

  Read Only: true
• modified: string
  Title: Modified

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

  Minimum Length: 1

  Maximum Length: 512
• related: string
  Title: Related

  Read Only: true
• summary_fields: string
  Title: Summary fields

  Read Only: true
• type: string
  Title: Type

  Read Only: true
• url: string
  Title: Url

  Read Only: true
• variables: string
  Title: Variables

  Host variables in JSON or YAML format.

{
    "properties":{
        "ansible_facts_modified":{
            "description":"The date and time ansible_facts was last modified.",
            "format":"date-time",
            "readOnly":true,
            "title":"Ansible facts modified",
            "type":"string",
            "x-nullable":true
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "enabled":{
            "default":true,
            "description":"Is this host online and available for running jobs?",
            "title":"Enabled",
            "type":"boolean",
            "x-nullable":true
        },
        "has_active_failures":{
            "readOnly":true,
            "title":"Has active failures",
            "type":"string"
        },
        "has_inventory_sources":{
            "readOnly":true,
            "title":"Has inventory sources",
            "type":"string"
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "instance_id":{
            "description":"The value used by the remote inventory source to uniquely identify the host",
            "maxLength":"1024",
            "title":"Instance id",
            "type":"string",
            "x-nullable":true
        },
        "inventory":{
            "title":"Inventory",
            "type":"integer"
        },
        "last_job":{
            "readOnly":true,
            "title":"Last job",
            "type":"string",
            "x-nullable":true
        },
        "last_job_host_summary":{
            "readOnly":true,
            "title":"Last job host summary",
            "type":"integer",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "variables":{
            "description":"Host variables in JSON or YAML format.",
            "title":"Variables",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "name",
        "inventory"
    ],
    "type":"object"
}

Back to Top