Skip to content

Commit d34a90d

Browse files
committed
leaksdb: document get-creds
1 parent cd7dfe4 commit d34a90d

File tree

2 files changed

+81
-0
lines changed

2 files changed

+81
-0
lines changed
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
title: "List All Credentials"
3+
api: "GET https://api.flare.io/leaksdb/v2/credentials"
4+
---
5+
6+
<Warning>
7+
**DEPRECATED:** This endpoint should be replaced by
8+
[/astp/v2/credentials/_search <Icon icon="code" size={16} />](/api-reference/astp/endpoints/post-credentials-search)
9+
</Warning>
10+
11+
This endpoint will return a list of all crendentials in Flare's database, meant to be used as a feed.
12+
13+
Results are returned in ascending order by id, and optional parameters can be added to the query to fetch and filter large amounts (or all) of results.
14+
15+
<ResponseExample>
16+
17+
```json Response Example
18+
{
19+
"items": [
20+
{
21+
"credential_hash": "889d9ba6efa420d3dff7822c9119e744",
22+
"domain": "web.de",
23+
"extra": {},
24+
"hash": "password123",
25+
"hash_type": "unknown",
26+
"id": 1,
27+
"identity_name": "[email protected]",
28+
"imported_at": "2019-06-03T14:20:25.132662+00:00",
29+
"source": null,
30+
"source_id": "collection-1",
31+
"source_params": null
32+
},
33+
{
34+
"credential_hash": "67033809d2befde723e2cb6893c470ef",
35+
"domain": "arcor.de",
36+
"extra": {},
37+
"hash": "sunshine",
38+
"hash_type": "unknown",
39+
"id": 2,
40+
"identity_name": "[email protected]",
41+
"imported_at": "2019-06-03T14:20:25.132662+00:00",
42+
"source": null,
43+
"source_id": "collection-1",
44+
"source_params": null
45+
}
46+
],
47+
"next": "WyJ7XCJjXCI6Mn0iXQ"
48+
}
49+
```
50+
51+
</ResponseExample>
52+
53+
## Paging
54+
55+
This endpoint supports the
56+
[Flare standard paging pattern <Icon icon="book" size={16} />](/concepts/paging).
57+
58+
## Query Parameters
59+
60+
<ParamField query="size" type="number">
61+
Maximum size of the JSON object that will be returned (maximum 5 000)
62+
</ParamField>
63+
64+
<ParamField query="from" type="number">
65+
The `next` value from the last response.
66+
</ParamField>
67+
68+
<ParamField query="order" type="string">
69+
Order in which you want to browse the credentials. One of `asc` or `desc`.
70+
It defaults to `asc` which is the recommended way to use the API to obtain newly imported passwords.
71+
</ParamField>
72+
73+
<ParamField query="source_id" type="string">
74+
Return only credentials that belong to the specified source.
75+
</ParamField>

docs/docs.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,12 @@
233233
"api-reference/v2/endpoints/search/post-fireworkv2search"
234234
]
235235
},
236+
{
237+
"group": "Credentials",
238+
"pages": [
239+
"api-reference/leaksdb/endpoints/get-credentials"
240+
]
241+
},
236242
{
237243
"group": "Identities",
238244
"pages": [

0 commit comments

Comments
 (0)