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
get
GET /api/ListBreachesAccount?account=text HTTP/1.1
Host: 
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
get
GET /api/ListBreachesTenant HTTP/1.1
Host: 
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
get
GET /api/ExecBreachSearch?tenantFilter=text HTTP/1.1
Host: 
Accept: */*
{
  "Results": {}
}

List Extensions Configuration

get

Retrieves the configuration for extensions

Responses
200
Extensions configuration retrieved successfully
application/json
get
GET /api/ListExtensionsConfig HTTP/1.1
Host: 
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
get
GET /api/ExecGitHubAction?Action=GetBranches HTTP/1.1
Host: 
Accept: */*
{
  "Results": [
    {}
  ]
}

Execute GitHub Action (POST)

post

Executes a GitHub action with POST method

Body
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
post
POST /api/ExecGitHubAction HTTP/1.1
Host: 
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
get
GET /api/ListCommunityRepos HTTP/1.1
Host: 
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
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
post
POST /api/ExecCommunityRepo HTTP/1.1
Host: 
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
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
post
POST /api/AddScheduledItem HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 149

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

Last updated

Was this helpful?