HttpClient.PostAsync Method

Reference

Definition

Namespace:: System.Net.Http

Assembly:: System.Net.Http.dll

Assembly:: netstandard.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Send a POST request to the specified Uri as an asynchronous operation.

Overloads

PostAsync(String, HttpContent, CancellationToken)	Send a POST request with a cancellation token as an asynchronous operation.
PostAsync(Uri, HttpContent, CancellationToken)	Send a POST request with a cancellation token as an asynchronous operation.
PostAsync(String, HttpContent)	Send a POST request to the specified Uri as an asynchronous operation.
PostAsync(Uri, HttpContent)	Send a POST request to the specified Uri as an asynchronous operation.

Remarks

This operation will not block.

PostAsync(String, HttpContent, CancellationToken)

Source:: HttpClient.cs

Source:: HttpClient.cs

Source:: HttpClient.cs

Send a POST request with a cancellation token as an asynchronous operation.

public:
 System::Threading::Tasks::Task<System::Net::Http::HttpResponseMessage ^> ^ PostAsync(System::String ^ requestUri, System::Net::Http::HttpContent ^ content, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> PostAsync (string requestUri, System.Net.Http.HttpContent content, System.Threading.CancellationToken cancellationToken);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> PostAsync (string? requestUri, System.Net.Http.HttpContent content, System.Threading.CancellationToken cancellationToken);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> PostAsync (string? requestUri, System.Net.Http.HttpContent? content, System.Threading.CancellationToken cancellationToken);

member this.PostAsync : string * System.Net.Http.HttpContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>

Public Function PostAsync (requestUri As String, content As HttpContent, cancellationToken As CancellationToken) As Task(Of HttpResponseMessage)

Parameters

requestUri: String

The Uri the request is sent to.

content: HttpContent

The HTTP request content sent to the server.

cancellationToken: CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<HttpResponseMessage>

The task object representing the asynchronous operation.

Exceptions

InvalidOperationException

The requestUri must be an absolute URI or BaseAddress must be set.

HttpRequestException

The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation or timeout.

TaskCanceledException

.NET Core and .NET 5 and later only: The request failed due to timeout.

UriFormatException

The provided request URI is not valid relative or absolute URI.

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

Remarks

This operation will not block. The returned Task<TResult> object will complete after the whole response (including content) is read.

Note

In case of timeout, different exceptions are thrown on different .NET implementations.

HttpRequestException is thrown on all applicable .NET Framework versions.
TaskCanceledException without any inner exception is thrown on all applicable .NET Core versions.
TaskCanceledException that nests a TimeoutException is thrown on .NET 5 and later versions.

Applies to

PostAsync(Uri, HttpContent, CancellationToken)

Source:: HttpClient.cs

Source:: HttpClient.cs

Source:: HttpClient.cs

Send a POST request with a cancellation token as an asynchronous operation.

public:
 System::Threading::Tasks::Task<System::Net::Http::HttpResponseMessage ^> ^ PostAsync(Uri ^ requestUri, System::Net::Http::HttpContent ^ content, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> PostAsync (Uri requestUri, System.Net.Http.HttpContent content, System.Threading.CancellationToken cancellationToken);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> PostAsync (Uri? requestUri, System.Net.Http.HttpContent content, System.Threading.CancellationToken cancellationToken);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> PostAsync (Uri? requestUri, System.Net.Http.HttpContent? content, System.Threading.CancellationToken cancellationToken);

member this.PostAsync : Uri * System.Net.Http.HttpContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>

Public Function PostAsync (requestUri As Uri, content As HttpContent, cancellationToken As CancellationToken) As Task(Of HttpResponseMessage)

Parameters

requestUri: Uri

The Uri the request is sent to.

content: HttpContent

The HTTP request content sent to the server.

cancellationToken: CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<HttpResponseMessage>

The task object representing the asynchronous operation.

Exceptions

InvalidOperationException

The requestUri must be an absolute URI or BaseAddress must be set.

HttpRequestException

The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation or timeout.

TaskCanceledException

.NET Core and .NET 5 and later only: The request failed due to timeout.

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

Remarks

This operation will not block. The returned Task<TResult> object will complete after the whole response (including content) is read.

Note

In case of timeout, different exceptions are thrown on different .NET implementations.

HttpRequestException is thrown on all applicable .NET Framework versions.
TaskCanceledException without any inner exception is thrown on all applicable .NET Core versions.
TaskCanceledException that nests a TimeoutException is thrown on .NET 5 and later versions.

Applies to

PostAsync(String, HttpContent)

Source:: HttpClient.cs

Source:: HttpClient.cs

Source:: HttpClient.cs

Send a POST request to the specified Uri as an asynchronous operation.

public:
 System::Threading::Tasks::Task<System::Net::Http::HttpResponseMessage ^> ^ PostAsync(System::String ^ requestUri, System::Net::Http::HttpContent ^ content);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> PostAsync (string requestUri, System.Net.Http.HttpContent content);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> PostAsync (string? requestUri, System.Net.Http.HttpContent content);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> PostAsync (string? requestUri, System.Net.Http.HttpContent? content);

member this.PostAsync : string * System.Net.Http.HttpContent -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>

Public Function PostAsync (requestUri As String, content As HttpContent) As Task(Of HttpResponseMessage)

Parameters

requestUri: String

The Uri the request is sent to.

content: HttpContent

The HTTP request content sent to the server.

Returns

Task<HttpResponseMessage>

The task object representing the asynchronous operation.

Exceptions

InvalidOperationException

The requestUri must be an absolute URI or BaseAddress must be set.

HttpRequestException

The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation or timeout.

TaskCanceledException

.NET Core and .NET 5 and later only: The request failed due to timeout.

UriFormatException

The provided request URI is not valid relative or absolute URI.

Remarks

This operation will not block. The returned Task<TResult> object will complete after the whole response (including content) is read.

Note

In case of timeout, different exceptions are thrown on different .NET implementations.

HttpRequestException is thrown on all applicable .NET Framework versions.
TaskCanceledException without any inner exception is thrown on all applicable .NET Core versions.
TaskCanceledException that nests a TimeoutException is thrown on .NET 5 and later versions.

Applies to

PostAsync(Uri, HttpContent)

Source:: HttpClient.cs

Source:: HttpClient.cs

Source:: HttpClient.cs

Send a POST request to the specified Uri as an asynchronous operation.

public:
 System::Threading::Tasks::Task<System::Net::Http::HttpResponseMessage ^> ^ PostAsync(Uri ^ requestUri, System::Net::Http::HttpContent ^ content);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> PostAsync (Uri requestUri, System.Net.Http.HttpContent content);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> PostAsync (Uri? requestUri, System.Net.Http.HttpContent content);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> PostAsync (Uri? requestUri, System.Net.Http.HttpContent? content);

member this.PostAsync : Uri * System.Net.Http.HttpContent -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>

Public Function PostAsync (requestUri As Uri, content As HttpContent) As Task(Of HttpResponseMessage)

Parameters

requestUri: Uri

The Uri the request is sent to.

content: HttpContent

The HTTP request content sent to the server.

Returns

Task<HttpResponseMessage>

The task object representing the asynchronous operation.

Exceptions

InvalidOperationException

The requestUri must be an absolute URI or BaseAddress must be set.

HttpRequestException

The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation or timeout.

TaskCanceledException

.NET Core and .NET 5 and later only: The request failed due to timeout.

Remarks

This operation will not block. The returned Task<TResult> object will complete after the whole response (including content) is read.

Note

In case of timeout, different exceptions are thrown on different .NET implementations.

HttpRequestException is thrown on all applicable .NET Framework versions.
TaskCanceledException without any inner exception is thrown on all applicable .NET Core versions.
TaskCanceledException that nests a TimeoutException is thrown on .NET 5 and later versions.

Applies to

Share via

HttpClient.PostAsync Method

Definition

Overloads

Remarks

PostAsync(String, HttpContent, CancellationToken)

Parameters

Returns

Exceptions

Remarks

Applies to

PostAsync(Uri, HttpContent, CancellationToken)

Parameters

Returns

Exceptions

Remarks

Applies to

PostAsync(String, HttpContent)

Parameters

Returns

Exceptions

Remarks

Applies to

PostAsync(Uri, HttpContent)

Parameters

Returns

Exceptions

Remarks

Applies to

Additional resources