feat(developer): rewrite API quickstart as a Getting Started guide#2962
Open
StephKll3c wants to merge 4 commits into
Open
feat(developer): rewrite API quickstart as a Getting Started guide#2962StephKll3c wants to merge 4 commits into
StephKll3c wants to merge 4 commits into
Conversation
Replace the dense reference-style quickstart with a step-by-step guide covering API key creation, a first API call, region selection, and common error codes. Remove advanced content (pagination, Python scripts, event search) that does not belong in a Getting Started page.
Add a tutorials index page with Material grid cards linking to three step-by-step guides: filtering rules (GET), creating a SIGMA rule (POST), and searching events (async job workflow). Update mkdocs.yml nav accordingly.
|
Newest code from StephKll3c has been published to preview environment 🚀 Latest deployment was built on 2026-04-30 08:38:47 (8c9808f8271eb66872440b9d6d9b66a3a4af24d8). |
…steps Move base URL step before the first API call to avoid region confusion. Use an environment variable in the curl example. Replace the vague 'Next steps' with direct links to the tutorials section.
| | `enabled` | Whether the rule is active | `true` | | ||
|
|
||
| ## Create the rule | ||
|
|
Contributor
There was a problem hiding this comment.
Write a short intro and/or steps to let the user know how to use this.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
GET /v1/me), region selection, and common error codes (401/403/429)