# info.description
The API of the Advisor project in Insights

# paths./api/insights/v1/ack/.get.description
        Display the list of rules that have been disabled or acknowledged in
        this account, along with who disabled them and their justification.
        

# paths./api/insights/v1/ack/.get.summary
List the rules that have been acknowledged (disabled)

# paths./api/insights/v1/ack/.get.parameters[].description
The initial index from which to return the results.

# paths./api/insights/v1/ack/.post.description
Add an acknowledgement for a rule, by rule ID.

If there's already an acknowledgement of this rule by this
accounts org_id, then return that.  Otherwise, a new ack is created.

# paths./api/insights/v1/ack/{rule_id}/.get.description
        Display who disabled a rule in this account, when, and their
        justification for disabling it.
        

# paths./api/insights/v1/ack/{rule_id}/.get.summary
Display a specific acknowledgement (disabling) of a rule

# paths./api/insights/v1/ack/{rule_id}/.put.description
Update an acknowledgement for a rule, by rule ID.

A new justification can be supplied.  The username is taken from the
authenticated request.  The updated ack is returned.

# paths./api/insights/v1/ack/{rule_id}/.delete.description
Delete an acknowledgement for a rule, by its rule ID.

If the ack existed, it is deleted and a 204 is returned.  Otherwise,
a 404 is returned.

# paths./api/insights/v1/ack/all/.get.description
List acks from all accounts, with org_id.

Has no pagination.

# paths./api/insights/v1/ackcount/.get.description
Get the ack counts for all active rules

Return a list of rule_ids and their ack counts

# paths./api/insights/v1/ackcount/{rule_id}/.get.description
Get the ack count for the given rule_id

Returns the rule_id and its ack count

# paths./api/insights/v1/autosubexclusion/.get.description
Returns all subscription exclusions for accounts

This returns a list of all subscription exclusions.
This contains exclusions and their account and org_id.
These are all accounts that are excluded from the autosub
subscription path for weekly report subscriptions.

# paths./api/insights/v1/autosubexclusion/.get.parameters[].description
The initial index from which to return the results.

# paths./api/insights/v1/autosubexclusion/.post.description
Create a new subscription exclusion for an account.

This creates a new subscription exclusion for an account.
This should contain an org_id and account. Only org_id is required.
Account is optional.

# paths./api/insights/v1/autosubexclusion/{org_id}/.get.description
Returns an individual subscription exclusion based on org_id.

This returns an individual subscription exclusion
based on the org_id.

# paths./api/insights/v1/autosubexclusion/{org_id}/.delete.description
Destroy an existing subscription exclusion in the system.

This will DELETE an existing subscription exclusion
in the system. Existing subscription exclusions
are identified and deleted by the "org_id" field.

# paths./api/insights/v1/disabled-rules/.get.description
Shows a list of rules that are disabled, either organisation-wide
(Ack) or system-specific (HostAck).  The status flag indicates which of
these causes this rule to be disabled.  To find which systems have
disabled a rule, use the 'rule_id' query parameter in the hostack/
endpoint.

# paths./api/insights/v1/disabled-rules/.get.parameters[].description
The initial index from which to return the results.

# paths./api/insights/v1/disabled-rules/{rule_id}/.get.description
Get the detail on whether the given rule is disabled, and the scope,
by rule_id.  A 404 only means that the rule is not disabled - it may
also not exist.  The account-wide scope will be returned first, if
the rule has both an account-wide and a system-specific acknowledgement.

# paths./api/insights/v1/export/hits/.get.description
Get each host and all rules currently affecting it.

We also only present active, non-acked (on an account AND host level)
rules.  Inventory data may be requested if Advisor has not seen all
the hosts. The accepted content type supplied in the request headers
is used to determine the supplied content type.

# paths./api/insights/v1/export/hits/.get.parameters[].description
Display systems with this text in their display_name

# paths./api/insights/v1/export/hits/.get.parameters[].description
Are there systems which contain these SAP SIDs?

# paths./api/insights/v1/export/hits/.get.parameters[].description
Display rules of this impact level (1..4)

# paths./api/insights/v1/export/hits/.get.parameters[].description
Display only rules that cause an incident

