lealsdb: deprecate identities/by_password

Flared · Sep 29, 2024 · 464fb08 · 464fb08
1 parent e60a37c
commit 464fb08
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 4 deletions.
diff --git a/docs/api-reference/leaksdb/endpoints/get-by-password.mdx b/docs/api-reference/leaksdb/endpoints/get-by-password.mdx
@@ -3,6 +3,11 @@ title: "List by Password"
 api: "GET https://api.flare.io/leaksdb/identities/by_password/{password}"
 ---
 
+<Warning>
+**DEPRECATED:** This endpoint should be replaced by
+[/credentials/_search <Icon icon="code" size={16} />](/api-reference/leaksdb/endpoints/post-credentials-search)
+</Warning>
+
 This endpoint allow to search by passwords.
 It will return a list of JSON objects containing identities that have been associated seen using this password.
 

diff --git a/docs/api-reference/leaksdb/endpoints/post-credentials-search.mdx b/docs/api-reference/leaksdb/endpoints/post-credentials-search.mdx
@@ -82,5 +82,12 @@ See the guide for using this endpoint:
     "fqdn": "<string>"
   }
   ```
+
+  ```json Password Query
+  {
+    "type": "secret",
+    "secret": "<string>"
+  }
+  ```
   </CodeGroup>
 </ParamField>
diff --git a/docs/mint.json b/docs/mint.json
@@ -146,8 +146,7 @@
           "group": "Identities",
           "pages": [
             "api-reference/leaksdb/endpoints/get-by-keyword",
-            "api-reference/leaksdb/endpoints/post-by-accounts",
-            "api-reference/leaksdb/endpoints/get-by-password"
+            "api-reference/leaksdb/endpoints/post-by-accounts"
           ]
         }
       ]
@@ -265,7 +264,8 @@
         {
           "group": "Identities",
           "pages": [
-            "api-reference/leaksdb/endpoints/get-by-domain"
+            "api-reference/leaksdb/endpoints/get-by-domain",
+            "api-reference/leaksdb/endpoints/get-by-password"
           ]
         },
         {
@@ -285,4 +285,4 @@
     "github": "https://github.com/flared",
     "youtube": "https://www.youtube.com/@flarecybersecurity"
   }
-}
+}