REST API calls with Invoke-RestMethod in PowerShell - Step-by-Step Execution

Concept Flow - REST API calls with Invoke-RestMethod

Start Script

↓

Prepare API URL

↓

Call Invoke-RestMethod

↓

Receive Response

↓

Process/Display Data

↓

End Script

This flow shows how a PowerShell script prepares a URL, calls Invoke-RestMethod to get data from a REST API, then processes and shows the response.

Execution Sample

PowerShell

$url = 'https://api.agify.io?name=michael'
$response = Invoke-RestMethod -Uri $url
$response | Format-List

This script calls a public API to guess the age for the name 'michael' and shows the response details.

Execution Table

Step	Action	Variable/Command	Result/Output
1	Set API URL	$url = 'https://api.agify.io?name=michael'	Variable $url holds the API endpoint string
2	Call REST API	$response = Invoke-RestMethod -Uri $url	Stores JSON response as PowerShell object in $response
3	Display response	$response | Format-List	Shows properties: name, age, count with values
4	End	Script finishes	No further actions

💡 Script ends after displaying the API response

Variable Tracker

Variable	Start	After Step 1	After Step 2	Final
$url	null	'https://api.agify.io?name=michael'	'https://api.agify.io?name=michael'	'https://api.agify.io?name=michael'
$response	null	null	{name: 'michael', age: 69, count: 12345}	{name: 'michael', age: 69, count: 12345}

Key Moments - 3 Insights

Why do we assign the API URL to a variable before calling Invoke-RestMethod?

Assigning the URL to $url makes the script easier to read and change. The execution_table row 1 shows $url holding the API endpoint before the call.

What type of data does Invoke-RestMethod return and how is it stored?

Invoke-RestMethod converts JSON response into a PowerShell object stored in $response, as shown in execution_table row 2.

Why do we use Format-List when displaying $response?

Format-List shows all properties clearly in a list format, making it easier to read the API response, as in execution_table row 3.

Visual Quiz - 3 Questions

Look at the execution_table, what is the value of $url after step 1?

A 'https://api.agify.io?name=michael'

B null

C 'https://api.agify.io?name=john'

D An empty string

💡 Hint

Check the 'Variable/Command' and 'Result/Output' columns for step 1 in execution_table

At which step does $response get its value?

A Step 1

B Step 2

C Step 3

D Step 4

💡 Hint

Look at the 'Action' and 'Variable/Command' columns in execution_table to see when $response is assigned

If we changed the URL to a different name, how would $response change?

A It would stay the same

B It would be empty

C It would contain data for the new name

D It would cause an error

💡 Hint

Refer to variable_tracker showing $response content depends on the API URL value

Concept Snapshot

Invoke-RestMethod calls a REST API and returns data as a PowerShell object.
Assign the API URL to a variable for clarity.
Store the response in a variable to use later.
Use Format-List or other commands to display the data.
This method works for GET requests easily.

Full Transcript

This example shows how to use PowerShell's Invoke-RestMethod to call a REST API. First, the API URL is saved in the variable $url. Then Invoke-RestMethod calls the API and stores the JSON response as a PowerShell object in $response. Finally, Format-List displays the response properties clearly. This process helps you get and use data from web APIs simply in scripts.