Tools
Retrieves a list of breaches for a specific account (email or domain)
Email address or domain name to check for breaches
Breaches retrieved successfully
Bad request
Unauthorized
Internal server error
GET /api/ListBreachesAccount?account=text HTTP/1.1
Host:
Accept: */*
[
{
"Title": "text",
"LogoPath": "text",
"password": "text",
"Description": "text",
"Domain": "text",
"DataClasses": [
"text"
]
}
]
Retrieves a list of breaches for a specific tenant
Tenant ID to filter breaches
Tenant breaches retrieved successfully
Bad request
Unauthorized
Internal server error
GET /api/ListBreachesTenant HTTP/1.1
Host:
Accept: */*
[
{
"email": "text",
"password": "text",
"sources": "text"
}
]
Executes a breach search for a tenant
Tenant ID to search for breaches
Breach search executed successfully
Bad request
Unauthorized
Internal server error
GET /api/ExecBreachSearch?tenantFilter=text HTTP/1.1
Host:
Accept: */*
{
"Results": {}
}
Retrieves the configuration for extensions
Extensions configuration retrieved successfully
Bad request
Unauthorized
Internal server error
GET /api/ListExtensionsConfig HTTP/1.1
Host:
Accept: */*
{
"GitHub": {
"Enabled": true
},
"ANY_ADDITIONAL_PROPERTY": {
"Enabled": true
}
}
Executes a GitHub action with GET method
Action to perform
Full name of the repository (owner/repo)
Branch name
File path
GitHub action executed successfully
Bad request
Unauthorized
Internal server error
GET /api/ExecGitHubAction?Action=GetBranches HTTP/1.1
Host:
Accept: */*
{
"Results": [
{}
]
}
Executes a GitHub action with POST method
Action to perform
Type of repository (user or org)
Repository name
Organization name
Repository description
Whether the repository is private
Repository name for search
User name for search
Search terms
Full name of the repository (owner/repo)
File path
Branch name
GitHub action executed successfully
Bad request
Unauthorized
Internal server error
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": [
{}
]
}
Retrieves a list of community repositories
Community repositories retrieved successfully
Bad request
Unauthorized
Internal server error
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"
}
]
}
Executes an operation on a community repository
Action to perform
Repository ID
Branch name
Full name of the repository (owner/repo)
File path for template import
Community repository operation executed successfully
Bad request
Unauthorized
Internal server error
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": {}
}
Adds a new scheduled item
Whether to disallow duplicate names
Tenant to apply the scheduled item to
Name of the scheduled item
When the job is scheduled to run (Unix timestamp)
Scheduled item added successfully
Bad request
Unauthorized
Internal server error
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?