Jump to

• Request
• Response

Retrieve an Ad Hoc Command Event

get

/api/v2/ad_hoc_command_events/{id}/

Make GET request to this resource to retrieve a single ad hoc command event record containing the following fields:

• id: Database ID for this ad hoc command event. (integer)
• type: Data type for this ad hoc command event. (choice)
• url: URL for this ad hoc command event. (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 ad hoc command event was created. (datetime)
• modified: Timestamp when this ad hoc command event was last modified. (datetime)
• ad_hoc_command: (id)
• event: (choice)
  • runner_on_failed: Host Failed
  • runner_on_ok: Host OK
  • runner_on_unreachable: Host Unreachable
  • runner_on_skipped: Host Skipped
  • debug: Debug
  • verbose: Verbose
  • deprecated: Deprecated
  • warning: Warning
  • system_warning: System Warning
  • error: Error
• counter: (integer)
• event_display: (string)
• event_data: (json)
• failed: (boolean)
• changed: (boolean)
• uuid: (string)
• host: (id)
• host_name: (string)
• stdout: (string)
• start_line: (integer)
• end_line: (integer)
• verbosity: (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 : AdHocCommandEvent

Type: object

Show Source

• ad_hoc_command: string
  Title: Ad hoc command

  Read Only: true
• changed: boolean
  Title: Changed

  Read Only: true
• counter: integer
  Title: Counter

  Read Only: true

  Minimum Value: 0
• created: string
  Title: Created

  Read Only: true
• end_line: integer
  Title: End line

  Read Only: true

  Minimum Value: 0
• event(required): string
  Title: Event

  Allowed Values: [ "runner_on_failed", "runner_on_ok", "runner_on_unreachable", "runner_on_skipped", "debug", "verbose", "deprecated", "warning", "system_warning", "error" ]
• event_data: object Event data
  Title: Event data
• event_display: string
  Title: Event display

  Read Only: true

  Minimum Length: 1
• failed: boolean
  Title: Failed

  Read Only: true
• 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
• modified: string
  Title: Modified

  Read Only: true
• related: string
  Title: Related

  Read Only: true
• start_line: integer
  Title: Start line

  Read Only: true

  Minimum Value: 0
• stdout: string
  Title: Stdout

  Read Only: true

  Minimum Length: 1
• summary_fields: string
  Title: Summary fields

  Read Only: true
• type: string
  Title: Type

  Read Only: true
• url: string
  Title: Url

  Read Only: true
• uuid: string
  Title: Uuid

  Read Only: true

  Minimum Length: 1
• verbosity: integer
  Title: Verbosity

  Read Only: true

  Minimum Value: 0

{
    "properties":{
        "ad_hoc_command":{
            "readOnly":true,
            "title":"Ad hoc command",
            "type":"string"
        },
        "changed":{
            "readOnly":true,
            "title":"Changed",
            "type":"boolean"
        },
        "counter":{
            "minimum":"0",
            "readOnly":true,
            "title":"Counter",
            "type":"integer"
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "end_line":{
            "minimum":"0",
            "readOnly":true,
            "title":"End line",
            "type":"integer"
        },
        "event":{
            "enum":[
                "runner_on_failed",
                "runner_on_ok",
                "runner_on_unreachable",
                "runner_on_skipped",
                "debug",
                "verbose",
                "deprecated",
                "warning",
                "system_warning",
                "error"
            ],
            "title":"Event",
            "type":"string",
            "x-nullable":true
        },
        "event_data":{
            "title":"Event data",
            "type":"object"
        },
        "event_display":{
            "minLength":"1",
            "readOnly":true,
            "title":"Event display",
            "type":"string"
        },
        "failed":{
            "readOnly":true,
            "title":"Failed",
            "type":"boolean"
        },
        "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"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "start_line":{
            "minimum":"0",
            "readOnly":true,
            "title":"Start line",
            "type":"integer"
        },
        "stdout":{
            "minLength":"1",
            "readOnly":true,
            "title":"Stdout",
            "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"
        },
        "uuid":{
            "minLength":"1",
            "readOnly":true,
            "title":"Uuid",
            "type":"string"
        },
        "verbosity":{
            "minimum":"0",
            "readOnly":true,
            "title":"Verbosity",
            "type":"integer"
        }
    },
    "required":[
        "event"
    ],
    "type":"object"
}

Nested Schema : Event data

Type: object

Title: Event data

Back to Top