Synopsis
Create an endpoint or resource.
Syntax
new (Default)
New-AppSecDiscoveredAPIEndpoint -Hostname <String> -BasePath <String> -APIName <String> -ContractID <String>
-GroupID <Int32> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
existing
New-AppSecDiscoveredAPIEndpoint -Hostname <String> -BasePath <String> -APIEndpointID <Int32> -Version <Int32>
[-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
body
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
An ID for an API endpoint.
You need this when adding a resource to an existing endpoint.
Type: Int32
Parameter Sets: existing
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-APIName
The name for this API endpoint.
You need this to register an endpoint.
Type: String
Parameter Sets: new
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AccountSwitchKey
Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Account Switch Keys can be found using Get-AccountSwitchKey
.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-BasePath
The base64-encoded value of the base path.
Type: String
Parameter Sets: (All)
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Body
Request body, either as a PSCustomObject or string. This parameter supports pipelining.
Type: Object
Parameter Sets: body
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-ContractID
An ID for a contract.
Type: String
Parameter Sets: new
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EdgeRCFile
EdgeRC file to authenticate your command. Defaults to ~/.edgerc
.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-GroupID
An ID for a group.
Type: Int32
Parameter Sets: new
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Hostname
The base64-encoded value of the hostname.
Type: String
Parameter Sets: (All)
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Section
EdgeRC section to retrieve authentication credentials from. Defaults to default
.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Version
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.
Type: Int32
Parameter Sets: existing
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common Parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
System.Object
Outputs
System.Object