Welcome to SafeBreach API Documentation

Sections

Welcome to SafeBreach API Documentation

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Welcome to SafeBreach API Documentation

Create a Scenario

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Create a Scenario

Run a Scenario

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Run a Scenario

Get Test Results

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Get Test Results

Create a Custom Attack

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Create a Custom Attack

Environment

Was this section helpful?

What made this section unhelpful for you?

Base URL

Production:

Sandbox:

Language Box

Was this section helpful?

What made this section unhelpful for you?

Simulators

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Simulators

Return simulator list

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Return simulator list

Return simulator details

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Return simulator details

Create new simulator

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Create new simulator

Update simulator

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Update simulator

Delete simulator

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Delete simulator

Return simulator list bulk

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Return simulator list bulk

Return simulator aggregation

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Return simulator aggregation

Return associated users list for simulator

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Return associated users list for simulator

Return associated proxies list for simulator

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Return associated proxies list for simulator

Return associated assets list for simulator

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Return associated assets list for simulator

Associate user with a simulator

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Associate user with a simulator

Associate proxy with simulator

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Associate proxy with simulator

Associate asset with simulator

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Associate asset with simulator

Delete associated proxy with simulator

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Delete associated proxy with simulator

Delete associated impersonated users with simulator

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Delete associated impersonated users with simulator

Delete associated asset from simulator

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Delete associated asset from simulator

Enable advanced action on simulator

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Enable advanced action on simulator

Disable advanced action on simulator

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Disable advanced action on simulator

Return current secret

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Return current secret

Create new random secret

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Create new random secret

Proxies

On this page
  • Proxies

Impersonated Users

On this page
  • Impersonated Users

Advanced Actions

On this page
  • Advanced Actions

Virtual Nodes

On this page
  • Virtual Nodes

Data Assets

On this page
  • Data Assets

Deployments

On this page
  • Deployments

Integrations

On this page
  • Integrations

Attack

On this page
  • Attack

Analyze

On this page
  • Analyze

Mobilize

On this page
  • Mobilize

Settings

On this page
  • Settings

Toolbox

On this page
  • Toolbox
View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot