Welcome to SafeBreach API Documentation

Sections

Create new custom method

Header Parameters

Content-Typestring
Acceptstring
x-apitokenstring

Path Parameters

accountIdstring

The account ID of the organization

Body Parameters

nametext

Method name

descriptiontext

Method description

methodTypetext

The type of the method, (0 - exfiltration, 1 - lateral, 2 - infiltration, 5 - hostlevel)

classtext

The class of the method, ( pcap | python )

isDestProxyEnabledtext

Indicates whether the method support getting destination proxy details and will use them for the simulation. settings this to true will make the simulation to run for each proxy in addition to no proxy

isSourceProxyEnabledtext

Indicates whether the method support getting source proxy details and will use them for the simulation. settings this to true will make the simulation to run for each proxy in addition to no proxy

timeouttext

Custom attack timeout in seconds.

isAttackerImpersonateEnabledtext

Indicates whether the method should run with lower privileged users in addition to super user.

isTargetImpersonateEnabledtext

Indicates whether the method should run with lower privileged users in addition to super user.

isAttackerRunAsRootEnabledtext

Whether the attacker node may run as root. Defaults to true when omitted. If false, attacker impersonation must be enabled.

isTargetRunAsRootEnabledtext

Whether the target node may run as root. Defaults to true when omitted. If false, target impersonation must be enabled.

statustext

draft/published

publishedDatetext

Date when the move was published

attackerConstraintstext

JSON stringified attacker constraint

targetConstraintstext

Json stringified target constraints.

metaDatatext

Json stringified move metadata.

pcapFilefile

Pcap replay file.

attackerFilefile

Python attacker script.

targetFilefile

Python target script.

parameterstext

Json stringified move parameters.

tagstext

Json stringified move tags.

fixSuggestionstext

Json stringified move fixSuggestions.

sourcetext

The source identifier for the move. For Atomic Red Team imports, this is the auto_generated_guid. Defaults to empty string for standard Breach Studio methods.

Response

201
Object

Response Attributes

dataobject

Show child attributes

500
Object

Response Attributes

codestring
messagestring
fieldsstring
Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot