Get a pentest report

GET

/v1/scans/{scan_id}/pentest-report

const url = 'https://api.devsecure.io/v1/scans/example/pentest-report';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.devsecure.io/v1/scans/example/pentest-report \
  --header 'Authorization: Bearer <token>'

Authorizations

ApiKey
pentest:read
OAuth2
pentest:read

Parameters

Path Parameters

scan_id

required

Scan Id

string

Responses

200

OK.

application/json

PentestReport

object

scan_id

required

Scan Id

string

status

required

Status

Pending while the pentest runs; unavailable if it ended without a report.

string

Allowed values: available pending unavailable

format

Format

string

default: markdown

Allowed value: markdown

content

Any of:

string
null

string

Example

{
  "status": "available",
  "format": "markdown"
}

Headers

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.

400

The request is not valid (validation_error, invalid_cursor).

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

request_id

required

Any of:

string
null

string

details

Any of:

Array<object>

ErrorDetail

object

field

Any of:

string
null

string

message

required

Message

string

Example

{
  "error": {
    "code": "validation_error",
    "message": "The request is not valid.",
    "request_id": "req_3f0c2a9d5b6e4f7a8c1d2e3f4a5b6c7d"
  }
}

Headers

X-Request-ID

string

Identifies the request; quote it to support.

401

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

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

request_id

required

Any of:

string
null

string

details

Any of:

Array<object>

ErrorDetail

object

field

Any of:

string
null

string

message

required

Message

string

Example

{
  "error": {
    "code": "invalid_credentials",
    "message": "The credential is missing, invalid, expired or revoked.",
    "request_id": "req_3f0c2a9d5b6e4f7a8c1d2e3f4a5b6c7d"
  }
}

Headers

X-Request-ID

string

Identifies the request; quote it to support.

403

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

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

request_id

required

Any of:

string
null

string

details

Any of:

Array<object>

ErrorDetail

object

field

Any of:

string
null

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"
  }
}

Headers

X-Request-ID

string

Identifies the request; quote it to support.

404

Not found in the credential’s workspace (not_found).

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

request_id

required

Any of:

string
null

string

details

Any of:

Array<object>

ErrorDetail

object

field

Any of:

string
null

string

message

required

Message

string

Example

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "request_id": "req_3f0c2a9d5b6e4f7a8c1d2e3f4a5b6c7d"
  }
}

Headers

X-Request-ID

string

Identifies the request; quote it to support.

429

Too many requests (rate_limited).

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

request_id

required

Any of:

string
null

string

details

Any of:

Array<object>

ErrorDetail

object

field

Any of:

string
null

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"
  }
}

Headers

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.

500

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

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

request_id

required

Any of:

string
null

string

details

Any of:

Array<object>

ErrorDetail

object

field

Any of:

string
null

string

message

required

Message

string

Example

{
  "error": {
    "code": "internal_error",
    "message": "Something went wrong on our side.",
    "request_id": "req_3f0c2a9d5b6e4f7a8c1d2e3f4a5b6c7d"
  }
}

Headers

X-Request-ID

string

Identifies the request; quote it to support.