Akamai NSAPI request

Invoke-AkamaiNSAPIRequest

Synopsis

NetStorage authorization wrapper.

Syntax

Invoke-AkamaiNSAPIRequest [-Path] <String> [-Action] <String> [[-AdditionalOptions] <Hashtable>] [[-Body] <String>] [[-InputFile] <String>] [[-OutputFile] <String>] [[-AuthFile] <String>] [[-Section] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

The Invoke-AkamaiNSAPIRequest cmdlet provides an authorization wrapper around Invoke-RestMethod for use with the NetStorage API.

Example

Call a NetStorage API.

Invoke-AkamaiNSAPIRequest -Path $Path -Action "download" -OutputFile ./"localfile.txt"

Parameters

-Path

The API endpoint's request path.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Action

The API endpoint's action type.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AdditionalOptions

A hashtable of additional options for a request.

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Body

The data sent to the endpoint.

Value is a hashtable that includes values for each parameter.

Important: Because Body is a free field, our PowerShell module doesn't validate the data you include, the API does.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-InputFile

If needed by an endpoint, an input file's location.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OutputFile

If provided by an endpoint, where to place an output file.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AuthFile

The path to an authentication file.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Section

The authentication file's section name.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False