Pope Tech (1.0)

Download OpenAPI specification:Download

General

API Status

Responses

Response samples

Content type
application/json
{
  • "name": "Pope Tech API",
  • "version": "v1.0",
  • "environment": "production",
  • "maintenance_mode": false
}

Get User Info

header Parameters
Authorization
required
string
Example: Bearer [YOUR-ACCESS-TOKEN]

Your access token

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    }
}

Websites

List Websites

path Parameters
organizationSlug
required
string
query Parameters
group_filter
string

Group Public ID

search
string

Keyword for searching websites by name or URL

zero_pages
boolean

Boolean flag for retrieving websites with 0 pages

zero_scans
boolean

Boolean flag for retrieving websites with 0 scans

sort_by
string
Enum: "allPageCount" "activePageCount" "scanCount" "name" "fullUrl"

Column to sort by

page
integer >= 1
limit
integer [ 0 .. 250 ]
sort_direction
string
Enum: "desc" "asc"
header Parameters
Authorization
required
string
Example: Bearer [YOUR-ACCESS-TOKEN]

Your access token

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ]
}

Create a Website

path Parameters
organizationSlug
required
string
header Parameters
Authorization
required
string
Example: Bearer [YOUR-ACCESS-TOKEN]

Your access token

Request Body schema: application/json
name
string

Name for the website. Defaults to the full_url value

full_url
required
string
skip_url_redirect
boolean

This flag will skip any URL validation. Skipping URL validation may cause unexpected behavior.

notes
string
object (CrawlOptions)
object (ScanOptions)
object or object or object (AuthenticationOptions)
allow_duplicates
boolean
Default: "true"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "full_url": "string",
  • "skip_url_redirect": true,
  • "notes": "string",
  • "crawl_options":
    {
    },
  • "scan_options":
    {