# paths./api/insights/v1/export/hits/.get.parameters[].description
Display only rules of this likelihood level (1..4)

# paths./api/insights/v1/export/hits/.get.parameters[].description
Display rules that require a reboot to fix

# paths./api/insights/v1/export/hits/.get.parameters[].description
Display rules with this resolution risk level (1..4)

# paths./api/insights/v1/export/hits/.get.parameters[].description
Tags have a namespace, key and value in the form namespace/key=value

# paths./api/insights/v1/export/hits/.get.parameters[].description
Display rules with this text in their text fields

# paths./api/insights/v1/export/hits/.get.parameters[].description
Display rules with this total risk level (1..4)

# paths./api/insights/v1/export/hits/.get.parameters[].description
Search for systems with this updater type

# paths./api/insights/v1/export/reports/.get.description
List the report details of each rule affecting each system.

System and Rule are referred to by ID only, to be correlated with the
Rule and System export data.  It's like the hits output but much
less repetitive.

# paths./api/insights/v1/export/reports/.get.parameters[].description
Display systems with this text in their display_name

# paths./api/insights/v1/export/reports/.get.parameters[].description
Are there systems which contain these SAP SIDs?

# paths./api/insights/v1/export/reports/.get.parameters[].description
Display rules of this impact level (1..4)

# paths./api/insights/v1/export/reports/.get.parameters[].description
Display only rules that cause an incident

# paths./api/insights/v1/export/reports/.get.parameters[].description
Display only rules of this likelihood level (1..4)

# paths./api/insights/v1/export/reports/.get.parameters[].description
Display rules that require a reboot to fix

# paths./api/insights/v1/export/reports/.get.parameters[].description
Display rules with this resolution risk level (1..4)

# paths./api/insights/v1/export/reports/.get.parameters[].description
Tags have a namespace, key and value in the form namespace/key=value

# paths./api/insights/v1/export/reports/.get.parameters[].description
Display rules with this text in their text fields

# paths./api/insights/v1/export/reports/.get.parameters[].description
Display rules with this total risk level (1..4)

# paths./api/insights/v1/export/reports/.get.parameters[].description
Search for systems with this updater type

# paths./api/insights/v1/export/rules/.get.description
List the report details of each rule affecting each system.

System and Rule are referred to by ID only, to be correlated with the
Rule and System export data.  It's like the hits output but much
less repetitive.

# paths./api/insights/v1/export/rules/.get.parameters[].description
Display systems with this text in their display_name

# paths./api/insights/v1/export/rules/.get.parameters[].description
Are there systems which contain these SAP SIDs?

# paths./api/insights/v1/export/rules/.get.parameters[].description
Display rules of this impact level (1..4)

# paths./api/insights/v1/export/rules/.get.parameters[].description
Display only rules that cause an incident

# paths./api/insights/v1/export/rules/.get.parameters[].description
Display only rules of this likelihood level (1..4)

# paths./api/insights/v1/export/rules/.get.parameters[].description
Display rules that require a reboot to fix

# paths./api/insights/v1/export/rules/.get.parameters[].description
Display rules with this resolution risk level (1..4)

# paths./api/insights/v1/export/rules/.get.parameters[].description
Tags have a namespace, key and value in the form namespace/key=value

# paths./api/insights/v1/export/rules/.get.parameters[].description
Display rules with this text in their text fields

# paths./api/insights/v1/export/rules/.get.parameters[].description
Display rules with this total risk level (1..4)

# paths./api/insights/v1/export/rules/.get.parameters[].description
Search for systems with this updater type

# paths./api/insights/v1/export/systems/.get.description
List of systems with details and hit counts.

Systems can be sorted and filtered by display name and rule id.

# paths./api/insights/v1/export/systems/.get.parameters[].description
Display systems with this text in their display_name

# paths./api/insights/v1/export/systems/.get.parameters[].description
Display systems with this text in their rule_id

# paths./api/insights/v1/export/systems/.get.parameters[].description
Search for systems with this updater type

# paths./api/insights/v1/hostack/.get.description
HostAcks acknowledge (and therefore hide) a rule from view in an
account for a specific system.

Hostacks are retrieved, edited and deleted by the 'id' field.

# paths./api/insights/v1/hostack/.get.parameters[].description
Are there systems which contain these SAP SIDs?

