Pope Tech (1.0)

Download OpenAPI specification:Download

URL: https://pope.tech/contact Terms of Service

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": 
{"public_id": "3197ee89-c401-4d07-9031-5717ff97d536",
"first_name": "",
"last_name": "",
"name": "Gordon Thompson",
"email": "gordon.thompson@example.com",
"is_shibboleth": 0,
"shibboleth_unique_identifier": null,
"reset_password": 0,
"created_at": "2020-07-01T17:00:33.000000Z",
"updated_at": "2020-08-04T16:50:48.000000Z",
"last_seen_at": "2020-08-04T16:50:48.255231Z",
"organizations": 
{"org-1": 
{"public_id": "773cf941-1cb4-47b5-96b9-49dcbc44af51",
"name": "Org 1",
"slug": "org-1",
"state": "UT",
"limit_scans": 0,
"limit_crawls": 0,
"limit_pages": 1,
"scan_limit": 5000,
"crawl_limit": 5000,
"active_page_limit": 1000,
"min_active_pages": 5,
"status": "active",
"status_message": null,
"cancelled_at": null,
"created_at": "2020-05-29T21:43:01.000000Z",
"updated_at": "2020-08-04T16:14:47.000000Z",
"permissions": 
[
{"name": "Manage Groups",
"key": "organization:groups:manage",
"type": "organization"
},
{"name": "Manage Roles",
"key": "organization:roles:manage",
"type": "organization"
},
{"name": "Manage Scans",
"key": "organization:scans:manage",
"type": "organization"
},
{"name": "Manage Settings",
"key": "organization:settings:manage",
"type": "organization"
},
{"name": "Manage Users",
"key": "organization:users:manage",
"type": "organization"
},
{"name": "Manage Websites",
"key": "organization:websites:manage",
"type": "organization"
},
{"name": "View Organization",
"key": "organization:view",
"type": "organization"
}
],
"role": "Role 1",
"group": 
{"public_id": "d59b46ef-15e6-4041-86c1-7551ec96e63c",
"name": "Group 1",
"created_at": "2020-05-29T21:43:01.000000Z",
"updated_at": "2020-05-29T21:43:01.000000Z"
}
}
},
"token_metadata": null,
"settings": 
[
{"key": "visible_table_columns",
"value": "{\"dashboard-scan-details\":[{\"property\":\"Name\",\"visible\":true},{\"property\":\"Errors\",\"visible\":true},{\"property\":\"Contrast\",\"visible\":true},{\"property\":\"Alerts\",\"visible\":true},{\"property\":\"Pages\",\"visible\":true},{\"property\":\"Details\",\"visible\":true}],\"scan-crawlers\":[{\"property\":\"Website\",\"visible\":true},{\"property\":\"Pages Found\",\"visible\":false},{\"property\":\"Pages Added\",\"visible\":true},{\"property\":\"Last Updated\",\"visible\":true},{\"property\":\"Status\",\"visible\":false},{\"property\":\"Website Details\",\"visible\":true}]}",
"is_encrypted": 0,
"created_at": "2020-07-01T17:01:23.000000Z",
"updated_at": "2020-07-01T17:01:26.000000Z"
}
]
}
}

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": 
[
{"public_id": "e7d1b0bb-23fe-405b-a973-425814834da7",
"name": "https://www.pope.tech",
"full_url": "https://www.pope.tech",
"notes": null,
"hostname": "www.pope.tech",
"protocol": "https",
"scan_count": "27",
"all_pages_count": "51",
"active_pages_count": "6",
"group_id": "b4f0ac96-ad5e-4fc8-b2f0-bdcbaaa51328",
"group_name": "Group 2"
},
{"public_id": "e845a39f-54f5-4f46-a332-920e9743cf15",
"name": "http://sample-one.test",
"full_url": "http://sample-one.test",
"notes": null,
"hostname": "sample-one.test",
"protocol": "http",
"scan_count": "52",
"all_pages_count": "5",
"active_pages_count": "5",
"group_id": "99272a0c-dc2c-48e9-b369-f7402bbdf177",
"group_name": "Group 1"
}
]
}

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

Payload

Content type

application/json


{"name": "string",
"full_url": "string",
"skip_url_redirect": true,
"notes": "string",
"crawl_options": 
{"filters": 
[
{"path": "string",
"type": "whitelist"
}
],
"manual_rate_limit": "string",
"max_depth": "string",
"max_pages": "string",
"rate_limit": "low",
"start_url": "string",
"subdomains": true,
"use_manual_rate_limit": true,
"use_sitemap": true,
"sitemap_location": "string",
"use_robots": true,
"arhive_pages_not_found": true
},
"scan_options": 
{"evaluation_delay": 0,
"manual_rate_limit": 0,</