Skip to content

Commit

Permalink
split intro and concepts
Browse files Browse the repository at this point in the history
  • Loading branch information
aviau committed Aug 15, 2024
1 parent c34aee9 commit 15413ba
Show file tree
Hide file tree
Showing 7 changed files with 62 additions and 5 deletions.
File renamed without changes.
File renamed without changes.
49 changes: 49 additions & 0 deletions docs/concepts/getting-started.mdx
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.
3 changes: 3 additions & 0 deletions docs/concepts/sdk.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: "Python SDK"
---
15 changes: 10 additions & 5 deletions docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -80,11 +80,16 @@
{
"group": "Introduction",
"pages": [
"introduction/getting-started",
"introduction/authentication",
"introduction/rate-limits",
"introduction/errors",
"introduction/paging"
"introduction/getting-started"
]
},
{
"group": "Concepts",
"pages": [
"concepts/authentication",
"concepts/rate-limits",
"concepts/errors",
"concepts/paging"
]
},
{
Expand Down

0 comments on commit 15413ba

Please sign in to comment.