REST API calls with Invoke-RestMethod in PowerShell - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the <code>Invoke-RestMethod</code> cmdlet in PowerShell?

It is used to send HTTP and HTTPS requests to REST APIs and receive responses, making it easy to interact with web services.

beginner

How do you specify the HTTP method (GET, POST, etc.) when using Invoke-RestMethod?

Use the -Method parameter with values like 'GET', 'POST', 'PUT', or 'DELETE' to specify the HTTP method.

intermediate

How can you send JSON data in a POST request using Invoke-RestMethod?

Convert your data to JSON using ConvertTo-Json and pass it with the -Body parameter. Also, set the -ContentType to 'application/json'.

beginner

What does Invoke-RestMethod return when calling a REST API?

It returns the response content parsed into PowerShell objects, such as hashtables or arrays, making it easy to work with the data.

intermediate

How do you add headers like API keys to your REST API call with Invoke-RestMethod?

Use the -Headers parameter with a hashtable containing header names and values, for example: @{'Authorization'='Bearer token'}.

Which parameter do you use to specify the HTTP method in Invoke-RestMethod?

A -Uri

B -Method

C -Body

D -Headers

The -Method parameter sets the HTTP method like GET or POST.

How do you send JSON data in a POST request using Invoke-RestMethod?

A Use <code>-Body</code> with a JSON string and set <code>-ContentType</code> to 'application/json'

B Use <code>-Headers</code> only

C Use <code>-Uri</code> with JSON data

D Use <code>-Method</code> with 'JSON'

You must pass JSON data as a string in -Body and specify the content type.

What does Invoke-RestMethod return after a successful API call?

A Parsed PowerShell objects

B Nothing

C Raw text only

D Only HTTP status code

It parses the response content into PowerShell objects for easy use.

How do you add an API key in the headers for a REST call?

A Use <code>-Method</code> with the API key

B Use <code>-Body</code> with the API key

C Use <code>-Headers</code> with a hashtable containing the API key

D Use <code>-Uri</code> with the API key

Headers are added using the -Headers parameter as a hashtable.

Which HTTP method is the default for Invoke-RestMethod if not specified?

A POST

B PUT

C DELETE

D GET

The default HTTP method is GET if you don't specify one.

Explain how to perform a POST request with JSON data using Invoke-RestMethod in PowerShell.

Think about how to tell the API you are sending data and how to format it.

Describe how to include custom headers, such as an API key, in a REST API call using Invoke-RestMethod.

Headers are like extra information you send with your request.