Guide

Endpoint

New-APIEndpoint

Suggest Edits

Synopsis

Register an endpoint.

Syntax

New-APIEndpoint [-Body] <Object> [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Creates the first version of an API endpoint configuration. With this operation, you can specify the new endpoint's full set of resources.

Alternatively, you can create them later either by modifying the endpoint object or separately by running the New-APIEndpointVersionResource operation. The endpoint's name needs to be unique within an account.

Parameters

‑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
Required
Object 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.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.

Related Links

Updated 8 days ago