Returns a list of workers.


oci apm-synthetics worker-collection list-workers [OPTIONS]

Required Parameters

--apm-domain-id [text]

The APM domain ID the request is intended for.

--on-premise-vantage-point-id [text]

The OCID of the On-premise vantage point.

Optional Parameters


Fetches all pages of results. If you provide this option, then you cannot provide the --limit option.

--capability [text]

A filter to return only On-premise VP workers that match the capability given.

--display-name [text]

A filter to return only the resources that match the entire display name.

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link:

--limit [integer]

The maximum number of items to return.

--name [text]

A filter to return only the resources that match the entire name.

--page [text]

The maximum number of results per page, or items to return in a paginated “List” call. For information on how pagination works, see List Pagination.


--page-size [integer]

When fetching results, the number of results to fetch per call. Only valid when used with --all or --limit, and ignored otherwise.

--sort-by [text]

The field to sort by. Only one sort order may be provided. Default order of displayName is ascending. Default order of timeCreated, timeUpdated and timeLastSyncup is descending. The displayName sort by is case-sensitive.

Accepted values are:

displayName, name, priority, status, timeCreated, timeLastSyncup, timeUpdated
--sort-order [text]

The sort order to use, either ascending (ASC) or descending (DESC). Default sort order is ascending.

Accepted values are:

--status [text]

A filter to return only On-premise VP workers that match the status given.

Accepted values are:


Example using required parameter

Copy the following CLI commands into a file named Run the command by typing “bash” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export apm_domain_id=<substitute-value-of-apm_domain_id> #
    export name=<substitute-value-of-name> #

    on_premise_vantage_point_id=$(oci apm-synthetics on-premise-vantage-point create --apm-domain-id $apm_domain_id --name $name --query --raw-output)

    oci apm-synthetics worker-collection list-workers --apm-domain-id $apm_domain_id --on-premise-vantage-point-id $on_premise_vantage_point_id