Comment on page
Dependencies
When a driver is loaded into Engine, it becomes a dependency. Dependencies are available as the blueprint from which modules are created. The
/dependencies endpoint provide methods to discover, load and update these. For more on the role the drivers play, see:Attribute | Type | Description |
id | string | The dependency's unique ID. |
name | string | Human readable name for the dependency. |
class_name | string | The Ruby class name of the driver. |
module_name | string | The kind of module this instantiates (e.g. Display). |
role | string | One of ssh, device, service, or logic. |
description | string | Additional information that describes the dependency. |
default | string orinteger | A URL or port number that is typical for modules using this. |
ignore_connected | boolean | Default state of connectivity monitoring for instances. |
settings | object | A JSON object containing configuration shared by all instances. |
created_at | integer | Timestamp of creation. |
get
https://example.com
/api/control/dependencies
Search
Queries default to searching for any of the entered terms (words). A small query language provides the ability to structure complex queries.
Operator | Action | |
+ | Matches both terms. | |
` | ` | Matches either terms. |
- | Negates a single token. | |
" | Wraps tokens to form a phrase. | |
( and ) | Provide precedence. | |
~N | Specifies edit distance (fuzziness) after a word. | |
~N | Specifies slop amount (deviation) after a phrase. | |
post
https://example.com
/api/control/dependencies
Create
get
https://example.com
/api/control/dependencies/{id}
Retrieve
put
https://example.com
/api/control/dependencies/{id}
Update
delete
https://example.com
/api/control/dependencies/{id}
Delete
post
https://example.com
/api/control/dependencies/{id}/reload
Reload
Last modified 3yr ago