{ "doc": { "id": "api/commands/request", "title": "cy.request()", "description": "Make an HTTP request in Cypress.", "section": "api", "source_path": "/llm/markdown/api/commands/request.md", "version": "fbc9225067c51c52ee13224e3b702cf8a025ec12", "updated_at": "2026-08-14T12:36:26.878Z", "headings": [ { "id": "api/commands/request#request", "text": "request", "level": 1 }, { "id": "api/commands/request#syntax", "text": "Syntax", "level": 2 }, { "id": "api/commands/request#usage", "text": "Usage", "level": 3 }, { "id": "api/commands/request#arguments", "text": "Arguments", "level": 3 }, { "id": "api/commands/request#yields", "text": "Yields", "level": 3 }, { "id": "api/commands/request#examples", "text": "Examples", "level": 2 }, { "id": "api/commands/request#url", "text": "URL", "level": 3 }, { "id": "api/commands/request#make-a-get-request", "text": "Make a GET request", "level": 4 }, { "id": "api/commands/request#issue-an-http-request", "text": "Issue an HTTP request", "level": 4 }, { "id": "api/commands/request#method-and-url", "text": "Method and URL", "level": 3 }, { "id": "api/commands/request#send-a-delete-request", "text": "Send a DELETE request", "level": 4 }, { "id": "api/commands/request#alias-the-request-using-as", "text": "Alias the request using .as()", "level": 4 }, { "id": "api/commands/request#method-url-and-body", "text": "Method, URL, and Body", "level": 3 }, { "id": "api/commands/request#send-a-post-request-with-a-json-body", "text": "Send a POST request with a JSON body", "level": 4 }, { "id": "api/commands/request#options", "text": "Options", "level": 3 }, { "id": "api/commands/request#request-a-page-while-disabling-auto-redirect", "text": "Request a page while disabling auto redirect", "level": 4 }, { "id": "api/commands/request#http-basic-authentication", "text": "HTTP Basic Authentication", "level": 4 }, { "id": "api/commands/request#download-a-pdf-file", "text": "Download a PDF file", "level": 4 }, { "id": "api/commands/request#get-data-url-of-an-image", "text": "Get Data URL of an image", "level": 4 }, { "id": "api/commands/request#html-form-submissions-using-form-option", "text": "HTML form submissions using form option", "level": 4 }, { "id": "api/commands/request#using-cy-request-for-html-forms", "text": "Using cy.request() for HTML Forms", "level": 4 }, { "id": "api/commands/request#request-polling", "text": "Request Polling", "level": 3 }, { "id": "api/commands/request#call-cy-request-over-and-over-again", "text": "Call cy.request() over and over again", "level": 4 }, { "id": "api/commands/request#notes", "text": "Notes", "level": 2 }, { "id": "api/commands/request#json-request-and-response-bodies", "text": "JSON request and response bodies", "level": 3 }, { "id": "api/commands/request#request-body-serialization", "text": "Request body serialization", "level": 4 }, { "id": "api/commands/request#response-body-parsing", "text": "Response body parsing", "level": 4 }, { "id": "api/commands/request#debugging", "text": "Debugging", "level": 3 }, { "id": "api/commands/request#request-is-not-displayed-in-the-network-tab-of-developer-tools", "text": "Request is not displayed in the Network Tab of Developer Tools", "level": 4 }, { "id": "api/commands/request#cors", "text": "CORS", "level": 3 }, { "id": "api/commands/request#cors-is-bypassed", "text": "CORS is bypassed", "level": 4 }, { "id": "api/commands/request#cookies", "text": "Cookies", "level": 3 }, { "id": "api/commands/request#cookies-are-automatically-sent-and-received", "text": "Cookies are automatically sent and received", "level": 4 }, { "id": "api/commands/request#cy-intercept", "text": "cy.intercept()", "level": 3 }, { "id": "api/commands/request#cy-request-sends-requests-to-actual-endpoints-bypassing-those-defined-using-cy-intercept", "text": "cy.request() sends requests to actual endpoints, bypassing those defined using cy.intercept()", "level": 4 }, { "id": "api/commands/request#user-agent", "text": "User agent", "level": 3 }, { "id": "api/commands/request#rules", "text": "Rules", "level": 2 }, { "id": "api/commands/request#requirements", "text": "Requirements", "level": 3 }, { "id": "api/commands/request#assertions", "text": "Assertions", "level": 3 }, { "id": "api/commands/request#timeouts", "text": "Timeouts", "level": 3 }, { "id": "api/commands/request#command-log", "text": "Command Log", "level": 2 }, { "id": "api/commands/request#history", "text": "History", "level": 2 }, { "id": "api/commands/request#see-also", "text": "See also", "level": 2 } ] }, "content": { "type": "root", "children": [ { "type": "heading", "depth": 1, "children": [ { "type": "text", "value": "request" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Make an HTTP request." } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Syntax" } ] }, { "type": "code", "lang": null, "meta": null, "value": "cy.request(url)cy.request(url, body)cy.request(method, url)cy.request(method, url, body)cy.request(options)" }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Usage" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Correct Usage" } ] }, { "type": "code", "lang": null, "meta": null, "value": "cy.request('http://dev.local/seed')" }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Arguments" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "url (String)" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "The URL to make the request to." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "If you do not provide a fully qualified domain name (FQDN) URL, Cypress will make its best guess as to which host you want `cy.request()` to use in the URL." } ] }, { "type": "list", "ordered": true, "start": 1, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "If you make a `cy.request()` after visiting a page, Cypress assumes the URL used for the `cy.visit()` is the host." } ] } ] } ] }, { "type": "code", "lang": null, "meta": null, "value": "cy.visit('http://localhost:8080/app')cy.request('users/1.json') // URL is http://localhost:8080/users/1.json" }, { "type": "list", "ordered": true, "start": 1, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "If you make a `cy.request()` prior to visiting a page, Cypress assumes the host is the `baseUrl` property configured inside of of your " }, { "type": "link", "title": null, "url": "/llm/markdown/app/references/configuration.md", "children": [ { "type": "text", "value": "configuration file" } ] }, { "type": "text", "value": "." } ] } ] } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "cypress.config.js" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "cypress.config.ts" } ] } ] } ] }, { "type": "code", "lang": null, "meta": null, "value": "const { defineConfig } = require('cypress')module.exports = defineConfig({ e2e: { baseUrl: 'http://localhost:1234', },})" }, { "type": "code", "lang": null, "meta": null, "value": "import { defineConfig } from 'cypress'export default defineConfig({ e2e: { baseUrl: 'http://localhost:1234', },})" }, { "type": "code", "lang": null, "meta": null, "value": "cy.request('seed/admin') // URL is http://localhost:1234/seed/admin" }, { "type": "list", "ordered": true, "start": 1, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "If Cypress cannot determine the host it will throw an error." } ] } ] } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "body (String, Object)" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "A request `body` to be sent in the request. When `body` is a JavaScript object or boolean, Cypress automatically JSON-serializes it and sets the `Content-Type: application/json` request header. When `body` is a string, it is sent as-is with no automatic content-type." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "method (String)" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Make a request using a specific method. If no method is defined, Cypress uses the `GET` method by default." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Supported methods include:" } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`GET`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`POST`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`PUT`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`DELETE`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`PATCH`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`HEAD`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`OPTIONS`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`TRACE`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`COPY`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`QUERY`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`LOCK`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`MKCOL`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`MOVE`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`PURGE`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`PROPFIND`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`PROPPATCH`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`UNLOCK`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`REPORT`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`MKACTIVITY`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`CHECKOUT`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`MERGE`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`M-SEARCH`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`NOTIFY`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`SUBSCRIBE`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`UNSUBSCRIBE`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`SEARCH`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`CONNECT`" } ] } ] } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "options (Object)" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Pass in an options object to change the default behavior of `cy.request()`." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "You can also set options for `cy.request()`'s `baseUrl` and `responseTimeout` globally in " }, { "type": "link", "title": null, "url": "/llm/markdown/app/references/configuration.md", "children": [ { "type": "text", "value": "configuration" } ] }, { "type": "text", "value": "." } ] }, { "type": "table", "align": [ null, null, null ], "children": [ { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "Option" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Default" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Description" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`log`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`true`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Displays the command in the " }, { "type": "link", "title": null, "url": "/llm/markdown/app/core-concepts/open-mode.md#Command-Log", "children": [ { "type": "text", "value": "Command log" } ] } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`url`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`null`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "The URL to make the request to" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`method`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`GET`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "The HTTP method to use in the request" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`auth`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`null`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Adds Authorization headers for " }, { "type": "link", "title": null, "url": "#HTTP-Basic-Authentication", "children": [ { "type": "text", "value": "HTTP Basic Authentication" } ] }, { "type": "text", "value": "." } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`body`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`null`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Body to send along with the request" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`failOnStatusCode`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`true`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Whether to fail on response codes other than `2xx` and `3xx`" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`followRedirect`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`true`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Whether to automatically follow redirects" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`form`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`false`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Whether to convert the `body` values to URL encoded content and set the `x-www-form-urlencoded` header" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`encoding`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`utf8`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "The encoding to be used when serializing the response body. The following encodings are supported: `ascii`, `base64`, `binary`, `hex`, `latin1`, `utf8`, `utf-8`, `ucs2`, `ucs-2`, `utf16le`, `utf-16le`" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`gzip`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`true`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Whether to accept the `gzip` encoding" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`headers`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`null`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Additional headers to send; Accepts object literal. Note: `headers` will only be sent for the initial request for `cy.request()`, not for any subsequent requests." } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`qs`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`null`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Query parameters to append to the `url` of the request" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`retryOnStatusCodeFailure`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`false`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Whether Cypress should automatically retry status code errors under the hood. Cypress will retry a request up to 4 times if this is set to true." } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`retryOnNetworkFailure`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`true`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Whether Cypress should automatically retry transient network errors under the hood. Cypress will retry a request up to 4 times if this is set to true." } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`timeout`" } ] }, { "type": "tableCell", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/app/references/configuration.md#Timeouts", "children": [ { "type": "text", "value": "`responseTimeout`" } ] } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Time to wait for `cy.request()` to resolve before " }, { "type": "link", "title": null, "url": "#Timeouts", "children": [ { "type": "text", "value": "timing out" } ] } ] } ] } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "You can also set options for `cy.request()`'s `baseUrl` and `responseTimeout` globally in the " }, { "type": "link", "title": null, "url": "/llm/markdown/app/references/configuration.md", "children": [ { "type": "text", "value": "Cypress configuration" } ] }, { "type": "text", "value": "." } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Yields" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "`cy.request()` yields the `response` as an object literal containing properties such as:" } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`status`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`body`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`headers`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`duration`" } ] } ] } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "The `response.body` is automatically parsed as a JavaScript object when the response has a `Content-Type` header whose value ends in `json` (such as `application/json` or `application/vnd.api+json`). Otherwise, `response.body` is a string." } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Examples" } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "URL" } ] }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "Make a `GET` request" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "`cy.request()` is great for talking to an external endpoint before your tests to seed a database." } ] }, { "type": "code", "lang": null, "meta": null, "value": "beforeEach(() => { cy.request('http://localhost:8080/db/seed')})" }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "Issue an HTTP request" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Sometimes it's quicker to test the contents of a page rather than " }, { "type": "link", "title": null, "url": "/llm/markdown/api/commands/visit.md", "children": [ { "type": "text", "value": "`cy.visit()`" } ] }, { "type": "text", "value": " and wait for the entire page and all of its resources to load." } ] }, { "type": "code", "lang": null, "meta": null, "value": "cy.request('/admin').its('body').should('include', '

