Guide

Category

Set-APICategory

Suggest Edits

Synopsis

Edit a category.

Syntax

Set-APICategory [-APICategoryID] <Int32> [-APICategoryName] <String> [[-APICategoryDescription] <String>] [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Updates a category's description or unique name.

Parameters

‑APICategoryDescription
String Pipeline input: False

The description of the category that you may use to tag related endpoints. If you specify null or an empty string in the request, the JSON response doesn't include this field.
‑APICategoryID
Required
Int Pipeline input: False

The API category's ID.
‑APICategoryName
Required
String Pipeline input: False

A unique-per-account name of the category. Any empty value reflects back as an UNCATEGORIZED keyword.
‑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.

Related Links

Updated 3 days ago