Invoke-RestMethod

Specifies the body of the request. The body is the content of the request that follows the headers. You can also pipe a body value to Invoke-RestMethod.

The Body parameter can be used to specify a list of query parameter or specify the content of the response. If the value of the Body parameter is a hash table or dictionary, it is interpreted to be a list of query parameters. If the value of the Body parameter is wrapped in a PSObject, it is interpreted to be part of the response content.

Specifies the client certificate that is used for a secure web request. Enter a variable that contains a certificate or a command or expression that gets the certificate.

To find a certificate, use Get-PfxCertificate or use the Get-ChildItem cmdlet in the Certificate (Cert:) drive. If the certificate is not valid or does not have sufficient authority, the command fails.

Specifies the digital public key certificate (X509) of a user account that has permission to send the request. Enter the certificate thumbprint of the certificate.

Certificates are used in client certificate-based authentication. They can be mapped only to local user accounts; they do not work with domain accounts.

To get a certificate thumbprint, use the Get-Item or Get-ChildItem command in the Windows PowerShell Cert: drive.

Specifies the content type of the web request, such as "application/x-www-form-urlencoded".

Specifies a user account that has permission to send the request. The default is the current user.

Type a user name, such as "User01" or "Domain01\User01", or enter a PSCredential object, such as one generated by the Get-Credential cmdlet.

Sets the KeepAlive value in the HTTP header to False. By default, KeepAlive is True. KeepAlive establishes a persistent connection to the server to facilitate subsequent requests.

Specifies the headers for the web request. Enter a hash table or dictionary.

Specifies the path to the file that contains the web request.

Enter a path and file name. If you omit the path, the default is the current location.

Determines how many times Windows PowerShell redirects a connection to an alternate Uniform Resource Identifier (URI) before the connection fails. The default value is 5. A value of 0 (zero) prevents all redirection.

Specifies the method used for the web request. Valid values are Default, Delete, Get, Head, Options, Post, Put, and Trace.

Sends the results to the specified output file. Enter a path and file name. If you omit the path, the default is the current location.

By default, Invoke-RestMethod returns the results to the pipeline. To send the results to a file and to the pipeline, use the Passthru parameter.

Returns the results, in addition to writing them to a file. This parameter is valid only when the OutFile parameter is also used in the command.

Uses a proxy server for the request, rather than connecting directly to the Internet resource. Enter the URI of a network proxy server.

Specifies a user account that has permission to use the proxy server that is specified by the Proxy parameter. The default is the current user.

Type a user name, such as "User01" or "Domain01\User01", or enter a PSCredential object, such as one generated by the Get-Credential cmdlet.

This parameter is valid only when the Proxy parameter is also used in the command. You cannot use the ProxyCredential and ProxyUseDefaultCredentials parameters in the same command.

Uses the credentials of the current user to access the proxy server that is specified by the Proxy parameter.

This parameter is valid only when the Proxy parameter is also used in the command. You cannot use the ProxyCredential and ProxyUseDefaultCredentials parameters in the same command.

Specifies a name for the session variable. Enter a variable name without the dollar sign ($) symbol.

When you use the session variable in a web request, the variable is populated with a WebRequestSession object.

You cannot use the SessionVariable and WebSession parameters in the same command.

Specifies how long the request can be pending before it times out. Enter a value in seconds. The default value, 0, specifies an indefinite time-out.

Specifies a value for the transfer-encoding HTTP response header. Valid values are Chunked, Compress, Deflate, GZip and Identity.

Specifies the Uniform Resource Identifier (URI) of the Internet resource to which the web request is sent.

This parameter is required. The parameter name (-Uri) is optional.

Uses the credentials of the current user to send the web request.

Specifies a user agent string for the web request.

Specifies a web request session to store data for subsequent requests.

You cannot use the SessionVariable and WebSession parameters in the same command.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see  about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216).

This command uses the Invoke-RestMethod cmdlet to get information from the Windows PowerShell Blog RSS feed. The command uses the Format-Table cmdlet to display the values of the Title and pubDate properties of each blog in a table.

PS C:\> Invoke-RestMethod -Uri http://blogs.msdn.com/powershell/rss.aspx | Format-Table -Property Title, pubDate

title                                                                 pubDate-----                                                                 -------Another Holiday Gift from the PowerShell Team: PowerShell 3.0 CTP2... Thu, 22 Dec 2011 00:46:00 GMTMore Videos from the First PowerShell Deep Dive                       Mon, 10 Oct 2011 19:59:00 GMTPowerShell Deep Dive Lineup                                           Thu, 06 Oct 2011 00:42:00 GMTWindows Management Framework 3.0 Community Technology Preview (CTP... Mon, 19 Sep 2011 23:56:26 GMTGet-Help -Online Fails in German                                      Tue, 23 Aug 2011 15:02:00 GMTPowerShell Deep Dive Registration Info & Call for Session Proposals   Wed, 20 Jul 2011 00:25:00 GMTInvoke-Expression considered harmful                                  Fri, 03 Jun 2011 15:43:00 GMTPowerShell at TechEd 2011                                             Thu, 28 Apr 2011 16:58:36 GMTPowerShell Language now licensed under the Community Promise          Sat, 16 Apr 2011 00:13:00 GMTScaling and Queuing PowerShell Background Jobs                        Mon, 04 Apr 2011 20:30:58 GMTMore Deep Dive Info, Including Abstracts from the PowerShell Team     Sun, 13 Mar 2011 01:35:42 GMTA Few Deep Dive Abstracts                                             Sat, 05 Mar 2011 00:26:00 GMTReminder: Register for the PowerShell Deep Dive Conference & submi... Wed, 23 Feb 2011 17:55:45 GMT