Sapi support - #23
Open
buixor wants to merge 4 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds first-class support for CrowdSec’s premium Console Service API (SAPI) as a separate skill alongside the existing local/operational crowdsec skill, and updates routing/docs/metadata accordingly.
Changes:
- Introduces a new
crowdsec-service-apiskill with an “act on the user’s behalf” contract and resource-grouped reference docs (auth, blocklists, allowlists, integrations, metrics, decisions). - Updates the existing
crowdsecskill docs to route cloud Service API tasks to the new skill, and adds an API-management pointer from the Console enrollment doc. - Enhances
check-verification.pyto support checking verification coverage for either skill via a--rootargument.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| skills/crowdsec/SKILL.md | Updates the skill boundary table to route Service API usage to the new crowdsec-service-api skill. |
| skills/crowdsec/scripts/check-verification.py | Adds --root to run verification coverage checks against either skill directory; recognizes env: sapi as canonical. |
| skills/crowdsec/references/install/console.md | Adds a short section directing programmatic Console management to the new Service API skill. |
| skills/crowdsec-service-api/SKILL.md | Adds the new SAPI skill router, operating contract (key handling + confirm-before-mutate), and intent-to-reference map. |
| skills/crowdsec-service-api/references/authentication.md | Documents key creation, key resolution, /info validation, and a Python SDK pointer. |
| skills/crowdsec-service-api/references/blocklists.md | Documents blocklist lifecycle, IP operations (add/delete/bulk overwrite), subscribers/shares, and search. |
| skills/crowdsec-service-api/references/allowlists.md | Documents allowlist lifecycle, item operations, and subscriber models (engine/tag/org). |
| skills/crowdsec-service-api/references/integrations.md | Documents creating integrations and pulling vendor-formatted feeds via Basic auth, plus update/delete. |
| skills/crowdsec-service-api/references/metrics.md | Documents read-only remediation ROI metrics via GET /metrics/remediation. |
| skills/crowdsec-service-api/references/decisions.md | Documents org-level decisions, aggregated view, creation, and observed delete caveats. |
| README.md | Updates top-level README to describe both skills and expands coverage/examples for the Service API skill. |
| CLAUDE.md | Extends the repo authoring/contribution conventions to include the new crowdsec-service-api skill layout and verification expectations. |
| .claude-plugin/plugin.json | Registers the new skill directory in the plugin and updates metadata/keywords to include SAPI. |
| .claude-plugin/marketplace.json | Updates marketplace metadata/keywords to reflect the added Service API skill. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | Debug "logs not parsing" / "no alerts" / "bouncer not blocking" | this skill | | ||
| | Migrate from fail2ban | this skill | | ||
| | **Write** a parser, scenario, or WAF (AppSec) rule | out of scope — this skill is operational only | | ||
| | **Write** a parser, scenario, or WAF (AppSec) rule | the `crowdsec-local-mcp` mcp | |
Comment on lines
+29
to
+32
| > **Access:** the `/decisions` group needs a **decision-scoped key**. A key scoped | ||
| > only to blocklist/allowlist management gets `403 {"message":"Forbidden"}` on | ||
| > every call here — an entitlement gap, not a bad request. A blocklist-only key | ||
| > silently fails. |
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
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.
No description provided.