API operation

Synopsis

Query operations.

Syntax

Find-APIOperation -QueryType <String> [-APIEndPointHosts <String[]>] [-ResourcePaths <String[]>] [-ActiveStartTime <String>] [-ActiveEndTime <String>] [-IncludeDetails] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Find-APIOperation -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Get a filtered list of operations and their endpoints and resources. You can filter by date ranges, activation statuses, API Endpoint hostnames, and resource paths. For a simpler search, run Get-APIOperations.

Parameters

‑APIEndPointHosts

Specify a list of API endpoint hostnames to filter on. Users access the Akamai-deployed API using these hostnames.

‑AccountSwitchKey

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

The ISO 8601 timestamp for the end of the date range.

‑ActiveStartTime

The ISO 8601 timestamp for the start of the date range.

‑Body
Conditionally required

A request body, either as a PSCustomObject or a string. This parameter supports pipelining.

‑EdgeRCFile

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.

‑IncludeDetails

Includes all the resource and operation details.

‑QueryType
Conditionally required

The type of query. Options: ACTIVE_IN_PRODUCTION, ACTIVE_IN_STAGING, or ACTIVE_WITHIN_DATE_RANGE.

‑ResourcePaths

Specify the URL paths relative to the hostnames on which the resource resides. The path is the hostname, followed by the base path. When entering a resource path, you can use curly brackets () to define path parameters (for example, /path/{pathParam}). If you decide to do so, ensure that the value of the apiParameterName field in the corresponding parameter definition matches the name that you specified in the resource path.

‑Section

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

‑ProgressAction
Alias: ‑proga

Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.

The -ProgressAction parameter takes one of the -ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.

Related Links