Skip to content

cookies-search: Document with_subdomains param #277

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
krispenney wants to merge 1 commit into
base: main
Choose a base branch
from
Open

cookies-search: Document with_subdomains param #277

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/api-reference/astp/endpoints/post-cookies-search.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,11 @@ See the guide for using this endpoint:
Order in which you want to browse the cookies. One of `asc` or `desc`.
It defaults to `asc` which is the recommended way to use the API to obtain newly imported cookies.
</ParamField>

<ParamField body="with_subdomains" type="boolean" default={false}>
When `true`, `domain` is treated as the parent domain and the results also include cookies from its subdomains.

<Note>
This parameter only has an effect if a cookie matching policy is configured for the domain with **Match subdomains** enabled. Without one, only exact matches on `domain` are returned.
</Note>
</ParamField>