Module cdp::network

Network domain allows tracking network activities of the page. It exposes information about http, file, data and other requests and responses, their headers, bodies, timing, etc.

Network

Commands

• Network.enable

  Enables network tracking, network events will now be delivered to the client.

• Network.disable

  Disables network tracking, prevents network events from being sent to the client.

• Network.setUserAgentOverride

  Allows overriding user agent with the given string.

• Network.setExtraHTTPHeaders

  Specifies whether to always send extra HTTP headers with the requests from this page.

• Network.getResponseBody

  Returns content served for the given request.

• Network.setBlockedURLs Experimental

  Blocks URLs from loading.

• Network.replayXHR Experimental

  This method sends a new XMLHttpRequest which is identical to the original one. The following parameters should be identical: method, url, async, request body, extra headers, withCredentials attribute, user, password.

• Network.canClearBrowserCache

  Tells whether clearing browser cache is supported.

• Network.clearBrowserCache

  Clears browser cache.

• Network.canClearBrowserCookies

  Tells whether clearing browser cookies is supported.

• Network.clearBrowserCookies

  Clears browser cookies.

• Network.getCookies Experimental

  Returns all browser cookies for the current URL. Depending on the backend support, will return detailed cookie information in the cookies field.

• Network.getAllCookies Experimental

  Returns all browser cookies. Depending on the backend support, will return detailed cookie information in the cookies field.

• Network.deleteCookies Experimental

  Deletes browser cookies with matching name and url or domain/path pair.

• Network.setCookie Experimental

  Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.

• Network.setCookies Experimental

  Sets given cookies.

• Network.canEmulateNetworkConditions Experimental

  Tells whether emulation of network conditions is supported.

• Network.emulateNetworkConditions

  Activates emulation of network conditions.

• Network.setCacheDisabled

  Toggles ignoring cache for each request. If true, cache will not be used.

• Network.setBypassServiceWorker Experimental

  Toggles ignoring of service worker for each request.

• Network.setDataSizeLimitsForTest Experimental

  For testing.

• Network.getCertificate Experimental

  Returns the DER-encoded certificate.

• Network.setRequestInterceptionEnabled Experimental

  Sets the requests to intercept that match a the provided patterns.

• Network.continueInterceptedRequest Experimental

  Response to Network.requestIntercepted which either modifies the request to continue with any modifications, or blocks it, or completes it with the provided response bytes. If a network fetch occurs as a result which encounters a redirect an additional Network.requestIntercepted event will be sent with the same InterceptionId.

Events

• Network.resourceChangedPriority Experimental

  Fired when resource loading priority is changed

• Network.requestWillBeSent

  Fired when page is about to send HTTP request.

• Network.requestServedFromCache

  Fired if request ended up loading from cache.

• Network.responseReceived

  Fired when HTTP response is available.

• Network.dataReceived

  Fired when data chunk was received over the network.

• Network.loadingFinished

  Fired when HTTP request has finished loading.

• Network.loadingFailed

  Fired when HTTP request has failed to load.

• Network.webSocketWillSendHandshakeRequest Experimental

  Fired when WebSocket is about to initiate handshake.

• Network.webSocketHandshakeResponseReceived Experimental

  Fired when WebSocket handshake response becomes available.

• Network.webSocketCreated Experimental

  Fired upon WebSocket creation.

• Network.webSocketClosed Experimental

  Fired when WebSocket is closed.

• Network.webSocketFrameReceived Experimental

  Fired when WebSocket frame is received.

• Network.webSocketFrameError Experimental

  Fired when WebSocket frame error occurs.

• Network.webSocketFrameSent Experimental

  Fired when WebSocket frame is sent.

• Network.eventSourceMessageReceived Experimental

  Fired when EventSource message is received.

• Network.requestIntercepted Experimental

  Details of an intercepted HTTP request, which must be either allowed, blocked, modified or mocked.

Types

• LoaderId

  Unique loader identifier.

• RequestId

  Unique request identifier.

• InterceptionId

  Unique intercepted request identifier.

• ErrorReason

  Network level fetch failure reason.

• TimeSinceEpoch

  UTC time in seconds, counted from January 1, 1970.

• MonotonicTime

  Monotonically increasing time in seconds since an arbitrary point in the past.

• Headers

  Request / response headers as keys / values of JSON object.

• ConnectionType

  Loading priority of a resource request.

