Qodex.ai

Fetch a list of all workloads

GET {{base_url}}/api/workload_management/v5/workloads

Request Params

KeyDatatypeRequiredDescription
ordernull(Optional) Defines sorting by root applications' orderable items. Only one orderable is
allowed. The format is sorting_mode(orderable) (where sorting_mode is asc or
desc) or just orderable (with sorting_mode defaulted to asc).

Available orderable items:

  • is_group
  • asc(updated_at)

Type: String | | limit | number | | (Optional) Number of element in the page.

Type: Integer | | before | null | | (Optional) Cursor before the current page.

Type: String | | after | null | | (Optional) Cursor after the current page.

Type: String | | tenant_id | string | | (Optional) Filter by one or more tenant IDs. The IDs are of type InternalID. Maximum 100 items.

Type: String | | agent_id | string | | (Optional) Filter by one or more agent IDs. The IDs are of type InternalID. Maximum 100 items.

Type: String | | parent_id | string | | (Optional) Filter by one or more parent IDs. The IDs are of type InternalID. Maximum 100 items.

Type: String | | group_member_id | string | | (Optional) Filter by one or more group member IDs. The IDs are of type InternalID. Maximum 100 items.

Type: String | | type | string | | (Optional) Filter by one or more workload types. Items are of type string or cti.CTI (for workloads derived from cti.a.p.wm.workload.v1.0). Maximum 10 items.

Type: String | | application | string | | (Optional) Filter by one or more applications. Maximum 30 items.

Type: Union May be any of:

  1. Type: String Pattern: ^([a-z][a-z0-9_]*.[a-z][a-z0-9_.]+(.v[\d]+(.[\d]+){0,2})?)$

  2. Type: String | | workload_id | string | | (Optional) Filter by one or more workload IDs. The IDs are of type InternalID. Maximum 100 items.

Type: String | | search | string | | (Optional) Search for workloads by type and tags using an SQL-like syntax. See https://www.acronis.com/en-us/support/documentation/CyberProtectionService/index.html#operators-dynamic-groups.html

Type: String | | applicable_to_policy_id | string | | (Optional) Fetch all workloads that are applicable to the policies with the given IDs. The IDs are of type InternalID. Maximum 100 items. Mutually exclusive with applied_to_policy... filters.

Type: String | | applicable_to_policy_selection_id | null | | (Optional) Fetch all workloads that are applicable to the policies in the policy selection. Is of type InternalID. Mutually exclusive with applied_to_policy_... and is_applied_to_policy filters.

Type: String | | is_applied_to_policy | string | | (Optional) Fetch all workloads that have no applied policies (false); have applied policies (true); not specified (any). Mutually exclusive with applied_to_policy_... and applicable_to_policy_... filters.

Type: String Allowed values:

  • default
  • any
  • false
  • true

Default: any | | applied_to_policy_id | string | | (Optional) Fetch all workloads that are applied to the policies with the given IDs. The IDs are of type InternalID. Maximum 100 items. Mutually exclusive with applicable_to_policy_... and is_applied_to_policy filters.

Type: String | | applied_to_policy_selection_id | null | | (Optional) Fetch all workloads applied to the policies in the selection with the given id. Is of type InternalID. Mutually exclusive with applicable_to_policy_... and is_applied_to_policy filters.

Type: String | | is_deleted | boolean | | (Optional) Fetch all workloads that are deleted (true); are not deleted (false); not specified (any).

Type: String Allowed values:

  • default
  • any
  • false
  • true

Default: false | | updated_at | string | | (Optional) Type: String | | is_group | string | | (Optional) Fetch all workloads that are groups (true); are not groups (false); not specified (any).

Type: String Allowed values:

  • default
  • any
  • false
  • true

Default: any | | is_aggregate | string | | (Optional) Fetch all workloads that are aggregates (true); are not aggregates (false); not specified (any).

Type: String Allowed values:

  • default
  • any
  • false
  • true

Default: any | | is_aggregated_aspect | boolean | | (Optional) Fetch all workloads that are aggregated aspects (true); are not aggregated aspects (false); not specified (any). By default aggregated aspects are placed into aggregates (specified with include_aggregated_aspects).

Type: String Allowed values:

  • default
  • any
  • false
  • true

Default: false | | include_status | boolean | | (Optional) Includes workload statuses in the response.

Type: Boolean | | include_all_attributes | boolean | | (Optional) Includes all workload attributes in the response. Mutually exclusive with include_attributes.

Type: Boolean | | include_attributes | string | | (Optional) Includes specified workload attributes in the response. Empty array means no attributes to include. Mutually exclusive with include_all_attributes.

Type: Array of String Array type description: Type: String Max items: 25 | | include_allowed_actions | boolean | | (Optional) Includes workload allowed_actions in the response.

Type: Boolean | | include_aggregated_aspects | boolean | | (Optional) Returns aggregates with aggregated aspects in the response.

Type: Boolean Default: true |

RESPONSES

status: OK

{"paging":{"cursors":{"before":"","after":""}},"items":[{"is_auto_created":true,"enabled":true,"comment":"","agent_id":"d3DFe473-DbEB-03aB-8e7b-bBb3E8EdBcf2","external_id":"","created_at":"1970-01-01T00:00:00.000Z","name":"","auto_parent_child_relationship":true,"cross_policy_status":{"names":"","running":{"state":"RUNNING","activities":["backing_up"],"progress":0,"blockers":[{"domain":"","code":"","reason":"","context":{},"kbLink":{"lineTag":"","serCode":"","version":"","build":0,"product":"","os":""},"debug":{}}]},"status":"CRITICAL"},"updated_at":"1970-01-01T00:00:00.000Z","id":"7d1eB383-AdAe-Ee7B-dd8f-4cBD1aF4a1b0","aggregation_status":"NOT_AGGREGATED","user_defined_name":"","attributes":{},"per_policy_type_statuses":[{"type":"","last_run_time":"1970-01-01T00:00:00.000Z","next_run_time":"1970-01-01T00:00:00.000Z","last_success_run_time":"1970-01-01T00:00:00.000Z","next_enable_time":"1970-01-01T00:00:00.000Z","run_events":[""],"enable_events":[""]}],"client_id":"","effective_parent_ids":["6f3BfbC5-A579-432f-aBe9-1CAbd5d4D9FC"],"tag":"","aggregate_id":"e47Ca2B3-C1de-2dee-8c85-2CffD4d0734A","allowed_actions":["cti.a.p.xx.v1.0"],"explicit_parent_ids":["fEaC6c8E-7ACa-691a-6c91-cfee8A43AdBb"],"deleted_at":"1970-01-01T00:00:00.000Z","licensing_status":{"current_offering_item":"","previous_offering_item":""},"type":"","tenant_id":"0a3caD6e-A23d-0544-6dE0-F6fF9d8a3f8C","is_customer_managed":true}],"timestamp":"1970-01-01T00:00:00.000Z","dynamic_group_creation_forbidden":true}