Guide

Operations

Get-APIOperations

Suggest Edits

Synopsis

Search operations.

Syntax

Get-APIOperations [[-QueryType] <String>] [[-ActiveStartTime] <String>] [[-ActiveEndTime] <String>] [-IncludeDetails] [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets a filtered list of operations with their endpoints and resources. Use the -QueryType parameter to filter by the date range or activation status. Note that if -QueryType is set to ACTIVE_WITHIN_DATE_RANGE, you also need to specify the values for the ActiveStartTime and ActiveEndTime parameters.

Parameters

‑AccountSwitchKey
String Pipeline input: False

An account credential key that lets you move between accounts when using an API client enabled for multiple accounts. To find account switch keys, use Get-AccountSwitchKey.
‑ActiveEndTime
String Pipeline input: False

The ISO 8601 timestamp for the end of the date range.
‑ActiveStartTime
String Pipeline input: False

The ISO 8601 timestamp for the start of the date range.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑IncludeDetails
Switch Pipeline input: False

Includes all the resource and operation details.
‑QueryType
String Accepted values: ACTIVE_IN_PRODUCTION, ACTIVE_IN_STAGING, ACTIVE_WITHIN_DATE_RANGE Pipeline input: False

The type of query. Options: ACTIVE, ACTIVE, or ACTIVE.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.

Related Links

Updated about 1 month ago