# ApyGuard

> Documentation for ApyGuard — the API security platform for rate limiting, authentication enforcement, and real-time threat detection.

## Docs

- [Alerts & Notifications](https://docs.apyguard.com/alerts-and-notifications.md): Use alerts and notifications in ApyGuard to stay aware of important scan activity and security findings.
- [API Collections](https://docs.apyguard.com/api-collections.md): Organize imported API specifications and collections in ApyGuard so scanning, authentication, and endpoint selection stay structured.
- [API Security Dashboard](https://docs.apyguard.com/api-security-dashboard.md): Use the ApyGuard dashboard to track security posture, findings, and scan activity across API environments.
- [Assets](https://docs.apyguard.com/assets.md): Learn how assets organize API environments in ApyGuard and act as the foundation for collections, authentication, scanning, and results.
- [Authentication Issues](https://docs.apyguard.com/authentication-issues.md): Resolve common authentication setup problems in ApyGuard, including token issues, login misconfiguration, and OIDC or OAuth2 errors.
- [Authorization Matrix](https://docs.apyguard.com/authorization-matrix.md): Use the authorization matrix in ApyGuard to define expected access behavior for roles and endpoints.
- [Authorization Settings](https://docs.apyguard.com/authorization-settings.md): Create and manage authorization settings in ApyGuard to control how scans authenticate and evaluate protected API behavior.
- [Collection Import Issues](https://docs.apyguard.com/collection-import-issues.md): Troubleshoot problems when importing API specifications or collections into ApyGuard.
- [Common Issues](https://docs.apyguard.com/common-issues.md)
- [Compliance Reporting](https://docs.apyguard.com/compliance-reporting.md): Use ApyGuard reporting outputs to support security reviews, audit preparation, and compliance-focused API risk tracking.
- [Create Your First Asset](https://docs.apyguard.com/create-asset.md)
- [Credentials](https://docs.apyguard.com/credentials.md): Manage API credentials in ApyGuard for token-based, login-based, OIDC, and OAuth2 authentication workflows.
- [GitHub Actions](https://docs.apyguard.com/github-actions.md): Use GitHub Actions with ApyGuard to align API security scanning with engineering delivery workflows.
- [Import an API Collection](https://docs.apyguard.com/import-api-collection.md): Import your API specification or collection into ApyGuard so endpoints can be organized, scanned, and monitored effectively.
- [ApyGuard: API Security Platform for Modern Teams](https://docs.apyguard.com/introduction.md): ApyGuard is an API security and posture management platform that helps teams discover, assess, and continuously monitor API risk across their environments. It connects to API assets and collections, analyzes authentication and exposure, runs security scans, and helps identify vulnerabilities, sensit…
- [Jira](https://docs.apyguard.com/jira.md): Use Jira with ApyGuard to route API security findings into issue tracking and remediation workflows.
- [Login URL](https://docs.apyguard.com/login-url.md): Configure a login endpoint in ApyGuard so the platform can authenticate dynamically and retrieve tokens during scanning.
- [OAuth2 Client Credentials](https://docs.apyguard.com/oauth2-client-credentials.md): Configure machine-to-machine OAuth2 authentication in ApyGuard using client ID, client secret, and scopes.
- [OAuth2 Password](https://docs.apyguard.com/oauth2-password.md): Configure OAuth2 Password authentication in ApyGuard for providers that support the resource owner password credentials grant.
- [OIDC](https://docs.apyguard.com/oidc.md): Configure OpenID Connect authentication in ApyGuard using detected provider metadata and an OIDC credential record.
- [Authentication Setup](https://docs.apyguard.com/overview.md): Configure authentication in ApyGuard so scans can test protected endpoints accurately using token, login-based, OIDC, and OAuth2 flows.
- [Findings & Results Overview](https://docs.apyguard.com/overview-1.md): Understand how ApyGuard organizes findings, risk context, and remediation information after an API security scan.
- [Integrations Overview](https://docs.apyguard.com/overview-2.md): Connect ApyGuard with delivery, issue tracking, and API tooling to bring security workflows into existing team processes.
- [Postman](https://docs.apyguard.com/postman.md): Use Postman collections with ApyGuard to import API definitions and keep testing workflows aligned with API structure.
- [Posture Tracking](https://docs.apyguard.com/posture-tracking.md): Track changes in API security posture over time with repeated scans and organized findings in ApyGuard.
- [Predefined Token](https://docs.apyguard.com/predefined-token.md): Use an existing API key, bearer token, or similar credential in ApyGuard for protected endpoint testing.
- [Profile & Account Settings](https://docs.apyguard.com/profile-and-account-settings.md): Manage personal account preferences and workspace-related settings in ApyGuard.
- [Quick Start](https://docs.apyguard.com/quickstart.md): Create your first asset, import an API collection, configure authentication, and run your first API security scan with ApyGuard.
- [Risk Scores](https://docs.apyguard.com/risk-scores.md): Understand how risk scores in ApyGuard help teams prioritize API security findings.
- [Roles & Permissions](https://docs.apyguard.com/roles-and-permissions.md): Understand how roles and permissions in ApyGuard help teams balance collaboration with controlled access.
- [Security Scanning](https://docs.apyguard.com/run-your-first-security-scan.md)
- [Scan History](https://docs.apyguard.com/scan-history.md): Review previous scan runs in ApyGuard to understand what changed, when it changed, and where follow-up is needed.
- [Scan Issues](https://docs.apyguard.com/scan-issues.md): Troubleshoot common scan execution problems in ApyGuard, including scope, authentication, endpoint, and environment-related issues.
- [Scheduled Scan Tasks](https://docs.apyguard.com/scheduled-scan-tasks.md): Use scheduled scan tasks in ApyGuard to automate recurring API security checks and monitor changes over time.
- [Sensitive Data Findings](https://docs.apyguard.com/sensitive-data-findings.md): Understand sensitive data findings in ApyGuard and use them to reduce exposure risk across API responses.
- [Slack](https://docs.apyguard.com/slack.md): Use Slack with ApyGuard to improve visibility and collaboration around API security findings and updates.
- [Team Management](https://docs.apyguard.com/team-management.md): Manage team access and collaboration in ApyGuard so the right people can own assets, findings, and remediation workflows.
- [Authentication Issues](https://docs.apyguard.com/troubleshooting-authentication.md): Resolve common authentication setup problems in ApyGuard, including token issues, login misconfiguration, and OIDC or OAuth2 errors.
- [Understanding Results](https://docs.apyguard.com/understanding-results.md): Review ApyGuard findings, risk scores, and supporting context so your team can investigate and remediate API security issues effectively.
- [Vulnerabilities](https://docs.apyguard.com/vulnerabilities.md): Review vulnerability findings in ApyGuard and understand how to investigate and prioritize them.

## Optional

- [Home](https://apyguard.mintlify.app/)