New Stax Workload Query Filters

Published 20 Nov 2020


Stax has made changes to the Stax Workloads API to make it easier to find Workloads you have deployed into your Stax-managed AWS accounts. These filters are available in the API and the SDK.

The new filters available are:

Filter NameDescription
account_namesComma-delimited list of Stax Account Names. Returns all Workloads deployed to these Accounts Names.
account_typesComma-delimited list of Stax Account Types. Returns all Workloads deployed to these Account Types.
account_idsComma-delimited list of Stax Account IDs. Returns all Workloads deployed to these Account IDs.
catalogue_namesComma-delimited list of Stax Workload Catalogue Names. Returns all Workloads deployed with these Workload Catalogue Names.
catalogue_idsComma-delimited list of Stax Workload Catalogue IDs. Returns all Workloads deployed with these Catalogue IDs.
catalogue_versionOnly return Workloads launched from this Stax Workload Catalogue Version (eg. 1.0.0). Requires catalogue_ids to also be provided.

Examples

Example 1: Return all Stax Workloads deployed to accounts of type 'billing'

GET https://api.au1.staxapp.cloud/20190206/workloads?account_types=billing

Example 2: Return all Stax Workloads with a specific Catalog ID and Version

GET https://api.au1.staxapp.cloud/20190206/workloads?catalogue_ids=b5e1c1a5-ee96-4ea3-8343-8704f5f67596&catalogue_version=2.0.1

See also


Back to changelog