Endpoint (hide)
Hide-APIEndpoint
Synopsis
Hide an endpoint.
Syntax
name (Default)
Hide-APIEndpoint -APIEndpointName <String> [-EdgeRCFile <String>] [-Section <String>]
[-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
id
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
The ID for the endpoint.
Type: Int32
Parameter Sets: id
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-APIEndpointName
The name of the endpoint.
Type: String
Parameter Sets: name
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AccountSwitchKey
Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Run Get-AccountSwitchKey
to list the account switch keys available to you.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EdgeRCFile
EdgeRC file to authenticate your command. Defaults to ~/.edgerc
.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Section
EdgeRC section to retrieve authentication credentials from. Defaults to default
.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug
, -ErrorAction
, -ErrorVariable
, -InformationAction
, -InformationVariable
, -OutVariable
, -OutBuffer
, -PipelineVariable
, -Verbose
, -WarningAction
, and -WarningVariable
. For more information, see about_CommonParameters.
Inputs
None
Outputs
System.Object
Related links
Updated 7 days ago