Guide

Endpoint deactivation

New-APIEndpointDeactivation

Suggest Edits

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

‑APIEndpointID
Conditionally required
Int Parameter sets: id-body, id-attributes Pipeline input: False

The endpoint's ID.
‑APIEndpointName
Conditionally required
String Parameter sets: name-body, name-attributes 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.
‑Body
Conditionally required
Object Parameter sets: id-body, name-body Pipeline input: ByValue

A request body, either as a PSCustomObject or a string. This parameter supports pipelining.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑Networks
Conditionally required
String Accepted values: Production, Staging, Both Parameter sets: id-attributes, name-attributes Pipeline input: False

The network environment where you activate the endpoint version, either STAGING or PRODUCTION.
‑Notes
Conditionally required
String Parameter sets: id-attributes, name-attributes Pipeline input: False

The notes describing the version that you activate.
‑NotificationRecipients
Conditionally required
String Parameter sets: id-attributes, name-attributes Pipeline input: False

The email addresses where the system sends the activation notification.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑VersionNumber
Required
String Pipeline input: False

The endpoint version's number. Can be an integer or 'latest'.

Related Links

Updated about 1 month ago