screenshot
Creates, updates, deletes, gets or lists a screenshot resource.
Overview
| Name | screenshot |
| Type | Resource |
| Id | cloudflare.browser_rendering.screenshot |
Fields
The following fields are returned by SELECT queries:
- get
Returns the screenshot.
| Name | Datatype | Description |
|---|---|---|
errors | array | |
success | boolean | Response status. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | account_id | cacheTTL | Takes a screenshot of a webpage from provided URL or HTML. Control page loading with gotoOptions and waitFor* options. Customize screenshots with viewport, fullPage, clip and others. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
account_id | string | The Cloudflare account ID. |
cacheTTL | number | Cache TTL default is 5s. Set to 0 to disable. |
SELECT examples
- get
Takes a screenshot of a webpage from provided URL or HTML. Control page loading with gotoOptions and waitFor* options. Customize screenshots with viewport, fullPage, clip and others.
SELECT
errors,
success
FROM cloudflare.browser_rendering.screenshot
WHERE account_id = '{{ account_id }}' -- required
AND cacheTTL = '{{ cacheTTL }}'
;