Skip to main content

👋 Welcome to the Escape documentation!

Welcome to the official documentation for Escape, your comprehensive resource for discovering and securing all the APIs within your organization. Whether you're new to Escape or looking to enhance your existing implementation, our documentation is designed to guide you through every step of the process. This includes everything from initial setup and advanced configuration to alerting and integrations.

🤓 Can't wait to start using Escape?

Jump straight into the action with our Quick Start! Alternatively, if you prefer live demonstrations, you can request a live demo with our CEO!

Understanding Escape​

Escape is engineered to assist organizations in two fundamental ways: Discovering (Inventory) and Securing (Testing) APIs. Our platform is split into two main sections:

  • Inventory: Explore and catalog all your APIs, both internal and external. This section helps you gain visibility into your API landscape, identifying everything from mainstream to shadow and legacy APIs without requiring traffic monitoring or agents.
  • Testing: Focus on securing your APIs by detecting and mitigating vulnerabilities. Escape supports extensive testing capabilities for GraphQL and REST applications, allowing you to find and fix security weaknesses during your development process.

Escape operates outside of your stack, ensuring compatibility with all GraphQL and REST implementations and providing a Read-Only mode that is safe for production environments. This external operation means there is no downtime for your applications, safeguarding both your operations and your customers.

Join the Escape Community​

Escape is more than just a tool; it's a community-driven project where members actively contribute to the platform’s development and share valuable resources.

🤓 Want to join the community?

Engage with us and other users on GitHub or our Slack channel to discuss features, best practices, and innovative ways to use Escape. Keep up with the latest news and updates by following us on Twitter and checking out our blog.

Support​

For any issues or questions, start by reaching out on our Slack channel, where both the Escape community and core developers are ready to assist. For more direct support, you can also contact us via email support or through the Crisp Chat feature at the bottom right of the app.