Endpoint version

Set-APIEndpointVersion

Synopsis

Edit a version.

Syntax

Set-APIEndpointVersion -APIEndpointName <String> -VersionNumber <String> -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Set-APIEndpointVersion -APIEndpointID <Int32> -VersionNumber <String> -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Updates details of an endpoint version that has never been activated on the staging or production network. When making a request, you can specify an API endpoint by its name or ID. The -VersionNumber parameter is an integer or the word latest.

Note: Due to the complexity of the request body, run the Get-APIEndpointVersion operation to retrieve the existing version, edit it locally, and pipe the object to this command.

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
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.

‑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