OpenAPI

Test-OpenAPI

Synopsis

Test an Akamai endpoint.

Syntax

Test-OpenAPI [-Path] <String> [[-Method] <String>] [[-Body] <Object>] [[-Accept] <String>] [[-ContentType] <String>] [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

This function is a simple wrapper to Invoke-AkamaiRestMethod with fewer options. It provides a more simplified way of testing API endpoints.

Parameters

‑Accept

The Accept request header value.

‑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.

‑Body

The request body to include in the auth calculation.

‑ContentType

The Content-Type request header value.

‑EdgeRCFile

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.

‑Method

The request method.

‑Path
Required

Your request path.

‑Section

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

Related Links

User Guide: Overview