# paths./api/insights/v1/hostack/.get.parameters[].description
The initial index from which to return the results.

# paths./api/insights/v1/hostack/.get.parameters[].description
Display host acknowledgement of this/these rules

# paths./api/insights/v1/hostack/.get.parameters[].description
Tags have a namespace, key and value in the form namespace/key=value

# paths./api/insights/v1/hostack/.post.description
Add an acknowledgement for a rule, by rule ID, system, and account.

Return the new hostack.  If there's already an acknowledgement of
this rule by this account for a system, then return that.  This does
not take an 'id' number.

# paths./api/insights/v1/hostack/{id}/.get.description
        Display who disabled a rule on a system, when, and their justification
        for disabling it.  Host acks are selected by their ID number.
        

# paths./api/insights/v1/hostack/{id}/.get.summary
Display a specific acknowledgement (disabling) of a rule on a system

# paths./api/insights/v1/hostack/{id}/.get.parameters[].description
A unique integer value identifying this host ack.

# paths./api/insights/v1/hostack/{id}/.put.description
Update the justification for this host acknowledgement.

The justification is taken from the request body.  The created_by
field is taken from the username in the x-rh-identity field, and the
updated_at field is set to the current time.

# paths./api/insights/v1/hostack/{id}/.put.parameters[].description
A unique integer value identifying this host ack.

# paths./api/insights/v1/hostack/{id}/.delete.description
Delete an acknowledgement for a rule, for a system, for an account, by its ID.

Takes the hostack ID (given in the hostack list) as an identifier.

# paths./api/insights/v1/hostack/{id}/.delete.parameters[].description
A unique integer value identifying this host ack.

# paths./api/insights/v1/kcs/.get.description
Looks for all active rules with KCS solutions

Returns a list of dicts of the C.R.C rule URL and its KCS solution number

# paths./api/insights/v1/kcs/.get.parameters[].description
Display the rule urls for the given list of comma separated KCS solution node_ids

# paths./api/insights/v1/kcs/{node_id}/.get.description
Gets active rule(s) for a particular KCS solution (node_id)

Returns a list of C.R.C rule url(s) for that KCS solution

# paths./api/insights/v1/pathway/.get.description
This returns a list of all Pathways. Will display the same
information as is provided in the retrieve view, but has all Pathways
listed.

# paths./api/insights/v1/pathway/.get.parameters[].description
Are there systems which contain these SAP SIDs?

# paths./api/insights/v1/pathway/.get.parameters[].description
Display only pathways where there are incidents.

# paths./api/insights/v1/pathway/.get.parameters[].description
Display pathways even if they aren't impacting systems currently

# paths./api/insights/v1/pathway/.get.parameters[].description
The initial index from which to return the results.

# paths./api/insights/v1/pathway/.get.parameters[].description
Display only pathways where reboot is required.

# paths./api/insights/v1/pathway/.get.parameters[].description
Tags have a namespace, key and value in the form namespace/key=value

# paths./api/insights/v1/pathway/.get.parameters[].description
Filter pathway names with this text. If viewing details for a pathway for rules, reports and systems, additional filter on their text fields

# paths./api/insights/v1/pathway/{slug}/.get.description
This returns an individual pathway based on slug.
Will display the same information as is
provided in the list view.

# paths./api/insights/v1/pathway/{slug}/.get.summary
Returns an individual Pathway based on slug

# paths./api/insights/v1/pathway/{slug}/.get.parameters[].description
Are there systems which contain these SAP SIDs?

# paths./api/insights/v1/pathway/{slug}/.get.parameters[].description
Tags have a namespace, key and value in the form namespace/key=value

# paths./api/insights/v1/pathway/{slug}/.get.parameters[].description
Filter pathway names with this text. If viewing details for a pathway for rules, reports and systems, additional filter on their text fields

# paths./api/insights/v1/pathway/{slug}/reports/.get.description
Each rule is listed once, with the systems currently reporting an
incidence of that rule in a list.

# paths./api/insights/v1/pathway/{slug}/reports/.get.summary
Get the list of systems for each rule in this pathway

# paths./api/insights/v1/pathway/{slug}/reports/.get.parameters[].description
Display Pathway Reports of this/these systems

