Guide

Endpoint (hide)

Hide-APIEndpoint

Suggest Edits

Synopsis

Hide an endpoint.

Syntax

Hide-APIEndpoint -APIEndpointName <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Hide-APIEndpoint -APIEndpointID <Int32> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Hides an endpoint and all its versions. You can hide an endpoint only with no active versions on the staging or production network. You can't activate or delete versions of a hidden endpoint. Running this operation affects the endpoint listing in the API Definitions user interface. When making a request, you can specify an API endpoint by its name or ID.

By default, you can find a hidden endpoint after running the Get-APIEndpoints operation or when you filter the operation's results by ONLY_HIDDEN using the -Show query parameter.

Parameters

‑APIEndpointID
Conditionally required
Int Parameter sets: id Pipeline input: False

The endpoint's ID.
‑APIEndpointName
Conditionally required
String Parameter sets: name Pipeline input: False

The endpoint's name.
‑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 2 days ago