Guide

OpenAPI

Test-OpenAPI

Suggest Edits

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
String Pipeline input: False

The Accept request header value.
‑AccountSwitchKey
String Pipeline input: False

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
Object Pipeline input: False

The request body to include in the auth calculation.
‑ContentType
String Pipeline input: False

The Content-Type request header value.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑Method
String Pipeline input: False

The request method.
‑Path
Required
String Pipeline input: False

Your request path.
‑Section
String Pipeline input: False

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

Related Links

User Guide: Overview

Updated 15 days ago