# paths./api/insights/v1/pathway/{slug}/reports/.get.parameters[].description
Display Pathway Reports of this/these rules

# paths./api/insights/v1/pathway/{slug}/reports/.get.parameters[].description
Filter pathway names with this text. If viewing details for a pathway for rules, reports and systems, additional filter on their text fields

# paths./api/insights/v1/pathway/{slug}/reports/.get.parameters[].description
Search for systems with this updater type

# paths./api/insights/v1/pathway/{slug}/rules/.get.description
This view will retrieve/list in paginated
format, all rules for a specific Pathway.
This does not take into account acks
or host asks. The Specific Pathway
is requested by its slug

# paths./api/insights/v1/pathway/{slug}/rules/.get.parameters[].description
The initial index from which to return the results.

# paths./api/insights/v1/pathway/{slug}/rules/.get.parameters[].description
Filter pathway names with this text. If viewing details for a pathway for rules, reports and systems, additional filter on their text fields

# paths./api/insights/v1/pathway/{slug}/systems/.get.description
This view will retrieve/list in paginated
format, all impacted systems for an account,
for a specific Pathway. The specific Pathway
is requested by its slug.

# paths./api/insights/v1/pathway/{slug}/systems/.get.summary
Get all impacted systems for an account for a specific Pathway

# paths./api/insights/v1/pathway/{slug}/systems/.get.parameters[].description
Are there systems which contain these SAP SIDs?

# paths./api/insights/v1/pathway/{slug}/systems/.get.parameters[].description
The initial index from which to return the results.

# paths./api/insights/v1/pathway/{slug}/systems/.get.parameters[].description
Tags have a namespace, key and value in the form namespace/key=value

# paths./api/insights/v1/pathway/{slug}/systems/.get.parameters[].description
Filter pathway names with this text. If viewing details for a pathway for rules, reports and systems, additional filter on their text fields

# paths./api/insights/v1/pathway/{slug}/systems/.get.parameters[].description
Search for systems with this updater type

# paths./api/insights/v1/rating/.get.description
List all rules rated by the current user

Only the current user's ratings are listed here.

# paths./api/insights/v1/rating/.get.parameters[].description
The initial index from which to return the results.

# paths./api/insights/v1/rating/.post.description
Add or update a rating for a rule, by rule ID.

Return the new rating.  Any previous rating for this rule by this
user is amended to the current value.  This does not attempt to delete
a rating by this user of this rule if the rating is zero.

# paths./api/insights/v1/rating/{rule}/.get.description
Retrieve the ratings for a single rule, by Insights Rule ID

# paths./api/insights/v1/rating/all_ratings/.get.description
Show all ratings.

Available only to internal users.

# paths./api/insights/v1/rating/all_ratings/.get.parameters[].description
The initial index from which to return the results.

# paths./api/insights/v1/rating/stats/.get.description
Summarise the ratings for a rule.

This summarises the statistics for each rule.  Available only to
internal users.

# paths./api/insights/v1/rating/stats/.get.parameters[].description
The initial index from which to return the results.

# paths./api/insights/v1/rule/.get.description
List all active rules for this account.

If 'acked' is False or not given, then only rules that are not acked
will be shown.  If acked is set and 'true' as a string or evaluates
to a true value, then all rules including those that are acked will
be shown.

# paths./api/insights/v1/rule/.get.parameters[].description
Are there systems which contain these SAP SIDs?

# paths./api/insights/v1/rule/.get.parameters[].description
Display rules that have (one or more) tags

# paths./api/insights/v1/rule/.get.parameters[].description
Display rules of this impact level (1..4)

# paths./api/insights/v1/rule/.get.parameters[].description
Display only rules that are impacting systems currently

# paths./api/insights/v1/rule/.get.parameters[].description
Display only rules that cause an incident

# paths./api/insights/v1/rule/.get.parameters[].description
Display only rules of this likelihood level (1..4)

# paths./api/insights/v1/rule/.get.parameters[].description
The initial index from which to return the results.

# paths./api/insights/v1/rule/.get.parameters[].description
Display rules that require a reboot to fix

# paths./api/insights/v1/rule/.get.parameters[].description
Display rules where reports are shown or not

