API documentation

>>>

GET /api/v2/discovery_rules
List all discovery rules

Params

Param name	Description
search optional	filter results Value: Must be String
order optional	sort results Value: Must be String
page optional	paginate results Value: Must be String
per_page optional	number of entries per request Value: Must be String

>>>

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

Params

Param name	Description
id required	Value: 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 , nil allowed	Value: Must be a Hash
discovery_rule[name] required	represents rule name shown to the users Value: Must be String
discovery_rule[search] required	query to match discovered hosts for the particular rule Value: Must be String
discovery_rule[hostgroup_id] required	the hostgroup that is used to auto provision a host Value: Must be Integer
discovery_rule[hostname] optional , nil allowed	defines a pattern to assign human-readable hostnames to the matching hosts Value: Must be String
discovery_rule[max_count] optional , nil allowed	enables to limit maximum amount of provisioned hosts per rule Value: Must be Integer
discovery_rule[priority] optional , nil allowed	puts the rules in order, low numbers go first. Must be greater then zero Value: Must be Integer
discovery_rule[enabled] optional , nil allowed	flag is used for temporary shutdown of rules Value: Must be ‘true’ or ‘false’

>>>

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

Params

Param name	Description
id required	Value: 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 , nil allowed	Value: Must be a Hash
discovery_rule[name] optional	represents rule name shown to the users Value: Must be String
discovery_rule[search] optional	query to match discovered hosts for the particular rule Value: Must be String
discovery_rule[hostgroup_id] optional	the hostgroup that is used to auto provision a host Value: Must be Integer
discovery_rule[hostname] optional , nil allowed	defines a pattern to assign human-readable hostnames to the matching hosts Value: Must be String
discovery_rule[max_count] optional , nil allowed	enables to limit maximum amount of provisioned hosts per rule Value: Must be Integer
discovery_rule[priority] optional , nil allowed	puts the rules in order, low numbers go first. Must be greater then zero Value: Must be Integer
discovery_rule[enabled] optional , nil allowed	flag is used for temporary shutdown of rules Value: Must be ‘true’ or ‘false’

>>>

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

Params

Param name	Description
id required	Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.