August Product Updates: Enhancements to the Escape Public API and CLI, and the Introduction of Global Configuration Management

August is usually synonymous with vacations, beach days, and relaxation. But here at Escape, we’re not taking a break from empowering security teams (just kidding, we still took a break, but we shipped more efficiently!). While many are winding down, we’re cranking up the pace with some exciting product updates that will make it easier for you to reduce your organization's risk and streamline your workflows.

This month, we’re giving you the ability to modify configurations at the global level, enhanced visibility for API schemas in Assets, and key updates to the Escape Public API and CLI. Let’s dive into the details.

Escape Public API – v3 is Live!

First on the menu, we are excited to announce the release of the third version of the Escape Public API. This update reflects our current platform structure, following the introduction of Attack Surface Management (ASM). v3 brings improvements to alignment with the platform’s data organization, streamlining integrations, enhancing performance, and offering more flexibility for your security team.

What’s new in V3?

With the release of v3, we’ve focused on optimizing your workflow while maintaining backward compatibility with the previous version.

Here’s a breakdown of the most significant changes:

1. Authentication Now Supports a Dedicated API key header

• v2: Authentication was handled via the Authorization header: Authorization: Key YOUR_API_KEY
• v3: We now also support using a dedicated X-ESCAPE-API-KEY header in addition to the Authorization header.

2.Asset creation and management

• Asset Management: You can now list, search, and manage assets across your organization.
• Asset Details: Easily retrieve and update asset information by ID, including description, framework, owners, status, and tags.
• Asset Creation: Create new assets across multiple types (DNS, IPv4, IPv6, GraphQL, REST, gRPC, Web Apps, Schemas, and more) and integrate with popular platforms (Wiz, Postman, Kubernetes, GitHub, GitLab, and more).
• Asset Deletion: Remove assets by ID when no longer needed.

3.Applications Depreciated – Replaced by Profiles

• Profile Management: Now you can list, search, get, and create different scan profiles for your organization. This new feature allows you to better organize and manage your scanning configurations. Check out the API docs for full details.

4.Issues

• Issue Tracking: List, search, and update issues related to your organization.
• Issue Details: Retrieve specific issue information by ID, and track activities related to each issue.

5.Events

• Event Management: Easily list, search, and retrieve detailed information on events within your organization, providing better visibility and control.

6.Scans

• Scan Management: Trigger, track, and access results for your scans.
• Scan Control: List scans, start new ones, retrieve detailed scan information, cancel scans, or ignore specific scan runs as needed.

7.Tags

• Tagging: List and search tags across your organization, and create new tags to better categorize and manage your assets.

Transitioning from v2 to v3

To ensure a smooth migration from v2 to v3, please follow these steps:

1. Review Endpoint Changes:
   The structure of some endpoints has been adjusted in v3. Be sure to consult the v3 documentation to familiarize yourself with these changes.
2. Update Your API Calls:
   Modify any existing API calls that may reference v2-specific endpoints or parameters. The new v3 structure is streamlined for better performance and flexibility.
3. Thoroughly Test Integrations:
   Given the changes to endpoints and data structures, we highly recommend testing all integrations to ensure everything operates smoothly with the new API.

For detailed information on the new features and changes, check out the following links:

• Public API v2 Documentation
• Public API v3 Documentation

Escape CLI – New Features with Escape Public API v3

We’re also excited to announce that the Escape CLI now fully supports all the new capabilities introduced in Public API v3. This brings enhanced functionality, making it easier for your team to interact with the platform directly from the command line.

What's New in the CLI?

1. Full API v3 Support
   • The CLI now provides full access to all the new features in API v3, ensuring you can manage assets, profiles, issues, events, scans, and more directly from your terminal.
   • This brings a streamlined experience for users already familiar with the API, allowing for a unified interaction between the CLI and the API.
2. Autocompletion Support
   • With the new CLI version, you can now generate autocompletion scripts for your shell (Bash, Zsh, Fish, etc.).
   • This saves time and reduces errors by providing suggestions as you type, improving productivity and helping your team navigate commands more efficiently.
3. Colour-Coded Display
   • For better visibility and organization, the CLI now supports colour coding of various lists (assets, profiles..) when displayed in the terminal.
   • This makes it easier to quickly differentiate between asset and scan types, statuses, and categories, enhancing the overall user experience, especially when managing large datasets.

These updates will improve your team’s workflow, making the CLI more powerful and user-friendly. For more details on how to get started, check out the updated CLI documentation.

Global Configuration for Scan Profiles

Escape now allows you to define global configurations that apply to all your scan profiles, streamlining the setup process across your organization. These configurations can be set at the organizational level, providing consistency and ease of management for repeated scan types.

Key Features of Global Configurations:

1. Apply Defaults Across Scan Profiles
   For example, you can define what custom data types (named scalars) should be internal to your company and should never be exposed by any APIs by default and raise an issue if the scalar is found in a git repository in every scan.
2. Network Configuration: Custom Headers & Timeouts
   On the network side, you can now define custom headers and timeouts globally. This provides better control over request configurations across your scans.
3. Rate Limiting for APIs
   Rate limiting for APIs is now configurable at the global level. The definition though has changed. Now you need to use the following variables to define the required parameters: max_duration in s
4. Override Settings in Individual Scan Profiles
   For enhanced flexibility, you can override global configurations within specific scan profiles. This means:
   • If you need to set a different request timeout for a particular scan, you can now do so.
   • If you need to block specific routes during a scan, you can now easily blacklist pages (e.g., we’re blocking crawling of the "logout" page by default which you can override, or you can customize avoiding other specific routes).

How to Set Up Global Configurations:

To configure these settings, navigate to your Organization Page > General Settings and open the Global Configuration tab. From there, you can define, adjust, and manage your global scan settings.

Invite Team Members with a Dedicated Link

And last but not least, admins can now invite teammates to their organization using a dedicated invite link, making onboarding faster and more flexible.

How it works:

1. Go to Team Settings 
2. Enter the email of your new team member and click “Invite”
3. Once added, click the member's name in the team list
4. Click “Copy Invite Link” from their profile

Share the link directly—your teammate can join the organization with one click.

This makes it easier to onboard team members, especially in async or distributed environments.

To wrap things up, while August is typically a time for relaxation, we’ve been busy at Escape getting ready for the fall and the back-to-school rush. We’ve rolled out some exciting updates to the Escape Public API, CLI, and Global Configuration Management to help you streamline your security workflows and reduce risk. As the pace picks up and teams dive back into action, we’re here to make your processes more efficient and stress-free ;) We hope these updates set you up for success as we head into the busy season ahead!

💡 Check out more product updates below:

• Meet Escape Copilot: Automate App and Scan Management via MCP
• More Support for Complex Authentication Flows: TOTP MFA and Text-Based CAPTCHA
• From Alert to Action: Escape’s Jira Integration Explained
• Product updates: Automated schema generation