Endpoint activation

New-APIEndpointActivation

Synopsis

Activate a version.

Syntax

New-APIEndpointActivation -APIEndpointName <String> -VersionNumber <String> -Notes <String> -Networks <String> -NotificationRecipients <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
New-APIEndpointActivation -APIEndpointName <String> -VersionNumber <String> -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
New-APIEndpointActivation -APIEndpointID <Int32> -VersionNumber <String> -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
New-APIEndpointActivation -APIEndpointID <Int32> -VersionNumber <String> -Notes <String> -Networks <String> -NotificationRecipients <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Activates an endpoint version on the staging or production network by name or ID and version number. If another version of the endpoint is already active on the specified network, it gets automatically deactivated and the newly activated version takes its place.

You can provide the activation settings individually or send them all at once as PSCustomObject with the -Body parameter. The -VersionNumber parameter is an integer or the word latest.

Parameters

‑APIEndpointID
Conditionally required

The endpoint's ID.

‑APIEndpointName
Conditionally 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.

‑Body
Conditionally required

A request body, either as a PSCustomObject or a string. This parameter supports pipelining.

‑EdgeRCFile

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.

‑Networks
Conditionally required

The network environment where you activate the endpoint version, either STAGING or PRODUCTION.

‑Notes
Conditionally required

The notes describing the version that you activate.

‑NotificationRecipients
Conditionally 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 default.

‑VersionNumber
Required

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

Related Links