# paths./api/insights/v1/rule/.get.parameters[].description
Display rules with this resolution risk level (1..4)

# paths./api/insights/v1/rule/.get.parameters[].description
Display rules which are enabled, disabled (acked) by user, or disabled (acked) by Red Hat

# paths./api/insights/v1/rule/.get.parameters[].description
Tags have a namespace, key and value in the form namespace/key=value

# paths./api/insights/v1/rule/.get.parameters[].description
Display rules with this text in their text fields

# paths./api/insights/v1/rule/.get.parameters[].description
Display rules with this total risk level (1..4)

# paths./api/insights/v1/rule/.get.parameters[].description
Search for systems with this updater type

# paths./api/insights/v1/rule/{rule_id}/.get.description
Retrieve a single rule and its associated details.

This includes the account-relevant details such as number of
impacted systems and host acknowledgements.

# paths./api/insights/v1/rule/{rule_id}/.get.parameters[].description
Tags have a namespace, key and value in the form namespace/key=value

# paths./api/insights/v1/rule/{rule_id}/ack_hosts/.post.description
Add acknowledgements for one or more hosts to this rule.

Host acknowledgements will be added to this rule in this account for
the system UUIDs supplied.  The justification supplied will be given
for all host acks created.  Any existing host acknowledgements for a
host on this rule will be updated.  The count of created hosts
acknowledgements, and the list of systems now impacted by this rule,
will be returned.  Account-wide acks are unaffected.

# paths./api/insights/v1/rule/{rule_id}/justifications/.get.description
List all justifications given for disabling this rule.

This is an **internal-only** view that allows us to provide feedback
on why rules are disabled by our customers.  It lists the
justifications given in both account-wide acks and host-specific acks
of a rule.

# paths./api/insights/v1/rule/{rule_id}/justifications/.get.parameters[].description
The initial index from which to return the results.

# paths./api/insights/v1/rule/{rule_id}/stats/.get.description
Display usage and impact statistics for this rule.

For internal use only.  This allows rule developers to see the number
of systems and accounts impacted by a rule.

# paths./api/insights/v1/rule/{rule_id}/systems/.get.description
List all systems affected by this rule.

All systems owned by the user's account, with a current upload
reporting the given rule, are listed.  Systems are simply listed by
Insights Inventory UUID.

# paths./api/insights/v1/rule/{rule_id}/systems/.get.parameters[].description
Are there systems which contain these SAP SIDs?

# paths./api/insights/v1/rule/{rule_id}/systems/.get.parameters[].description
Search for systems that include this in their display name

# paths./api/insights/v1/rule/{rule_id}/systems/.get.parameters[].description
Display only systems with these versions of RHEL

# paths./api/insights/v1/rule/{rule_id}/systems/.get.parameters[].description
Display only systems with this type ('all' = both types)

# paths./api/insights/v1/rule/{rule_id}/systems/.get.parameters[].description
Tags have a namespace, key and value in the form namespace/key=value

# paths./api/insights/v1/rule/{rule_id}/systems/.get.parameters[].description
Search for systems with this updater type

# paths./api/insights/v1/rule/{rule_id}/systems_detail/.get.description
List systems affected by this rule with additional information about each system

All systems owned by the user's account, with a current upload
reporting the given rule, are listed in a paginated format.

Additional information includes hit counts and upload/stale timestamps.

# paths./api/insights/v1/rule/{rule_id}/systems_detail/.get.parameters[].description
Are there systems which contain these SAP SIDs?

# paths./api/insights/v1/rule/{rule_id}/systems_detail/.get.parameters[].description
Search for systems that include this in their display name

# paths./api/insights/v1/rule/{rule_id}/systems_detail/.get.parameters[].description
The initial index from which to return the results.

# paths./api/insights/v1/rule/{rule_id}/systems_detail/.get.parameters[].description
Display only systems with these versions of RHEL

# paths./api/insights/v1/rule/{rule_id}/systems_detail/.get.parameters[].description
Display only systems with this type ('all' = both types)

# paths./api/insights/v1/rule/{rule_id}/systems_detail/.get.parameters[].description
Tags have a namespace, key and value in the form namespace/key=value

