Guide

Category

Get-APICategory

Suggest Edits

Synopsis

Get one or all categories.

Syntax

Get-APICategory [-WithUsageInfo] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-APICategory -APICategoryID <Int32> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all API categories or an individual category by its category ID.

Parameters

‑APICategoryID
Conditionally required
Int Parameter sets: single Pipeline input: False

The API category's ID.
‑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.
‑EdgeRCFile
String Pipeline input: False

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

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑WithUsageInfo
Switch Parameter sets: all Pipeline input: False

Whether the response should include the usageCount data indicating the number of endpoints under a category.

Related Links

Updated 19 days ago