Guide
  1. Common
  2. Invoke

Netstorage request

Synopsis

Make a request to the Netstorage usage API.

Syntax

Invoke-NetstorageRequest [-Path] <String> [-Action] <String> [[-AdditionalOptions] <Hashtable>] [[-Body] <String>] [[-InputFile] <String>] [[-OutputFile] <String>] [[-Retry] <Int32>] [[-NSRCFile] <String>] [[-Section] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

This function is an upgrade of the older Invoke-NSAPIRequest, which interfaces between Netstorage sub-module functions and the Netstorage usage API. Credentials are loaded from environment variables or a provided .nsrc file and requests are signed. This function uses Invoke-RestMethod at its core.

Parameters

‑Action
Required
StringAccepted values: delete, dir, download, du, list, mkdir, mtime, quick-delete, rename, rmdir, stat, symlink, uploadPipeline input: False

The API endpoint's action type.

‑AdditionalOptions
HashtablePipeline input: False

A hashtable of additional options for a request.

‑Body
StringPipeline input: False

A request body, either as a PSCustomObject or a string.

‑InputFile
StringPipeline input: False

File to send with upload HTTP requests.

‑NSRCFile
StringPipeline input: False

NSRC file to update/create.

‑OutputFile
StringPipeline input: False

The file to write response data to.

‑Path
Required
StringPipeline input: False

Your request path.

‑Retry
IntPipeline input: False

The retry index. Used to determine whether a failed request should be retried.

‑Section
StringPipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.

Related Links

User Guide: Overview

Updated 5 days ago