Sends HTTP(S) DELETE request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.
Target URL.
Optional options: { Optional
Optional data?: anyAllows to set post data of the request. If the data parameter is an object, it will be serialized to json string
and content-type header will be set to application/json if not explicitly set. Otherwise the content-type
header will be set to application/octet-stream if not explicitly set.
Optional failWhether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status codes.
Optional form?: { Provides an object that will be serialized as html form using application/x-www-form-urlencoded encoding and sent
as this request body. If this parameter is specified content-type header will be set to
application/x-www-form-urlencoded unless explicitly provided.
Optional headers?: { Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by it.
Optional ignoreHTTPSErrors?: booleanWhether to ignore HTTPS errors when sending network requests. Defaults to false.
Optional maxMaximum number of request redirects that will be followed automatically. An error will be thrown if the number is
exceeded. Defaults to 20. Pass 0 to not follow redirects.
Optional multipart?: { Provides an object that will be serialized as html form using multipart/form-data encoding and sent as this
request body. If this parameter is specified content-type header will be set to multipart/form-data unless
explicitly provided. File values can be passed either as
fs.ReadStream or as file-like object containing file
name, mime-type and its content.
Optional params?: { Query parameters to be sent with the URL.
Optional timeout?: numberRequest timeout in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.
All responses returned by apiRequestContext.get(url[, options]) and similar methods are stored in the memory, so that you can later call apiResponse.body().This method discards all its resources, calling any method on disposed APIRequestContext will throw an exception.
Sends HTTP(S) request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects. JSON objects can be passed directly to the request.
Usage
await request.fetch('https://example.com/api/createBook', {
method: 'post',
data: {
title: 'Book Title',
author: 'John Doe',
}
});
The common way to send file(s) in the body of a request is to encode it as form fields with multipart/form-data
encoding. You can achieve that with Playwright API like this:
// Open file as a stream and pass it to the request:
const stream = fs.createReadStream('team.csv');
await request.fetch('https://example.com/api/uploadTeamList', {
method: 'post',
multipart: {
fileField: stream
}
});
// Or you can pass the file content directly as an object:
await request.fetch('https://example.com/api/uploadScript', {
method: 'post',
multipart: {
fileField: {
name: 'f.js',
mimeType: 'text/javascript',
buffer: Buffer.from('console.log(2022);')
}
}
});
Target URL or Request to get all parameters from.
Optional options: { Optional
Optional data?: anyAllows to set post data of the request. If the data parameter is an object, it will be serialized to json string
and content-type header will be set to application/json if not explicitly set. Otherwise the content-type
header will be set to application/octet-stream if not explicitly set.
Optional failWhether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status codes.
Optional form?: { Provides an object that will be serialized as html form using application/x-www-form-urlencoded encoding and sent
as this request body. If this parameter is specified content-type header will be set to
application/x-www-form-urlencoded unless explicitly provided.
Optional headers?: { Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by it.
Optional ignoreHTTPSErrors?: booleanWhether to ignore HTTPS errors when sending network requests. Defaults to false.
Optional maxMaximum number of request redirects that will be followed automatically. An error will be thrown if the number is
exceeded. Defaults to 20. Pass 0 to not follow redirects.
Optional method?: stringOptional multipart?: { Provides an object that will be serialized as html form using multipart/form-data encoding and sent as this
request body. If this parameter is specified content-type header will be set to multipart/form-data unless
explicitly provided. File values can be passed either as
fs.ReadStream or as file-like object containing file
name, mime-type and its content.
Optional params?: { Query parameters to be sent with the URL.
Optional timeout?: numberRequest timeout in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.
Sends HTTP(S) GET request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.
Usage
Request parameters can be configured with params option, they will be serialized into the URL search parameters:
await request.get('https://example.com/api/getText', {
params: {
'isbn': '1234',
'page': 23,
}
});
Target URL.
Optional options: { Optional
Optional data?: anyAllows to set post data of the request. If the data parameter is an object, it will be serialized to json string
and content-type header will be set to application/json if not explicitly set. Otherwise the content-type
header will be set to application/octet-stream if not explicitly set.
Optional failWhether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status codes.
Optional form?: { Provides an object that will be serialized as html form using application/x-www-form-urlencoded encoding and sent
as this request body. If this parameter is specified content-type header will be set to
application/x-www-form-urlencoded unless explicitly provided.
Optional headers?: { Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by it.
Optional ignoreHTTPSErrors?: booleanWhether to ignore HTTPS errors when sending network requests. Defaults to false.
Optional maxMaximum number of request redirects that will be followed automatically. An error will be thrown if the number is
exceeded. Defaults to 20. Pass 0 to not follow redirects.
Optional multipart?: { Provides an object that will be serialized as html form using multipart/form-data encoding and sent as this
request body. If this parameter is specified content-type header will be set to multipart/form-data unless
explicitly provided. File values can be passed either as
fs.ReadStream or as file-like object containing file
name, mime-type and its content.
Optional params?: { Query parameters to be sent with the URL.
Optional timeout?: numberRequest timeout in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.
Sends HTTP(S) HEAD request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.
Target URL.
Optional options: { Optional
Optional data?: anyAllows to set post data of the request. If the data parameter is an object, it will be serialized to json string
and content-type header will be set to application/json if not explicitly set. Otherwise the content-type
header will be set to application/octet-stream if not explicitly set.
Optional failWhether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status codes.
Optional form?: { Provides an object that will be serialized as html form using application/x-www-form-urlencoded encoding and sent
as this request body. If this parameter is specified content-type header will be set to
application/x-www-form-urlencoded unless explicitly provided.
Optional headers?: { Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by it.
Optional ignoreHTTPSErrors?: booleanWhether to ignore HTTPS errors when sending network requests. Defaults to false.
Optional maxMaximum number of request redirects that will be followed automatically. An error will be thrown if the number is
exceeded. Defaults to 20. Pass 0 to not follow redirects.
Optional multipart?: { Provides an object that will be serialized as html form using multipart/form-data encoding and sent as this
request body. If this parameter is specified content-type header will be set to multipart/form-data unless
explicitly provided. File values can be passed either as
fs.ReadStream or as file-like object containing file
name, mime-type and its content.
Optional params?: { Query parameters to be sent with the URL.
Optional timeout?: numberRequest timeout in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.
Sends HTTP(S) PATCH request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.
Target URL.
Optional options: { Optional
Optional data?: anyAllows to set post data of the request. If the data parameter is an object, it will be serialized to json string
and content-type header will be set to application/json if not explicitly set. Otherwise the content-type
header will be set to application/octet-stream if not explicitly set.
Optional failWhether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status codes.
Optional form?: { Provides an object that will be serialized as html form using application/x-www-form-urlencoded encoding and sent
as this request body. If this parameter is specified content-type header will be set to
application/x-www-form-urlencoded unless explicitly provided.
Optional headers?: { Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by it.
Optional ignoreHTTPSErrors?: booleanWhether to ignore HTTPS errors when sending network requests. Defaults to false.
Optional maxMaximum number of request redirects that will be followed automatically. An error will be thrown if the number is
exceeded. Defaults to 20. Pass 0 to not follow redirects.
Optional multipart?: { Provides an object that will be serialized as html form using multipart/form-data encoding and sent as this
request body. If this parameter is specified content-type header will be set to multipart/form-data unless
explicitly provided. File values can be passed either as
fs.ReadStream or as file-like object containing file
name, mime-type and its content.
Optional params?: { Query parameters to be sent with the URL.
Optional timeout?: numberRequest timeout in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.
Sends HTTP(S) POST request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.
Usage
JSON objects can be passed directly to the request:
await request.post('https://example.com/api/createBook', {
data: {
title: 'Book Title',
author: 'John Doe',
}
});
To send form data to the server use form option. Its value will be encoded into the request body with
application/x-www-form-urlencoded encoding (see below how to use multipart/form-data form encoding to send
files):
await request.post('https://example.com/api/findBook', {
form: {
title: 'Book Title',
author: 'John Doe',
}
});
The common way to send file(s) in the body of a request is to upload them as form fields with multipart/form-data
encoding. You can achieve that with Playwright API like this:
// Open file as a stream and pass it to the request:
const stream = fs.createReadStream('team.csv');
await request.post('https://example.com/api/uploadTeamList', {
multipart: {
fileField: stream
}
});
// Or you can pass the file content directly as an object:
await request.post('https://example.com/api/uploadScript', {
multipart: {
fileField: {
name: 'f.js',
mimeType: 'text/javascript',
buffer: Buffer.from('console.log(2022);')
}
}
});
Target URL.
Optional options: { Optional
Optional data?: anyAllows to set post data of the request. If the data parameter is an object, it will be serialized to json string
and content-type header will be set to application/json if not explicitly set. Otherwise the content-type
header will be set to application/octet-stream if not explicitly set.
Optional failWhether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status codes.
Optional form?: { Provides an object that will be serialized as html form using application/x-www-form-urlencoded encoding and sent
as this request body. If this parameter is specified content-type header will be set to
application/x-www-form-urlencoded unless explicitly provided.
Optional headers?: { Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by it.
Optional ignoreHTTPSErrors?: booleanWhether to ignore HTTPS errors when sending network requests. Defaults to false.
Optional maxMaximum number of request redirects that will be followed automatically. An error will be thrown if the number is
exceeded. Defaults to 20. Pass 0 to not follow redirects.
Optional multipart?: { Provides an object that will be serialized as html form using multipart/form-data encoding and sent as this
request body. If this parameter is specified content-type header will be set to multipart/form-data unless
explicitly provided. File values can be passed either as
fs.ReadStream or as file-like object containing file
name, mime-type and its content.
Optional params?: { Query parameters to be sent with the URL.
Optional timeout?: numberRequest timeout in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.
Sends HTTP(S) PUT request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.
Target URL.
Optional options: { Optional
Optional data?: anyAllows to set post data of the request. If the data parameter is an object, it will be serialized to json string
and content-type header will be set to application/json if not explicitly set. Otherwise the content-type
header will be set to application/octet-stream if not explicitly set.
Optional failWhether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status codes.
Optional form?: { Provides an object that will be serialized as html form using application/x-www-form-urlencoded encoding and sent
as this request body. If this parameter is specified content-type header will be set to
application/x-www-form-urlencoded unless explicitly provided.
Optional headers?: { Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by it.
Optional ignoreHTTPSErrors?: booleanWhether to ignore HTTPS errors when sending network requests. Defaults to false.
Optional maxMaximum number of request redirects that will be followed automatically. An error will be thrown if the number is
exceeded. Defaults to 20. Pass 0 to not follow redirects.
Optional multipart?: { Provides an object that will be serialized as html form using multipart/form-data encoding and sent as this
request body. If this parameter is specified content-type header will be set to multipart/form-data unless
explicitly provided. File values can be passed either as
fs.ReadStream or as file-like object containing file
name, mime-type and its content.
Optional params?: { Query parameters to be sent with the URL.
Optional timeout?: numberRequest timeout in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.
Returns storage state for this request context, contains current cookies and local storage snapshot if it was passed to the constructor.
Optional options: { Optional
Optional path?: stringThe file path to save the storage state to. If path is a relative path, then it is resolved relative to current
working directory. If no path is provided, storage state is still returned, but won't be saved to the disk.
Generated using TypeDoc
This API is used for the Web API testing. You can use it to trigger API endpoints, configure micro-services, prepare environment or the service to your e2e test.
Each Playwright browser context has associated with it APIRequestContext instance which shares cookie storage with the browser context and can be accessed via browserContext.request or page.request. It is also possible to create a new APIRequestContext instance manually by calling apiRequest.newContext([options]).
Cookie management
APIRequestContext returned by browserContext.request and page.request shares cookie storage with the corresponding BrowserContext. Each API request will have
Cookieheader populated with the values from the browser context. If the API response containsSet-Cookieheader it will automatically update BrowserContext cookies and requests made from the page will pick them up. This means that if you log in using this API, your e2e test will be logged in and vice versa.If you want API requests to not interfere with the browser cookies you should create a new APIRequestContext by calling apiRequest.newContext([options]). Such
APIRequestContextobject will have its own isolated cookie storage.