Endpoint deactivation
New-APIEndpointDeactivation
Synopsis
Deactivate a version.
Syntax
New-APIEndpointDeactivation -APIEndpointName <String> -VersionNumber <String> -Notes <String> -Networks <String> -NotificationRecipients <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
New-APIEndpointDeactivation -APIEndpointName <String> -VersionNumber <String> -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
New-APIEndpointDeactivation -APIEndpointID <Int32> -VersionNumber <String> -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
New-APIEndpointDeactivation -APIEndpointID <Int32> -VersionNumber <String> -Notes <String> -Networks <String> -NotificationRecipients <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Description
Deactivates an endpoint version from the staging or production network. You can provide the deactivation settings individually or you can send them all at once as PSCustomObject within the -Body parameter.
In the request body, you can specify an API endpoint by its name or ID. The -VersionNumber parameter is an integer or the word latest.
Parameters
‑APIEndpointIDConditionally required |
The endpoint's ID. |
‑APIEndpointNameConditionally required |
The endpoint's name. |
‑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. |
‑BodyConditionally required |
A request body, either as a |
‑EdgeRCFile |
Your EdgeGrid resource file to authenticate your command. Defaults to |
‑NetworksConditionally required |
The network environment where you activate the endpoint version, either |
‑NotesConditionally required |
The notes describing the version that you activate. |
‑NotificationRecipientsConditionally required |
The email addresses where the system sends the activation notification. |
‑Section |
The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to |
‑VersionNumberRequired |
The endpoint version's number. Can be an integer or 'latest'. |
Related Links
Updated 4 months ago