# paths./api/insights/v1/rule/{rule_id}/unack_hosts/.post.description
Delete acknowledgements for one or more hosts to this rule.

Any host acknowledgements for this rule in this account for the given
system are deleted.  Hosts that do not have an acknowledgement for
this rule in this account are ignored.  The count of deleted host
acknowledgements, and the list of hosts now impacted by this rule,
will be returned.  Account-wide acks are unaffected.

# paths./api/insights/v1/rulecategory/.get.description
Rules are divided into categories, the usual being Availability,
Stability, Security and Performance.

Categories are listed in decreasing order of importance.

# paths./api/insights/v1/rulecategory/{id}/.get.description
Rules are divided into categories, the usual being Availability,
Stability, Security and Performance.

Categories are listed in decreasing order of importance.

# paths./api/insights/v1/rulecategory/{id}/.get.parameters[].description
A unique integer value identifying this rule category.

# paths./api/insights/v1/stats/.get.description
Provide a simple list of URLs contained here.

A list of statistics views.

# paths./api/insights/v1/stats/overview/.get.description
Show overview statistics for this user

This gives the number of pathways, and incident, critical and
important recommendations, affecting systems that the user can see.

# paths./api/insights/v1/stats/overview/.get.parameters[].description
Tags have a namespace, key and value in the form namespace/key=value

# paths./api/insights/v1/stats/overview/.get.parameters[].description
Are there systems which contain these SAP SIDs?

# paths./api/insights/v1/stats/reports/.get.description
Show statistics of reports impacting across categories and risks.

Only current reports are considered.

# paths./api/insights/v1/stats/reports/.get.parameters[].description
Tags have a namespace, key and value in the form namespace/key=value

# paths./api/insights/v1/stats/reports/.get.parameters[].description
Are there systems which contain these SAP SIDs?

# paths./api/insights/v1/stats/rules/.get.description
Show statistics of rule usage across categories and risks.

Only current reports are considered.

# paths./api/insights/v1/stats/rules/.get.parameters[].description
Tags have a namespace, key and value in the form namespace/key=value

# paths./api/insights/v1/stats/rules/.get.parameters[].description
Are there systems which contain these SAP SIDs?

# paths./api/insights/v1/stats/systems/.get.description
Show statistics of systems being impacted across categories and risks.

Only current reports are considered.

# paths./api/insights/v1/stats/systems/.get.parameters[].description
Tags have a namespace, key and value in the form namespace/key=value

# paths./api/insights/v1/stats/systems/.get.parameters[].description
Are there systems which contain these SAP SIDs?

# paths./api/insights/v1/status/.get.description
Provide a simple list of URLs contained here.

A list of statistics views.

# paths./api/insights/v1/status/live/.get.description
Is the Advisor API live and serving requests?

This returns a dictionary with properties defining the status of the
components Advisor relies on.

At the moment this is the same as the Readiness check (see `/ready/`).
In the future it may include other checks if we need to, but the
properties of `/ready/` will always be included.

# paths./api/insights/v1/status/ready/.get.description
Is the Advisor API ready to serve requests?

This returns a dictionary with properties defining the status of the
components Advisor relies on.

* 'django' should always be True.  If Django isn't ready, you can't
  get this information :-)
* 'database' is True when a database access returns successfully with
  valid information.
* 'rbac' is True when we can make a request to the RBAC API and get
  a valid response.
* 'advisor' is True if all of the above are True.

# paths./api/insights/v1/system/.get.description
Returns systems with their hit count and last upload time.

Results can be sorted and systems can be filtered by display name and hits

# paths./api/insights/v1/system/.get.parameters[].description
Display systems with this text in their display_name

# paths./api/insights/v1/system/.get.parameters[].description
Are there systems which contain these SAP SIDs?

# paths./api/insights/v1/system/.get.parameters[].description
Display systems which has at least one disabled recommendation

# paths./api/insights/v1/system/.get.parameters[].description
Display systems with hits of the given total_risk value (1..4), or 0 to display all systems

# paths./api/insights/v1/system/.get.parameters[].description
Display only systems reporting an incident

# paths./api/insights/v1/system/.get.parameters[].description
The initial index from which to return the results.

# paths./api/insights/v1/system/.get.parameters[].description
Display systems with rule hits for this Pathway

