GET /api/v2/discovery_rules
List all discovery rules

Params

Param Name Description
search
Optional

filter results

Validations:

  • Must be String

order
Optional

sort results

Validations:

  • Must be String

page
Optional

paginate results

Validations:

  • Must be String

per_page
Optional

number of entries per request

Validations:

  • Must be String


GET /api/v2/discovery_rules/:id
Show a discovery rule

Params

Param Name Description
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/v2/discovery_rules
Create a discovery rule

Params

Param Name Description
discovery_rule
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a Hash

discovery_rule[name]
Required

represents rule name shown to the users

Validations:

  • Must be String

discovery_rule[search]
Required

query to match discovered hosts for the particular rule

Validations:

  • Must be String

discovery_rule[hostgroup_id]
Required

the hostgroup that is used to auto provision a host

Validations:

  • Must be Integer

discovery_rule[hostname]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

defines a pattern to assign human-readable hostnames to the matching hosts

Validations:

  • Must be String

discovery_rule[max_count]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

enables to limit maximum amount of provisioned hosts per rule

Validations:

  • Must be Integer

discovery_rule[priority]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

puts the rules in order, low numbers go first. Must be greater then zero

Validations:

  • Must be Integer

discovery_rule[enabled]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

flag is used for temporary shutdown of rules

Validations:

  • Must be 'true' or 'false' or '1' or '0'

discovery_rule[location_ids]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

REPLACE locations with given ids

Validations:

  • Must be an array of any type

discovery_rule[organization_ids]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

REPLACE organisations with given ids.

Validations:

  • Must be an array of any type


PUT /api/v2/discovery_rules/:id
Update a rule

Params

Param Name Description
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

discovery_rule
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a Hash

discovery_rule[name]
Optional

represents rule name shown to the users

Validations:

  • Must be String

discovery_rule[search]
Optional

query to match discovered hosts for the particular rule

Validations:

  • Must be String

discovery_rule[hostgroup_id]
Optional

the hostgroup that is used to auto provision a host

Validations:

  • Must be Integer

discovery_rule[hostname]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

defines a pattern to assign human-readable hostnames to the matching hosts

Validations:

  • Must be String

discovery_rule[max_count]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

enables to limit maximum amount of provisioned hosts per rule

Validations:

  • Must be Integer

discovery_rule[priority]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

puts the rules in order, low numbers go first. Must be greater then zero

Validations:

  • Must be Integer

discovery_rule[enabled]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

flag is used for temporary shutdown of rules

Validations:

  • Must be 'true' or 'false' or '1' or '0'

discovery_rule[location_ids]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

REPLACE locations with given ids

Validations:

  • Must be an array of any type

discovery_rule[organization_ids]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

REPLACE organisations with given ids.

Validations:

  • Must be an array of any type


DELETE /api/v2/discovery_rules/:id
Delete a rule

Params

Param Name Description
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.