• CookieSameSite

  Represents the cookie's 'SameSite' status: https://tools.ietf.org/html/draft-west-first-party-cookies

• ResourceTiming

  Timing information for the request.

• ResourcePriority

  Loading priority of a resource request.

• Request

  HTTP request data.

• SignedCertificateTimestamp

  Details of a signed certificate timestamp (SCT).

• SecurityDetails

  Security details about a request.

• BlockedReason Experimental

  The reason why request was blocked.

• Response

  HTTP response data.

• WebSocketRequest Experimental

  WebSocket request data.

• WebSocketResponse Experimental

  WebSocket response data.

• WebSocketFrame Experimental

  WebSocket frame data.

• CachedResource

  Information about the cached resource.

• Initiator

  Information about the request initiator.

• Cookie Experimental

  Cookie object

• CookieParam Experimental

  Cookie parameter object

• AuthChallenge Experimental

  Authorization challenge for HTTP status code 401 or 407.

• AuthChallengeResponse Experimental

  Response to an AuthChallenge.

Structs

AuthChallenge	[Experimental] Authorization challenge for HTTP status code 401 or 407.
AuthChallengeResponse	[Experimental] Response to an AuthChallenge.
CachedResource	Information about the cached resource.
CanClearBrowserCacheCommand	Tells whether clearing browser cache is supported.
CanClearBrowserCacheResponse	Tells whether clearing browser cache is supported.
CanClearBrowserCookiesCommand	Tells whether clearing browser cookies is supported.
CanClearBrowserCookiesResponse	Tells whether clearing browser cookies is supported.
CanEmulateNetworkConditionsCommand	[Experimental] Tells whether emulation of network conditions is supported.
CanEmulateNetworkConditionsResponse	[Experimental] Tells whether emulation of network conditions is supported.
ClearBrowserCacheCommand	Clears browser cache.
ClearBrowserCacheResponse	Clears browser cache.
ClearBrowserCookiesCommand	Clears browser cookies.
ClearBrowserCookiesResponse	Clears browser cookies.
ContinueInterceptedRequestCommand	[Experimental] Response to Network.requestIntercepted which either modifies the request to continue with any modifications, or blocks it, or completes it with the provided response bytes. If a network fetch occurs as a result which encounters a redirect an additional Network.requestIntercepted event will be sent with the same InterceptionId.
ContinueInterceptedRequestResponse	[Experimental] Response to Network.requestIntercepted which either modifies the request to continue with any modifications, or blocks it, or completes it with the provided response bytes. If a network fetch occurs as a result which encounters a redirect an additional Network.requestIntercepted event will be sent with the same InterceptionId.
Cookie	[Experimental] Cookie object
CookieParam	[Experimental] Cookie parameter object
DataReceivedEvent	Fired when data chunk was received over the network.
DeleteCookiesCommand	[Experimental] Deletes browser cookies with matching name and url or domain/path pair.
DeleteCookiesResponse	[Experimental] Deletes browser cookies with matching name and url or domain/path pair.
DisableCommand	Disables network tracking, prevents network events from being sent to the client.
DisableResponse	Disables network tracking, prevents network events from being sent to the client.
EmulateNetworkConditionsCommand	Activates emulation of network conditions.
EmulateNetworkConditionsResponse	Activates emulation of network conditions.
EnableCommand	Enables network tracking, network events will now be delivered to the client.
EnableResponse	Enables network tracking, network events will now be delivered to the client.
EventSourceMessageReceivedEvent	[Experimental] Fired when EventSource message is received.
GetAllCookiesCommand	[Experimental] Returns all browser cookies. Depending on the backend support, will return detailed cookie information in the cookies field.
GetAllCookiesResponse	[Experimental] Returns all browser cookies. Depending on the backend support, will return detailed cookie information in the cookies field.
GetCertificateCommand	[Experimental] Returns the DER-encoded certificate.
GetCertificateResponse	[Experimental] Returns the DER-encoded certificate.
GetCookiesCommand	[Experimental] Returns all browser cookies for the current URL. Depending on the backend support, will return detailed cookie information in the cookies field.
GetCookiesResponse	[Experimental] Returns all browser cookies for the current URL. Depending on the backend support, will return detailed cookie information in the cookies field.
GetResponseBodyCommand	Returns content served for the given request.
GetResponseBodyResponse	Returns content served for the given request.
Initiator	Information about the request initiator.
LoadingFailedEvent	Fired when HTTP request has failed to load.
LoadingFinishedEvent	Fired when HTTP request has finished loading.
ReplayXhrCommand	[Experimental] This method sends a new XMLHttpRequest which is identical to the original one. The following parameters should be identical: method, url, async, request body, extra headers, withCredentials attribute, user, password.
ReplayXhrResponse	[Experimental] This method sends a new XMLHttpRequest which is identical to the original one. The following parameters should be identical: method, url, async, request body, extra headers, withCredentials attribute, user, password.
Request	HTTP request data.
RequestInterceptedEvent	[Experimental] Details of an intercepted HTTP request, which must be either allowed, blocked, modified or mocked.
RequestServedFromCacheEvent	Fired if request ended up loading from cache.
RequestWillBeSentEvent	Fired when page is about to send HTTP request.
ResourceChangedPriorityEvent	[Experimental] Fired when resource loading priority is changed
ResourceTiming	Timing information for the request.
Response	HTTP response data.
ResponseReceivedEvent	Fired when HTTP response is available.
SecurityDetails	Security details about a request.
SetBlockedUrLsCommand	[Experimental] Blocks URLs from loading.
SetBlockedUrLsResponse	[Experimental] Blocks URLs from loading.
SetBypassServiceWorkerCommand	[Experimental] Toggles ignoring of service worker for each request.
SetBypassServiceWorkerResponse	[Experimental] Toggles ignoring of service worker for each request.
SetCacheDisabledCommand	Toggles ignoring cache for each request. If true, cache will not be used.
SetCacheDisabledResponse	Toggles ignoring cache for each request. If true, cache will not be used.
SetCookieCommand	[Experimental] Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.
SetCookieResponse	[Experimental] Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.
SetCookiesCommand	[Experimental] Sets given cookies.
SetCookiesResponse	[Experimental] Sets given cookies.
SetDataSizeLimitsForTestCommand	[Experimental] For testing.
SetDataSizeLimitsForTestResponse	[Experimental] For testing.
SetExtraHttpHeadersCommand	Specifies whether to always send extra HTTP headers with the requests from this page.
SetExtraHttpHeadersResponse	Specifies whether to always send extra HTTP headers with the requests from this page.
SetRequestInterceptionEnabledCommand	[Experimental] Sets the requests to intercept that match a the provided patterns.
SetRequestInterceptionEnabledResponse	[Experimental] Sets the requests to intercept that match a the provided patterns.
SetUserAgentOverrideCommand	Allows overriding user agent with the given string.
SetUserAgentOverrideResponse	Allows overriding user agent with the given string.
SignedCertificateTimestamp	Details of a signed certificate timestamp (SCT).
WebSocketClosedEvent	[Experimental] Fired when WebSocket is closed.
WebSocketCreatedEvent	[Experimental] Fired upon WebSocket creation.
WebSocketFrame	[Experimental] WebSocket frame data.
WebSocketFrameErrorEvent	[Experimental] Fired when WebSocket frame error occurs.
WebSocketFrameReceivedEvent	[Experimental] Fired when WebSocket frame is received.
WebSocketFrameSentEvent	[Experimental] Fired when WebSocket frame is sent.
WebSocketHandshakeResponseReceivedEvent	[Experimental] Fired when WebSocket handshake response becomes available.
WebSocketRequest	[Experimental] WebSocket request data.
WebSocketResponse	[Experimental] WebSocket response data.
WebSocketWillSendHandshakeRequestEvent	[Experimental] Fired when WebSocket is about to initiate handshake.

Enums

AuthChallengeResponseResponse	[Experimental]
AuthChallengeSource	[Experimental]
BlockedReason	[Experimental] The reason why request was blocked.
ConnectionType	Loading priority of a resource request.
CookieSameSite	Represents the cookie's 'SameSite' status: https://tools.ietf.org/html/draft-west-first-party-cookies
ErrorReason	Network level fetch failure reason.
InitiatorType	Used in the type of cdp::network::Initiator::ty.
RequestReferrerPolicy	Used in the type of cdp::network::Request::referrer_policy.
ResourcePriority	Loading priority of a resource request.

Type Definitions

Headers	Request / response headers as keys / values of JSON object.
InterceptionId	Unique intercepted request identifier.
LoaderId	Unique loader identifier.
MonotonicTime	Monotonically increasing time in seconds since an arbitrary point in the past.
RequestId	Unique request identifier.
TimeSinceEpoch	UTC time in seconds, counted from January 1, 1970.