Skip to main content

Calling REST APIs in PowerShell


PowerShell - REST API

Many times we would require pulling web-based information into PowerShell. There are two ways to do that in PowerShell. 
  • Invoke-WebRequest
  • Invoke-RestMethod
Invoke-WebRequest: This command can be used to get content from a web page. The cmdlet sends HTTP calls to a web page or a web server.

Using Basic Authentication:
$creds = [System.Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes('username:password'))
Invoke-WebRequest
-URI '<path>'
-Method 'POST'
-ContentType 'application/json; charset=utf-8'
-Headers @{'Accept' = 'application/json'; 'Sample-Header' = 'Test'}
-Authentication @{ 'Authorization' = 'Basic ' + $creds }

Using a Client Certificate:
Invoke-WebRequest
-URI '<path>'
-Method 'POST'
-ContentType 'application/json; charset=utf-8'
-Headers @{'Accept' = 'application/json'; 'Sample-Header' = 'Test'}
-CertificateThumbprint 934367bf1c97033f877db0f15cb1b586957d313

Using Windows authentication:
Invoke-WebRequest
-URI '<path>'
-Method 'POST'
-ContentType 'application/json; charset=utf-8'
-Headers @{'Accept' = 'application/json'; 'Sample-Header' = 'Test'}
-UseDefaultCredentials

Catching Exceptions: You can wrap the call around a try-catch block to catch any exceptions. 
try {
$result = Invoke-WebRequest -URI '<path>'
-Headers @{'Accept' = 'application/json'; 'Sample-Header' = 'Test'}
-Authentication @{ 'Authorization' = 'Basic ' + $creds }
-Method 'POST'
}
catch {
$result = $_.Exception
}

Invoke-RestMethod: This cmdlet has all the functionalities similar to Invoke-WebRequest method. 

$params = @{
uri = 'rest-api-url';
Method = 'GET';
Headers = @{ 'Authorization' = 'Basic ' + [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes("username:password"))}
}

$response = Invoke-RestMethod @params

Difference between Invoke-WebRequest and Invoke-RestMethod:
Invoke-RestMethod understands REST APIs better that IWR and it parses the JSON into meaningful PowerShell objects. Invoke-RestMethod is a superset of Invoke-WebRequest and it is often used for accessing REST API resources.


Labels:

Comments

Post a Comment

Popular posts from this blog

How to clear Visual Studio Cache

How to clear visual studio cache Many times, during development you would face situations where project references are not loaded properly or you get missing/error DLL's. This is because the Component cache gets corrupted randomly and without any warnings. The first option that needs to be done is to clear component cache and restart Visual Studio since the Cache might be holding onto previous DLL versions. Here are the steps on how to clear Visual Studio Cache, Clearing Component Cache: Close all Visual Studio Instances running in your machine. Also, make sure devenv.exe is not running in the Task Manager Delete the Component cache directory - %USERPROFILE%\AppData\Local\Microsoft\VisualStudio\1x.0\ComponentModelCache Restart Visual Studio The above steps should fix the cache issue most of the times, but some times that is not enough and you need to perform the below steps as well. Clearing User's Temp Folder: Open the temp folder in this locatio n -  %USERPROFILE%\AppData\Loc
221 comments
Read more

PCF Health Check Delay - Invocation timeout

In PCF we can set up the health check invocation timeout to execute X seconds after the instance has been created.  But before that, let's understand the PCF Health Check Lifecycle. Stage 1: The application is deployed to PCF Stage 2: When deploying the app, a health check type is specified and optionally a timeout. If a health check type is not specified, then the monitoring process defaults to a port health check Stage 3: Cloud Controller stages, starts, and runs the application Stage 4: Based on the type specified for the app, Cloud Controller configures a health check    that runs periodically for each app instance Stage 5: When Diego starts an app instance, the app health check runs every two seconds until a response indicates that the app instance is healthy or until the health check timeout elapses. The 2-seconds health check interval is not configurable Stage 6: When an app instance becomes healthy, its route is advertised, if applicable.                  Subsequent hea
1 comment
Read more

How to dependency inject to static class

.Net core supports dependency injection. There are many ways that you can inject services like constructor injection, action method injection, property injection. But there will be scenarios where you need to inject dependency services to static classes. For example, injecting services to extension methods. First, create a static class with a one property IServiceProvider type public void ConfigureServices(IServiceCollection services) { services.AddScoped<ILoggerEntry, LoggerEntry>(); services.AddTransient<IMongoRepository, MongoRepository>(); } Second, configure your services in ConfigureServices() method in Startup.cs and define the lifetime of the service instance using either Transient, Scoped or Singleton types. public void ConfigureServices(IServiceCollection services) { services.AddScoped<ILoggerEntry, LoggerEntry>(); services.AddTransient<IMongoRepository, MongoRepository>(); } For the next step to configure the Static class provider proper
Post a Comment
Read more