Akamai request
Synopsis
Send an authorized HTTPS request to an Akamai RESTful web service.
Syntax
Invoke-AkamaiRequest [-Path] <String> [[-Method] <String>] [[-QueryParameters] <Hashtable>] [[-AdditionalHeaders] <Hashtable>] [[-Body] <Object>] [[-InputFile] <String>] [[-OutputFile] <String>] [[-MaxBody] <String>] [-SkipHttpErrorCheck] [-SkipHeaderValidation] [[-Retry] <Int32>] [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]Description
Constructs a call to Invoke-WebRequest from the given -Path, -Method, and other additional parameters and adds necessary authorization details retrieved from Get-AkamaiCredentials.
The response is formatted into a PSCustomObject including Status, a hashtable of headers, and a PSCustomObject of the response body.
Error handling is configured based on the current AkamaiOptions variable.
Parameters
‑AccountSwitchKey | 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. |
‑AdditionalHeaders | An additional headers in a hashtable. |
‑Body | A request body, either as a |
‑EdgeRCFile | Your EdgeGrid resource file to authenticate your command. Defaults to |
‑InputFile | File to send with upload HTTP requests. |
‑MaxBody | Maximum body size with which to calculate the EdgeGrid signature. Defaults to 128kb, and should not be changed unless your API client has a lower value. |
‑Method | Request method. |
‑OutputFile | The file to write response data to. |
‑PathRequired | Your request path. |
‑QueryParameters | The query parameters in a hashtable. |
‑Retry | The retry index. Used to determine whether a failed request should be retried. |
‑Section | The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to |
‑SkipHttpErrorCheck | When the switch parameter is present, this ignores HTTP error statuses and continues to process responses. The error responses are written to the pipeline just as if they were successful. > Note: This parameter is only applicable with PowerShell 7+. |
Related Links
Updated 16 days ago