# paths./api/insights/v1/system/.get.parameters[].description
Display only systems with these versions of RHEL

# paths./api/insights/v1/system/.get.parameters[].description
Display only systems with this type ('all' = both types)

# paths./api/insights/v1/system/.get.parameters[].description
Tags have a namespace, key and value in the form namespace/key=value

# paths./api/insights/v1/system/.get.parameters[].description
Search for systems with this updater type

# paths./api/insights/v1/system/{uuid}/.get.description
Retrieve the reports for a single system by Insights Inventory UUID

# paths./api/insights/v1/system/{uuid}/.get.summary
Retrieve the reports for a single system

# paths./api/insights/v1/system/{uuid}/.get.parameters[].description
A UUID string identifying this inventory host.

# paths./api/insights/v1/system/{uuid}/reports/.get.description
Returns the list of latest reports for an Inventory Host ID.

Returns reports that:
 * are in the user's account
 * have an active, not-deleted rule
 * where the rule has not been acked by this account

If the host ID is not found, return an empty list.

# paths./api/insights/v1/system/{uuid}/reports/.get.parameters[].description
Are there systems which contain these SAP SIDs?

# paths./api/insights/v1/system/{uuid}/reports/.get.parameters[].description
Display only systems with this type ('all' = both types)

# paths./api/insights/v1/system/{uuid}/reports/.get.parameters[].description
Tags have a namespace, key and value in the form namespace/key=value

# paths./api/insights/v1/system/{uuid}/reports/.get.parameters[].description
Search for systems with this updater type

# paths./api/insights/v1/system/{uuid}/reports/.get.parameters[].description
A UUID string identifying this inventory host.

# paths./api/insights/v1/systemtype/.get.description
List all system types by role and product code

# paths./api/insights/v1/systemtype/{id}/.get.description
Retrieve details of a single system type

# paths./api/insights/v1/systemtype/{id}/.get.parameters[].description
A unique integer value identifying this system type.

# paths./api/insights/v1/topic/.get.description
List the rule topics and their impacted systems counts.

Normally this only shows enabled topics, but if the 'show_disabled'
parameter is set to True then this will show disabled topics as
well.

# paths./api/insights/v1/topic/.get.parameters[].description
Are there systems which contain these SAP SIDs?

# paths./api/insights/v1/topic/.get.parameters[].description
Display topics that are disabled as well as enabled

# paths./api/insights/v1/topic/.get.parameters[].description
Tags have a namespace, key and value in the form namespace/key=value

# paths./api/insights/v1/topic/.get.parameters[].description
Search for systems with this updater type

# paths./api/insights/v1/topic/{slug}/.get.description
Retrieve a single topic by slug.

This also lists the topic's impacted systems count.

# paths./api/insights/v1/topic/{slug}/rules_with_tag/.get.description
Lists the available rules that have this tag.

This shows the rule information for rules with this tag.

# paths./api/insights/v1/topic/{slug}/systems/.get.description
List all systems affected by this rule topic.

Systems are just listed by their UUID.

# paths./api/insights/v1/topic/{slug}/systems/.get.parameters[].description
Are there systems which contain these SAP SIDs?

# paths./api/insights/v1/topic/{slug}/systems/.get.parameters[].description
Tags have a namespace, key and value in the form namespace/key=value

# paths./api/insights/v1/topic/{slug}/systems/.get.parameters[].description
Search for systems with this updater type

# paths./api/insights/v1/user-preferences/.get.description
Describe the settings we have in a Data-Driven Forms way.

This simply compiles the 'show_satellite_hosts' account-wide setting
and the weekly report 'is_subscribed' user-specific setting into one
handy view, with the description metadata necessary to use Data-Driven
Forms to display it.

# paths./api/insights/v1/user-preferences/.post.description
Accept the settings as input, and adjust the actual models accordingly.

The current account settings will be updated, or one will be created,
with the

# paths./api/insights/v1/weeklyreportautosubscribe/.get.description
Show the user's current subscription status.

This shows the presence of a weekly report subscription by the user
in this account.

# paths./api/insights/v1/weeklyreportautosubscribe/.post.description
Set the auto-subscription status of the current user to the supplied
`is_auto_subscribed` value.

