Skip to content
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.

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

leaksdb: document search by keyword #18

Merged
merged 1 commit into from
Sep 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions docs/api-reference/leaksdb/endpoints/get-by-keyword.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ title: "List by Keyword"
api: "GET https://api.flare.io/leaksdb/identities/by_keyword/{keyword}"
---

<Warning>
**DEPRECATED:** This endpoint should be replaced by
[/credentials/_search <Icon icon="code" size={16} />](/api-reference/leaksdb/endpoints/post-credentials-search)
</Warning>

Returns a list of identities with a matching keyword.

Results are returned in ascending order by id.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,5 +89,12 @@ See the guide for using this endpoint:
"secret": "<string>"
}
```

```json Keyword Query
{
"type": "keyword",
"keyword": "<string>"
}
```
</CodeGroup>
</ParamField>
2 changes: 1 addition & 1 deletion docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,6 @@
{
"group": "Identities",
"pages": [
"api-reference/leaksdb/endpoints/get-by-keyword",
"api-reference/leaksdb/endpoints/post-by-accounts"
]
}
Expand Down Expand Up @@ -265,6 +264,7 @@
"group": "Identities",
"pages": [
"api-reference/leaksdb/endpoints/get-by-domain",
"api-reference/leaksdb/endpoints/get-by-keyword",
"api-reference/leaksdb/endpoints/get-by-password"
]
},
Expand Down