Guide

Discovered API endpoint

New-AppSecDiscoveredAPIEndpoint

Suggest Edits

Synopsis

Create an endpoint or resource.

Syntax

New-AppSecDiscoveredAPIEndpoint -Hostname <String> -BasePath <String> -APIName <String> -ContractID <String> -GroupID <Int32> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

New-AppSecDiscoveredAPIEndpoint -Hostname <String> -BasePath <String> -APIEndpointID <Int32> -Version <Int32> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

New-AppSecDiscoveredAPIEndpoint -Hostname <String> -BasePath <String> -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Creates a new API endpoint or adds a resource to an existing endpoint. When you run this operation to add a new resource to an existing API, the API version is cloned for you, and the resource is included in the new version.

Parameters

‑APIEndpointID
Conditionally required
Int Parameter sets: existing Pipeline input: False

An API endpoint's ID. You need this when adding a resource to an existing endpoint.
‑APIName
Conditionally required
String Parameter sets: new Pipeline input: False

The API endpoint's name. You need this to register an endpoint.
‑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.
‑BasePath
Required
String Pipeline input: False

The base64-encoded value of the base path.
‑Body
Conditionally required
Object Parameter sets: body Pipeline input: ByValue

The request body, either as a PSCustomObject or a string. This parameter supports pipelining.
‑ContractID
Conditionally required
String Parameter sets: new Pipeline input: False

Your contract's ID.
‑EdgeRCFile
String Pipeline input: False

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

Your group's ID.
‑Hostname
Required
String Pipeline input: False

The base64-encoded value of the hostname.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑Version
Conditionally required
Int Parameter sets: existing Pipeline input: False

The version number. You need this when adding a resource to an existing endpoint. When a version is read-only, the version is cloned and updates are included in the newly cloned version.

Related Links

Updated 8 days ago