If 'is_auto_subscribed' is true, an auto-subscription is added if it doesn't
already exist.  If it is false, the auto-subscription is removed if it
exists.

Check if ENABLE_AUTOSUB enviroment variable is set to allow the method.

# paths./api/insights/v1/weeklyreportsubscription/.get.description
Show the user's current subscription status.

This shows the presence of a weekly report subscription by the user
in this account.

# paths./api/insights/v1/weeklyreportsubscription/.post.description
Set the subscription status of the current user to the supplied
`is_subscribed` value.

If 'is_subscribed' is true, a subscription is added if it doesn't
already exist.  If it is false, the subscription is removed if it
exists.

# components.schemas.Ack.description
An 'ack'nowledgement of a rule across an entire organisation.  This hides
(or disables) the given rule, so that all systems in this organisation
systems do not appear to be affected by the rule.

# components.schemas.AllRuleRatings.description
This is only available to internal users and lists ratings from all users.

# components.schemas.AutoSubscribe.description
Serializer specifically for listing
all Pathways currently in the system

# components.schemas.AutoSubscribeInput.description
Serializer specifically for handling
CREATE and UPDATE views for AutoSubscribe

# components.schemas.DisabledRules.description
Displays rules which are disabled, either organisation-wide (Ack) or
system-specific (HostAck).  The scope field indicates which of these
causes this rule to be disabled - 'account' or 'system'.  To find which
systems have disabled a rule, use the 'rule_id' query parameter in the
hostack/ endpoint.

# components.schemas.ExportHits.description
The basic report information for each system affected by a rule.  Only
lists basic details of the host and rule, and links to more information.

# components.schemas.HostAck.description
Ignore reports of this rule on this system for this account.  This
'ack'nowledges (or hides) this rule from affecting this rule on this
system.

# components.schemas.HostAck.properties.created_by.description
The username that created this acknowledgement

# components.schemas.HostAckInput.description
Ignore reports of this rule on this system for this account.

Use this when creating a new HostAck.

# components.schemas.HostAckJustification.description
Just modify the justification on a Host Ack.

# components.schemas.Kcs.description
Pairings of C.R.C rule URL and its KCS solution number (node_id)

# components.schemas.MultiAckResponse.description
The response from adding or deleting multiple acks on a rule.  For backward
compatibility we include the count, and then list the impacted systems.

# components.schemas.MultiHostAck.description
Add acks to multiple hosts for a single rule.

# components.schemas.MultiHostUnAck.description
Delete acks from multiple hosts for a single rule.

# components.schemas.Pathway.description
Serializer specifically for listing
all Pathways currently in the system

# components.schemas.PreferencesInput.description
User preferences - separated from account settings.

# components.schemas.ReportExport.description
Report information for export.  Based on CurrentReport with fields from
Rule and Host pulled through for convenience.

# components.schemas.Rule.description
The standard rule information.  Used for models and relations that don't
know the account and therefore can't know the acks or impacted systems.

# components.schemas.RuleForAccount.description
Rule information when we know the account, and therefore can calculate
the number of impacted systems and the reports_shown/rule_status flags.
We have to declare those explicitly here because they're not part of the model.

# components.schemas.RuleRating.description
Rule ratings list the rating (-1, 0 or +1) for one or more rules.  The
rule is listed by its Insights Rule ID.

# components.schemas.RuleRatingStats.description
Output of statistics view of rule ratings - rule ID and totals of ratings.

# components.schemas.RuleSystemsExport.description
List of systems with current reports for each rule.

# components.schemas.RuleUsageStats.description
Rule usage statistics for rule developers.

# components.schemas.SettingDDF.description
Outputs the description of the settings in a Data-Driven Forms format.

# components.schemas.SettingsDDF.description
Combining the DDF fields into one 'fields' object.

# components.schemas.Stats.description
Advisor rule or report frequency statisics.

# components.schemas.SystemType.description
RHN-based system types classified by role and product code.

# components.schemas.SystemsForRule.description
The list of Inventory Host IDs that are (currently) affected by a given
rule.

# components.schemas.Topic.description
Topics group rules by a tag shared by all the rules.

# servers[].description
The API of the Advisor project in Insights