Guide

Endpoint version from file

Set-APIEndpointVersionFromFile

Suggest Edits

Synopsis

Edit an endpoint from an API definition file.

Syntax

Set-APIEndpointVersionFromFile -APIEndpointName <String> -VersionNumber <String> -ImportFileFormat <String> -ImportFileSource <String> [-ImportURL <String>] [-ImportFileContent <String>] [-Root <String>] -ContractID <String> -GroupID <Int32> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

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

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

Set-APIEndpointVersionFromFile -APIEndpointID <Int32> -VersionNumber <String> -ImportFileFormat <String> -ImportFileSource <String> [-ImportURL <String>] [-ImportFileContent <String>] [-Root <String>] -ContractID <String> -GroupID <Int32> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Imports an API definition file with the endpoint's details by its name or ID and version number. 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.
‑ContractID
Conditionally required
String Parameter sets: id-attributes, name-attributes Pipeline input: False

Filters endpoints to a specific contract. You need to specify this along with a -GroupID.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑GroupID
Conditionally required
Int Parameter sets: id-attributes, name-attributes Pipeline input: False

Filters endpoints to a specific group. You need to specify this along with a -ContractID.
‑ImportFileContent
String Parameter sets: id-attributes, name-attributes Pipeline input: False

The content of the API definition file encoded in Base64. Specify this only if you set the corresponding ImportFileSource to BODY_BASE64.
‑ImportFileFormat
Conditionally required
String Accepted values: swagger, raml Parameter sets: id-attributes, name-attributes Pipeline input: False

The format of the API definition file, either raml or swagger. You can import RAML 0.8 files and Swagger 2.0 or 3.0 files.
‑ImportFileSource
Conditionally required
String Accepted values: URL, BODY_BASE64 Parameter sets: id-attributes, name-attributes Pipeline input: False

The location of the API definition file, either URL if you store the file on the web, or BODY_BASE64 if you encode the file contents in the request body.
‑ImportURL
String Parameter sets: id-attributes, name-attributes Pipeline input: False

The URL from which to get the API definition file. Specify this only if you set the corresponding -ImportFileSource parameter to URL.
‑Root
String Parameter sets: id-attributes, name-attributes Pipeline input: False

If the import file located at the ImportURL is a ZIP archive, this identifies the API definition's filename within the archive.
‑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 6 hours ago