Welcome to SafeBreach API Documentation

Sections

Return simulator list

Header Parameters

Acceptstring
x-apitokenstring

Query Parameters

idsstring

An array of ids to filter by.

detailsstring

Should the response include details per node, or only name and id. Default is false.

deletedstring

Should the response include deleted nodes. Default is false.

secretstring

Should response include the account secret. Default is false.

hostnamestring

Filter nodes by hostname. Default is empty.

connectionTypestring

Filter nodes by connection type. Default is empty.

connectionUrlstring

Filter nodes by connection url. Default is empty.

namestring

Filter nodes by name. Default is empty.

includeProxiesstring

Should response include associated proxies. Default is false.

proxyIdsstring

An array of proxy ids to filter by.

externalIpstring

Filter nodes by externalIP. Default is empty.

internalIpstring

Filter nodes by externalIP. Default is empty.

assetsIdsstring

An array of asset ids to filter by.

versionsstring

A list of version to filter by. The elements needs to be separated by pipes (|)

osstring

A list of OS to filter by. The elements needs to be separated by pipes (|)

rolesstring

A list of roles to filter by. The elements needs to be separated by pipes (|)

usersIdsstring

A list of impersonateUsers to filter by. The elements needs to be separated by pipes (|)

advancedActionIdsstring

A list of advanced actions to filter by. The elements needs to be separated by pipes (|)

deploymentIdsstring

A list of deployment ids to filter by. The elements needs to be separated by pipes (|)

isEnabledstring

Filter nodes by isEnabled. Default is empty.

isConnectedstring

Filter nodes by isConnected. Default is empty.

statusstring

Filter nodes by status.

isCriticalstring

Filter nodes by isCritical. Default is empty.

isExfiltrationstring

Filter nodes by isExfiltration. Default is empty.

isInfiltrationstring

Filter nodes by isInfiltration. Default is empty.

isPreExecutorstring

Filter nodes by isPreExecutor. Default is empty.

isAWSAttackerstring

Filter nodes by isAWSAttacker. Default is empty.

isAzureAttackerstring

Filter nodes by isAzureAttacker. Default is empty.

isGCPAttackerstring

Filter nodes by isGCPAttacker. Default is empty.

isWebApplicationAttackerstring

Filter nodes by isWebApplicationAttacker. Default is empty.

isAWSBedrockAttackerstring

Filter nodes by isAWSBedrockAttacker. Default is empty.

assetsstring

Should the response include assets per node. Default is false.

startRowstring

Start row index to bring result . Default is 0.

pageSizestring

The size of the bulk. Default is bring all records

sortColumnstring

The name of the field to order by.

sortDirectionstring

The field sort direction when sending page size. Default is asc.

impersonatedUsersstring

Should the response include impersonated users per node. Default is false.

advancedActionsstring

Should the response include Advanced Actions per node.

deploymentsstring

Should the response include deployments per node.

additionalDatastring

Should the response include additional configuration data. If the configuration data contains secrets, include secret will be used to decide wether to retrieve it or not. Default is false

attributesstring

Optional list of attributes to return.

Path Parameters

accountIdstring

The account ID of the organization

Response

200
Object

Response Attributes

dataarray

Show child attributes

500
Object

Response Attributes

codestring
messagestring
fieldsstring
Was this section helpful?

GET

/

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