@tauri-apps/plugin-http

Make HTTP requests with the Rust backend.

Security

This API has a scope configuration that forces you to restrict the URLs that can be accessed using glob patterns.

For instance, this scope configuration only allows making HTTP requests to all subdomains for tauri.app except for https://private.tauri.app:

{
  "permissions": [
    {
      "identifier": "http:default",
      "allow": [{ "url": "https://*.tauri.app" }],
      "deny": [{ "url": "https://private.tauri.app" }]
    }
  ]
}

Trying to execute any API with a URL not configured on the scope results in a promise rejection due to denied access.

Interfaces

ClientOptions

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L75

Options to configure the Rust client used to make fetch requests

Since

2.0.0

Properties

Property	Type	Description	Defined in
connectTimeout?	number	Timeout in milliseconds	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L86
danger?	DangerousSettings	Configuration for dangerous settings on the client such as disabling SSL verification.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L94
maxRedirections?	number	Defines the maximum number of redirects the client should follow. If set to 0, no redirects will be followed. When the scopeRedirects plugin configuration is enabled, every redirect must also be allowed by the configured scope, otherwise the request fails instead of being followed.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L84
proxy?	Proxy	Configuration of a proxy that a Client should pass requests to.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L90

---

DangerousSettings

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L102

Configuration for dangerous settings on the client such as disabling SSL verification.

Since

2.3.0

Properties

Property	Type	Description	Defined in
acceptInvalidCerts?	boolean	Disables SSL verification.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L106
acceptInvalidHostnames?	boolean	Disables hostname verification.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L110

---

Proxy

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L36

Configuration of a proxy that a Client should pass requests to.

Since

2.0.0

Properties

Property	Type	Description	Defined in
all?	string | ProxyConfig	Proxy all traffic to the passed URL.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L40
http?	string | ProxyConfig	Proxy all HTTP traffic to the passed URL.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L44
https?	string | ProxyConfig	Proxy all HTTPS traffic to the passed URL.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L48

---

ProxyConfig

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L51

Properties

Property	Type	Description	Defined in
basicAuth?	object	Set the Proxy-Authorization header using Basic auth.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L59
basicAuth.password	string	-	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L61
basicAuth.username	string	-	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L60
noProxy?	string	A configuration for filtering out requests that shouldn’t be proxied. Entries are expected to be comma-separated (whitespace between entries is ignored)	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L67
url	string	The URL of the proxy server.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L55

Functions

fetch()

function fetch(input, init?): Promise<Response>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L129

Fetch a resource from the network. It returns a Promise that resolves to the Response to that Request, whether it is successful or not.

Parameters

Parameter	Type
input	| string | URL | Request
init?	RequestInit & ClientOptions

Returns

Promise<Response>

Example

const response = await fetch("http://my.json.host/data.json");
console.log(response.status);  // e.g. 200
console.log(response.statusText); // e.g. "OK"
const jsonData = await response.json();

Since

2.0.0