Skip to content

List scans

GET
/v1/scans
curl --request GET \
--url 'https://api.devsecure.io/v1/scans?limit=50' \
--header 'Authorization: Bearer <token>'

Scan history, newest first.

limit
Limit

Page size (1-200).

integer
default: 50 >= 1 <= 200

Page size (1-200).

cursor
Any of:
string
<= 1024 characters

Opaque cursor from the previous page.

type
Type
Array<string>
default:
Allowed values: code upload dast container pentest cms other
provider
Provider
Array<string>
default:
Allowed values: github gitlab bitbucket
status
Status
Array<string>
default:
Allowed values: queued running completed failed unknown
repository_id
Any of:
string
<= 64 characters
environment
Any of:
string
Allowed values: prod staging dev
created_after
Any of:
string format: date-time

Inclusive, ISO 8601.

created_before
Any of:
string format: date-time

Exclusive, ISO 8601.

OK.

Media typeapplication/json
ScanList
object
data
required
Data
Array<object>
Scan
object
id
required
Id
string
type
required
Type
string
Allowed values: code upload dast container pentest cms other
provider
Any of:
string
Allowed values: github gitlab bitbucket
title
Any of:
string
description
Any of:
string
status
required
Status
string
Allowed values: queued running completed failed unknown
error_code
Any of:
string
environment
Any of:
string
Allowed values: prod staging dev
repository
Any of:
ScanRepository
object
id
required
Id
string
provider
required
Provider
string
Allowed values: github gitlab bitbucket container
name
required
Name
string
target
Any of:
string
created_at
Any of:
string
updated_at
Any of:
string
completed_at
Any of:
string
pagination
required
PageInfo
object
next_cursor
required
Any of:
string
has_more
required
Has More
boolean
Example
{
"data": [
{
"id": "1042",
"type": "code",
"provider": "github",
"title": "Nightly scan",
"status": "queued",
"environment": "prod",
"repository": {
"id": "repo_3f9a0c2d4b1e8f7a6c5d4e3f",
"provider": "github",
"name": "acme/payments-api"
}
}
]
}
X-Request-ID
string

Identifies the request; quote it to support.

X-RateLimit-Limit
integer

Requests allowed per window.

X-RateLimit-Remaining
integer

Requests left in the window.

X-RateLimit-Reset
integer

Seconds until the window resets.

X-Has-Next-Page
string
Allowed values: true false

Whether another page follows.

The request is not valid (validation_error, invalid_cursor).

Media typeapplication/json
ErrorEnvelope
object
error
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
request_id
required
Any of:
string
details
Any of:
Array<object>
ErrorDetail
object
field
Any of:
string
message
required
Message
string
Example
{
"error": {
"code": "validation_error",
"message": "The request is not valid.",
"request_id": "req_3f0c2a9d5b6e4f7a8c1d2e3f4a5b6c7d"
}
}
X-Request-ID
string

Identifies the request; quote it to support.

Missing, unknown, expired or revoked credential (invalid_credentials).

Media typeapplication/json
ErrorEnvelope
object
error
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
request_id
required
Any of:
string
details
Any of:
Array<object>
ErrorDetail
object
field
Any of:
string
message
required
Message
string
Example
{
"error": {
"code": "invalid_credentials",
"message": "The credential is missing, invalid, expired or revoked.",
"request_id": "req_3f0c2a9d5b6e4f7a8c1d2e3f4a5b6c7d"
}
}
X-Request-ID
string

Identifies the request; quote it to support.

The credential may not do this (insufficient_scope, permission_denied, plan_not_allowed, quota_exceeded, target_not_authorized).

Media typeapplication/json
ErrorEnvelope
object
error
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
request_id
required
Any of:
string
details
Any of:
Array<object>
ErrorDetail
object
field
Any of:
string
message
required
Message
string
Example
{
"error": {
"code": "insufficient_scope",
"message": "The credential does not have the scope this operation needs.",
"request_id": "req_3f0c2a9d5b6e4f7a8c1d2e3f4a5b6c7d"
}
}
X-Request-ID
string

Identifies the request; quote it to support.

Too many requests (rate_limited).

Media typeapplication/json
ErrorEnvelope
object
error
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
request_id
required
Any of:
string
details
Any of:
Array<object>
ErrorDetail
object
field
Any of:
string
message
required
Message
string
Example
{
"error": {
"code": "rate_limited",
"message": "Too many requests. Retry after the time in Retry-After.",
"request_id": "req_3f0c2a9d5b6e4f7a8c1d2e3f4a5b6c7d"
}
}
X-Request-ID
string

Identifies the request; quote it to support.

X-RateLimit-Limit
integer

Requests allowed per window.

X-RateLimit-Remaining
integer

Requests left in the window.

X-RateLimit-Reset
integer

Seconds until the window resets.

Retry-After
integer

Seconds to wait before retrying.

Unexpected error (internal_error). Quote the request id to support.

Media typeapplication/json
ErrorEnvelope
object
error
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
request_id
required
Any of:
string
details
Any of:
Array<object>
ErrorDetail
object
field
Any of:
string
message
required
Message
string
Example
{
"error": {
"code": "internal_error",
"message": "Something went wrong on our side.",
"request_id": "req_3f0c2a9d5b6e4f7a8c1d2e3f4a5b6c7d"
}
}
X-Request-ID
string

Identifies the request; quote it to support.