Products

Access Scan Tool information

Products#ListProducts

List a collection of Scan Tools

Security
Request
query Parameters
page
integer <int64> >= 0
Default: 0

Page number to fetch (starting from 0)

Example: page=4
pageSize
integer <int64> [ 1 .. 100 ]
Default: 30

Number of results per page

Example: pageSize=50
name
string

Resource name

Example: name=NodeGoat
header Parameters
X-Api-Key
string

Harness personal or service access token

Example: Perspiciatis non qui qui dignissimos accusantium maxime.
Responses
200

OK response.

400

BadRequest: Bad Request response.

401

Unauthorized: Unauthorized response.

403

Forbidden: Forbidden response.

404

NotFound: Not Found response.

429

TooManyRequests: Too Many Requests response.

500

InternalServerError: Internal Server Error response.

get/sto/api/v2/products
Request samples
Response samples
application/json
{
  • "pagination": {
    },
  • "results": [
    ]
}

Products#FindProductById

Find Scan Tool by ID

Security
Request
path Parameters
id
required
string^[a-zA-Z0-9_-]{22}$

The ID of the Scan Tool to retrieve

Example: abcdef1234567890ghijkl
header Parameters
X-Api-Key
string

Harness personal or service access token

Example: Distinctio dignissimos voluptas illum.
Responses
200

OK response.

400

BadRequest: Bad Request response.

401

Unauthorized: Unauthorized response.

403

Forbidden: Forbidden response.

404

NotFound: Not Found response.

429

TooManyRequests: Too Many Requests response.

500

InternalServerError: Internal Server Error response.

get/sto/api/v2/products/{id}
Request samples
Response samples
application/json
{
  • "created": 1651578240,
  • "description": "OWASP 5.x SCA scanner",
  • "id": "abcdef1234567890ghijkl",
  • "isEnabled": true,
  • "lastModified": 1651578240,
  • "name": "owasp"
}