Jump to

• Request
• Response

Retrieve a Host Metric

get

/api/v2/host_metrics/{id}/

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

• id: Database ID for this host metric. (integer)
• hostname: (string)
• url: URL for this host metric. (string)
• first_automation: When the host was first automated against (datetime)
• last_automation: When the host was last automated against (datetime)
• last_deleted: When the host was last deleted (datetime)
• automated_counter: How many times was the host automated (integer)
• deleted_counter: How many times was the host deleted (integer)
• deleted: Boolean flag saying whether the host is deleted and therefore not counted into the subscription consumption (boolean)
• used_in_inventories: How many inventories contain this host (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 : HostMetric

Type: object

Show Source

• automated_counter: integer
  Title: Automated counter

  How many times was the host automated
• deleted: boolean
  Title: Deleted

  Boolean flag saying whether the host is deleted and therefore not counted into the subscription consumption
• deleted_counter: integer
  Title: Deleted counter

  How many times was the host deleted
• first_automation: string(date-time)
  Title: First automation

  Read Only: true

  When the host was first automated against
• hostname(required): string
  Title: Hostname

  Minimum Length: 1

  Maximum Length: 512
• id: integer
  Title: ID

  Read Only: true
• last_automation(required): string(date-time)
  Title: Last automation

  When the host was last automated against
• last_deleted: string(date-time)
  Title: Last deleted

  When the host was last deleted
• url: string
  Title: Url

  Read Only: true
• used_in_inventories: integer
  Title: Used in inventories

  How many inventories contain this host

{
    "properties":{
        "automated_counter":{
            "description":"How many times was the host automated",
            "title":"Automated counter",
            "type":"integer"
        },
        "deleted":{
            "description":"Boolean flag saying whether the host is deleted and therefore not counted into the subscription consumption",
            "title":"Deleted",
            "type":"boolean",
            "x-nullable":true
        },
        "deleted_counter":{
            "description":"How many times was the host deleted",
            "title":"Deleted counter",
            "type":"integer"
        },
        "first_automation":{
            "description":"When the host was first automated against",
            "format":"date-time",
            "readOnly":true,
            "title":"First automation",
            "type":"string"
        },
        "hostname":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Hostname",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "last_automation":{
            "description":"When the host was last automated against",
            "format":"date-time",
            "title":"Last automation",
            "type":"string"
        },
        "last_deleted":{
            "description":"When the host was last deleted",
            "format":"date-time",
            "title":"Last deleted",
            "type":"string",
            "x-nullable":true
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "used_in_inventories":{
            "description":"How many inventories contain this host",
            "title":"Used in inventories",
            "type":"integer",
            "x-nullable":true
        }
    },
    "required":[
        "hostname",
        "last_automation"
    ],
    "type":"object"
}

Back to Top