-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
62 additions
and
5 deletions.
There are no files selected for viewing
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
--- | ||
title: 'Getting Started' | ||
--- | ||
|
||
The Flare API can be used to access Flare's search capabilities, configure monitoring, export events, and more. | ||
|
||
## Concepts | ||
|
||
<CardGroup cols={2}> | ||
|
||
<Card title="Authentication" icon="key" href="/introduction/authentication"> | ||
Create an API Key and obtain API tokens. | ||
</Card> | ||
|
||
<Card title="Rate Limits" icon="gauge-high" href="/introduction/rate-limits"> | ||
Learn about the Flare API's rate limits. | ||
</Card> | ||
|
||
<Card title="Paging" icon="scroll" href="/introduction/paging"> | ||
Learn about Flare's standard `from` request parameter and `next` response field. | ||
</Card> | ||
|
||
</CardGroup> | ||
|
||
## Guides | ||
|
||
<CardGroup cols={2}> | ||
|
||
<Card title="List Events Within a Tenant" icon="list" href="/guides/tenant-events"> | ||
Export or search within all events associated within your tenant. | ||
</Card> | ||
|
||
<Card title="Exporting a Domain's Credentials" icon="passport" href="/guides/credentials-export-domain"> | ||
Export all of Flare's leaked credentials for a given domain. | ||
</Card> | ||
|
||
<Card title="Global Search" icon="magnifying-glass" href="/guides/global-search"> | ||
Search in all of Flare's events using the Search API. | ||
</Card> | ||
|
||
</CardGroup> | ||
|
||
## API Reference | ||
|
||
<CardGroup cols={2}> | ||
<Card title="Endpoint References" icon="code" href="/api-reference"> | ||
View the full API reference. | ||
</Card> | ||
</CardGroup> |
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
--- | ||
title: "Python SDK" | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters