/v1/status

get https://api.birddogsecurity.com/v1/status

Retrieves the latest scan status, scan run queue status, scanner IP addresses for latest scan run

Responses

Response body

object

recordCount

integer

The total number of records available.

currentPage

integer

The current page number.

totalPages

integer

The total number of pages.

pageLimit

integer

The limit of records per page.

results

array of objects

results

object

customerId

integer

The ID of the customer.

customerName

string

The name of the customer.

latestScan

object

Information about the latest scan.

scanRunQueueStatus

array of objects

Daily scan run queue status counts.

scanRunQueueStatus

object

scanType

string

The type of scan.

dailyComplete

integer

The count of completed scans for the day.

dailyReady

integer

The count of ready scans for the day.

dailyRunning

integer

The count of running scans for the day.

dailyOther

integer

The count of other scans for the day.

scannersIpAddresses

array of strings

List of external scanner IP addresses.

scannersIpAddresses

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.birddogsecurity.com/v1/status \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A list of customer scan statuses.

500Internal Server Error: Database error occurred.