Rule

List Operation Rules

Changed on

List Operation Rules on a Site. Filters compose with AND; results are paginated and the X-Pagination response header reports the total count over the post-filter set. Results are ordered by creation time descending, then Rule UUID descending.

Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

get/v2/org/{org}/nico/task/rule

Request

  • Base URL
    https://nico-rest-api.nico.svc.cluster.local
  • URL
    https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/task/rule
  • Auth
    HTTP bearer

Query parameters

siteIdstring uuid required

ID of the Site that owns the rules (rules are site-scoped).

operationType'PowerControl' | 'FirmwareControl'

Filter by operation type.

pageNumberinteger

One-indexed page number.

Page number of results returned (1-indexed).

pageSizeinteger

Number of results per page.

Response

OK

idstring uuid required

Unique identifier of the rule.

namestring required

Human-readable name of the rule. Required and non-empty.

descriptionstring

Optional free-form description.

operationType'PowerControl' | 'FirmwareControl' required

Type of operation this rule applies to. Immutable after creation.

operationCodestring required

Operation code within the operation type. For PowerControl, accepted values are power_on, force_power_on, power_off, force_power_off, restart, force_restart, warm_reset, and cold_reset. For FirmwareControl, accepted values are upgrade, downgrade, and rollback. The server validates the code against the selected type. Immutable after creation.

isDefaultboolean required

Whether this rule is currently the default for its (operationType, operationCode) tuple.

createdstring date-time required

Timestamp when the rule was created.

updatedstring date-time required

Timestamp when the rule was last updated.

Changes

  • 293dc126ab73Revision changes
    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

  • 78f3b35615a5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status