Admin

')" }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Method and URL" } ] }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "Send a `DELETE` request" } ] }, { "type": "code", "lang": null, "meta": null, "value": "cy.request('DELETE', 'http://localhost:8888/users/827')" }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "Alias the request using " }, { "type": "link", "title": null, "url": "/llm/markdown/api/commands/as.md", "children": [ { "type": "text", "value": ".as()" } ] } ] }, { "type": "code", "lang": null, "meta": null, "value": "cy.request('https://jsonplaceholder.cypress.io/comments').as('comments')cy.get('@comments').should((response) => { expect(response.body).to.have.length(500) expect(response).to.have.property('headers') expect(response).to.have.property('duration')})" }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Method, URL, and Body" } ] }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "Send a `POST` request with a JSON body" } ] }, { "type": "code", "lang": null, "meta": null, "value": "cy.request('POST', 'http://localhost:8888/users/admin', { name: 'Jane' }).then( (response) => { // response.body is automatically parsed from JSON when the server responds // with a Content-Type ending in \"json\" (e.g. application/json) expect(response.body).to.have.property('name', 'Jane') // true })" }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Options" } ] }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "Request a page while disabling auto redirect" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "To test the redirection behavior of a login without a session, `cy.request` can be used to check the `status` and `redirectedToUrl` property." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "The `redirectedToUrl` property is a special Cypress property that normalizes the URL the browser would normally follow during a redirect." } ] }, { "type": "code", "lang": null, "meta": null, "value": "cy.request({ url: '/dashboard', followRedirect: false, // turn off following redirects}).then((resp) => { // redirect status code is 302 expect(resp.status).to.eq(302) expect(resp.redirectedToUrl).to.eq('http://localhost:8082/unauthorized')})" }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "HTTP Basic Authentication" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "To send a request to an endpoint protected by " }, { "type": "link", "title": null, "url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication", "children": [ { "type": "text", "value": "HTTP Basic Authentication" } ] }, { "type": "text", "value": ", provide the credentials with the `auth` option. Cypress base64-encodes them and attaches an `Authorization` header to the request." } ] }, { "type": "code", "lang": null, "meta": null, "value": "cy.request({ method: 'POST', url: 'https://api.example.com/query', auth: { username: 'jane.lane', password: 'password123', }, body: { cpId: 709916, },})" }, { "type": "paragraph", "children": [ { "type": "text", "value": "The `auth` option also accepts `user`/`pass` as aliases for `username`/`password`." } ] }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "Download a PDF file" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "By passing the `encoding: binary` option, the `response.body` will be serialized binary content of the file. You can use this to access various file types via `.request()` like `.pdf`, `.zip`, or `.doc` files." } ] }, { "type": "code", "lang": null, "meta": null, "value": "cy.request({ url: 'http://localhost:8080/some-document.pdf', encoding: 'binary',}).then((response) => { cy.writeFile('path/to/save/document.pdf', response.body, 'binary')})" }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "Get Data URL of an image" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "By passing the `encoding: base64` option, the `response.body` will be base64-encoded content of the image. You can use this to construct a " }, { "type": "link", "title": null, "url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs", "children": [ { "type": "text", "value": "Data URI" } ] }, { "type": "text", "value": " for use elsewhere." } ] }, { "type": "code", "lang": null, "meta": null, "value": "cy.request({ url: 'https://docs.cypress.io/img/logo.png', encoding: 'base64',}).then((response) => { const base64Content = response.body const mime = response.headers['content-type'] // or 'image/png' // see https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs const imageDataUrl = `data:${mime};base64,${base64Content}`})" }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "HTML form submissions using form option" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Oftentimes, once you have a proper e2e test around logging in, there's no reason to continue to `cy.visit()` the login and wait for the entire page to load all associated resources before running any other commands. Doing so can slow down our entire test suite." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Using `cy.request()`, we can bypass all of this because it automatically gets and sets cookies as if the requests had come from the browser." } ] }, { "type": "code", "lang": null, "meta": null, "value": "cy.request({ method: 'POST', url: '/login_with_form', // baseUrl is prepend to URL form: true, // indicates the body should be form urlencoded and sets Content-Type: application/x-www-form-urlencoded headers body: { username: 'jane.lane', password: 'password123', },})// to prove we have a sessioncy.getCookie('cypress-session-cookie').should('exist')" }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "Using `cy.request()` for HTML Forms" } ] }, { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/app/references/recipes.md#Logging-In", "children": [ { "type": "text", "value": "Check out our example recipe using `cy.request()` for HTML web forms" } ] } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Request Polling" } ] }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "Call `cy.request()` over and over again" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "This is useful when you're polling a server for a response that may take awhile to complete." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "All we're really doing here is creating a recursive function. Nothing more complicated than that." } ] }, { "type": "code", "lang": null, "meta": null, "value": "// a regular ol' function folksfunction req () { cy .request(...) .then((resp) => { // if we got what we wanted if (resp.status === 200 && resp.body.ok === true) // break out of the recursive loop return // else recurse req() })}cy // do the thing causing the side effect .get('button').click() // now start the requests .then(req)" }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Notes" } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "JSON request and response bodies" } ] }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "Request body serialization" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "When `body` is a JavaScript object or boolean and `form` is not `true`, Cypress automatically:" } ] }, { "type": "list", "ordered": true, "start": 1, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "JSON-serializes the request body." } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Adds a `Content-Type: application/json` header to the request." } ] } ] } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "When `body` is a string, it is sent as-is and no `Content-Type` header is added automatically." } ] }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "Response body parsing" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Cypress always inspects the `Content-Type` header of the response. If that header's value ends in `json` (for example `application/json` or `application/vnd.api+json`), `response.body` is automatically parsed into a JavaScript object. Otherwise `response.body` is a string." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "This means the automatic JSON parsing of `response.body` depends entirely on what the server returns in its `Content-Type` header — it is not affected by the type of the request `body`." } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Debugging" } ] }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "Request is not displayed in the Network Tab of Developer Tools" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Cypress does not actually make an XHR request from the browser. We are actually making the HTTP request from Cypress (in Node). So, you won't see the request inside of your Developer Tools." } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "CORS" } ] }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "CORS is bypassed" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Normally when the browser detects a cross-origin HTTP request, it will send an `OPTIONS` preflight check to ensure the server allows cross-origin requests, but `cy.request()` bypasses CORS entirely." } ] }, { "type": "code", "lang": null, "meta": null, "value": "// we can make requests to any external server, no problem.cy.request('https://www.google.com/webhp?#q=cypress.io+cors') .its('body') .should('include', 'Testing, the way it should be') // true" }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Cookies" } ] }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "Cookies are automatically sent and received" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Before sending the HTTP request, we automatically attach cookies that would have otherwise been attached had the request come from the browser. Additionally, if a response has a `Set-Cookie` header, these are automatically set back on the browser cookies." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "In other words, `cy.request()` transparently performs all of the underlying functions as if it came from the browser." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Cookies are pulled from the cookie jar by domain match. A cookie set without `hostOnly: true` is a domain cookie, so it can be attached to a `cy.request()` aimed at a different host that domain-matches it (for example a sibling subdomain on the same registrable domain). If a cookie shows up on a request unexpectedly, see " }, { "type": "link", "title": null, "url": "/llm/markdown/api/commands/setcookie.md#Cookie-scope-host-only-vs-domain-cookies", "children": [ { "type": "text", "value": "Cookie scope (host-only vs. domain cookies)" } ] }, { "type": "text", "value": " for how to scope it to a single exact host with `hostOnly: true`." } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "link", "title": null, "url": "/llm/markdown/api/commands/intercept.md", "children": [ { "type": "text", "value": "`cy.intercept()`" } ] } ] }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "`cy.request()` sends requests to actual endpoints, bypassing those defined using `cy.intercept()`" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "The intention of `cy.request()` is to be used for checking endpoints on an actual, running server without having to start the front end application." } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "User agent" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Trying to change the `User-Agent`?" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "See " }, { "type": "link", "title": null, "url": "/llm/markdown/app/faq.md#Can-I-override-or-change-the-default-user-agent-the-browser-uses", "children": [ { "type": "text", "value": "how to override the browser's default user agent" } ] }, { "type": "text", "value": "." } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Rules" } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Requirements" } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`cy.request()` requires being chained off of `cy`." } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`cy.request()` requires that the server sends a response." } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`cy.request()` requires that the response status code be `2xx` or `3xx` when `failOnStatusCode` is `true`." } ] } ] } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Assertions" } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`cy.request()` will only run assertions you have chained once, and will not " }, { "type": "link", "title": null, "url": "/llm/markdown/app/core-concepts/retry-ability.md", "children": [ { "type": "text", "value": "retry" } ] }, { "type": "text", "value": "." } ] } ] } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Timeouts" } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`cy.request()` can time out waiting for the server to respond." } ] } ] } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Command Log" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Request comments endpoint and test response" } ] }, { "type": "code", "lang": null, "meta": null, "value": "cy.request('https://jsonplaceholder.typicode.com/comments').then((response) => { expect(response.status).to.eq(200) expect(response.body).to.have.length(500) expect(response).to.have.property('headers') expect(response).to.have.property('duration')})" }, { "type": "paragraph", "children": [ { "type": "text", "value": "The commands above will display in the Command Log as:" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "When clicking on `request` within the command log, the console outputs the following:" } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "History" } ] }, { "type": "table", "align": [ null, null ], "children": [ { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "Version" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Changes" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/app/references/changelog.md#15-20-0", "children": [ { "type": "text", "value": "15.20.0" } ] } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Added support for `QUERY` method." } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/app/references/changelog.md#3-3-0", "children": [ { "type": "text", "value": "4.7.0" } ] } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Added support for `encoding` option." } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/app/references/changelog.md#3-3-0", "children": [ { "type": "text", "value": "3.3.0" } ] } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Added support for options `retryOnStatusCodeFailure` and `retryOnNetworkFailure`." } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/app/references/changelog.md#3-2-0", "children": [ { "type": "text", "value": "3.2.0" } ] } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Added support for any valid HTTP `method` argument including `TRACE`, `COPY`, `LOCK`, `MKCOL`, `MOVE`, `PURGE`, `PROPFIND`, `PROPPATCH`, `UNLOCK`, `REPORT`, `MKACTIVITY`, `CHECKOUT`, `MERGE`, `M-SEARCH`, `NOTIFY`, `SUBSCRIBE`, `UNSUBSCRIBE`, `SEARCH`, and `CONNECT`." } ] } ] } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "See also" } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/app/guides/api-testing.md", "children": [ { "type": "text", "value": "API Testing" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/api/commands/exec.md", "children": [ { "type": "text", "value": "`cy.exec()`" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/api/commands/task.md", "children": [ { "type": "text", "value": "`cy.task()`" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/api/commands/visit.md", "children": [ { "type": "text", "value": "`cy.visit()`" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/app/references/recipes.md#Logging-In", "children": [ { "type": "text", "value": "Recipe: Logging In - Single Sign on" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/app/references/recipes.md#Logging-In", "children": [ { "type": "text", "value": "Recipe: Logging In - HTML Web Form" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/app/references/recipes.md#Logging-In", "children": [ { "type": "text", "value": "Recipe: Logging In - XHR Web Form" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/app/references/recipes.md#Logging-In", "children": [ { "type": "text", "value": "Recipe: Logging In - CSRF Tokens" } ] } ] } ] } ] } ] }, "token_estimate": 2616 }