Syntax
Invoke-AkamaiRestMethod [[-Method] <String>] [-Path] <String> [[-Body] <Object>] [[-InputFile] <String>]
[[-OutputFile] <String>] [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>]
[[-AdditionalHeaders] <Hashtable>] [[-MaxBody] <String>] [[-ResponseHeadersVariable] <String>]
[<CommonParameters>]
Parameters
-Method
Request method.
Valid values are GET, POST, PUT, and DELETE
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: GET
Accept pipeline input: False
Accept wildcard characters: False
-Path
Request path without hostname or scheme, but including any request parameters
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Body
Should contain the POST/PUT Body.
The body should be structured like a JSON object.
Example: $Body = '{ "name": "botlist2", "type": "IP", "list": ["201.22.44.12", "8.7.6.0/24"] }'
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-InputFile
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OutputFile
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EdgeRCFile
File-based Auth - Authorization file to read credentials from.
Defaults to ~/.edgerc
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Section
File-based Auth - Section in EdgeRC file to read credentials from.
Defaults to [default]
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AccountSwitchKey
Switch key to be used by Akamai Partners or internal users in order to apply a command to another account
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AdditionalHeaders
Hashtable of additional request headers to add
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MaxBody
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: 131072
Accept pipeline input: False
Accept wildcard characters: False
-ResponseHeadersVariable
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
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.