Sign in

v2

latestOpenAPI 3.0.1private2026-07-2667209320.4 KB
Repositories

Repository Sensitive Data

List Repo Sensitive Data

List sensitive data MatchWords for the given organization and repository.

Usage:

Results are paginated via the previous and next page keys. To get additional pages, use the nextPageKey or previousPageKey from the response and send back in as the page query param. When the page parameter is provided, all other query parameters are ignored.

Additional Parameters:

  • sortField - the field to sort the MatchWords by. matchTerm matchPattern and codeType
  • sortDir - direction to sort. ASC DESC
  • pageSize- number of results to return.
  • pageToken - zero-based index of the page to return.
  • categories - comma separated list of named filters to apply.
  • query - fuzzy filter MatchWords by matched term.

Requires read:repository permission.

get/api/v1/org/{orgId}/repo/{repoId}/sensitive/list

Path parameters

repoIdstring uuid required

UUID identifier for this StackHawk Repository.

orgIdstring uuid required

UUID identifier for this StackHawk Organization.

Query parameters

sortField'matchTerm' | 'matchPattern' | 'codeType' | 'score'

Resource field to sort paginated response by.

sortDir'ASC' | 'DESC' | 'UNSORTED'

Paginated results are sorted 'asc' or 'desc'.

pagestring

Pagination page key.

pageSizeinteger

Pagination response size limit.

pageTokeninteger

Pagination request page increment.

categoriesstring[]

A comma-delimited list of Sensitive data type categories.

querystring

A term used to filter results based on matching content in one or more fields.

Response

OK

hasNextboolean

Whether or not there is a next page.

hasPrevboolean
nextPageTokenstring
prevPageTokenstring
totalCountinteger

PageToken to provide for the next page of results.