Tools

List Breaches for Account

get

Retrieves a list of breaches for a specific account (email or domain)

Query parameters

accountstringRequired

Email address or domain name to check for breaches

Responses

200

Breaches retrieved successfully

application/json

TitlestringOptional

Title of the breach

LogoPathstringOptional

Path to the breach logo

passwordstringOptional

Partial password if available

DescriptionstringOptional

Description of the breach

DomainstringOptional

Domain associated with the breach

DataClassesstring[]Optional

Types of data leaked in the breach

400

Bad request

401

Unauthorized

500

Internal server error

get

/ListBreachesAccount

HTTPcURLJavaScriptPython

GET /api/ListBreachesAccount?account=text HTTP/1.1
Accept: */*

[
  {
    "Title": "text",
    "LogoPath": "text",
    "password": "text",
    "Description": "text",
    "Domain": "text",
    "DataClasses": [
      "text"
    ]
  }
]

List Breaches for Tenant

get

Retrieves a list of breaches for a specific tenant

Query parameters

tenantFilterstringOptional

Tenant ID to filter breaches

Responses

200

Tenant breaches retrieved successfully

application/json

emailstringOptional

Email address associated with the breach

passwordstringOptional

Partial password if available

sourcesstringOptional

Sources of the breach data

400

Bad request

401

Unauthorized

500

Internal server error

get

/ListBreachesTenant

HTTPcURLJavaScriptPython

GET /api/ListBreachesTenant HTTP/1.1
Accept: */*

[
  {
    "email": "text",
    "password": "text",
    "sources": "text"
  }
]

Execute Breach Search

get

Executes a breach search for a tenant

Query parameters

tenantFilterstringRequired

Tenant ID to search for breaches

Responses

200

Breach search executed successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

get

/ExecBreachSearch

HTTPcURLJavaScriptPython

GET /api/ExecBreachSearch?tenantFilter=text HTTP/1.1
Accept: */*

{
  "Results": {}
}

List Extensions Configuration

get

Retrieves the configuration for extensions

Responses

200

Extensions configuration retrieved successfully

application/json

400

Bad request

401

Unauthorized

500

Internal server error

get

/ListExtensionsConfig

HTTPcURLJavaScriptPython

GET /api/ListExtensionsConfig HTTP/1.1
Accept: */*

{
  "GitHub": {
    "Enabled": true
  },
  "ANY_ADDITIONAL_PROPERTY": {
    "Enabled": true
  }
}

Execute GitHub Action (GET)

get

Executes a GitHub action with GET method

Query parameters

Actionstring · enumRequired

Action to perform

Possible values:

FullNamestringOptional

Full name of the repository (owner/repo)

BranchstringOptional

Branch name

PathstringOptional

File path

Responses

200

GitHub action executed successfully

application/json

Resultsobject[]Optional

400

Bad request

401

Unauthorized

500

Internal server error

get

/ExecGitHubAction

HTTPcURLJavaScriptPython

GET /api/ExecGitHubAction?Action=GetBranches HTTP/1.1
Accept: */*

{
  "Results": [
    {}
  ]
}

Execute GitHub Action (POST)

post

Executes a GitHub action with POST method

Body

application/json

Actionstring · enumRequired

Action to perform

Possible values:

Typestring · enumOptional

Type of repository (user or org)

Possible values:

NamestringOptional

Repository name

OrgstringOptional

Organization name

DescriptionstringOptional

Repository description

PrivatebooleanOptional

Whether the repository is private

RepositorystringOptional

Repository name for search

UserstringOptional

User name for search

SearchTermstring[]Optional

Search terms

FullNamestringOptional

Full name of the repository (owner/repo)

PathstringOptional

File path

BranchstringOptional

Branch name

Responses

200

GitHub action executed successfully

application/json

Resultsobject[]Optional

400

Bad request

401

Unauthorized

500

Internal server error

post

/ExecGitHubAction

HTTPcURLJavaScriptPython

POST /api/ExecGitHubAction HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 204

{
  "Action": "CreateRepo",
  "Type": "user",
  "Name": "text",
  "Org": "text",
  "Description": "text",
  "Private": true,
  "Repository": "text",
  "User": "text",
  "SearchTerm": [
    "text"
  ],
  "FullName": "text",
  "Path": "text",
  "Branch": "text"
}

{
  "Results": [
    {}
  ]
}

List Community Repositories

get

Retrieves a list of community repositories

Responses

200

Community repositories retrieved successfully

application/json

400

Bad request

401

Unauthorized

500

Internal server error

get

/ListCommunityRepos

HTTPcURLJavaScriptPython

GET /api/ListCommunityRepos HTTP/1.1
Accept: */*

{
  "Results": [
    {
      "Name": "text",
      "Owner": "text",
      "URL": "text",
      "Visibility": "text",
      "WriteAccess": true,
      "UploadBranch": "text",
      "FullName": "text",
      "DefaultBranch": "text"
    }
  ]
}

Execute Community Repository Operation

post

Executes an operation on a community repository

Body

application/json

Actionstring · enumRequired

Action to perform

Possible values:

IdstringOptional

Repository ID

BranchstringOptional

Branch name

FullNamestringOptional

Full name of the repository (owner/repo)

PathstringOptional

File path for template import

Responses

200

Community repository operation executed successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/ExecCommunityRepo

HTTPcURLJavaScriptPython

POST /api/ExecCommunityRepo HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "Action": "Add",
  "Id": "text",
  "Branch": "text",
  "FullName": "text",
  "Path": "text"
}

{
  "Results": {}
}

Add Scheduled Item

post

Adds a new scheduled item

Query parameters

DisallowDuplicateNamebooleanOptional

Whether to disallow duplicate names

Body

application/json

TenantFilterstringOptional

Tenant to apply the scheduled item to

NamestringOptional

Name of the scheduled item

ScheduledTimeintegerOptional

When the job is scheduled to run (Unix timestamp)

Responses

200

Scheduled item added successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/AddScheduledItem

HTTPcURLJavaScriptPython

POST /api/AddScheduledItem HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 149

{
  "TenantFilter": "text",
  "Name": "text",
  "Command": {
    "value": "text"
  },
  "Parameters": {
    "TemplateSettings": {}
  },
  "ScheduledTime": 1,
  "Recurrence": {
    "value": "text"
  }
}

{
  "Results": {}
}