ESescape
Profiles

List profiles

List and search profiles of the organization.

get/profiles

Request

  • Base URL
    https://public.escape.tech/v3
  • Auth
    API key in header X-ESCAPE-API-KEY

Query parameters

cursorstring

The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned.

Example:R1BDOlM6NTEwMzk4NTYtNGIyOS00NTlkLTg0ZDYtMWJhYjM0NWMzZjU5
sizeinteger

The number of items to return per page

Example:50
sortType'LAST_SCAN' | 'NAME' | 'SCORE' | 'SEVERITY'

The type to sort by

sortDirection'asc' | 'desc'

The direction to sort by

searchstring

Search term to filter profiles by name or description

Example:profile1
string
OR
string[]
string
OR
string[]
assetTypesstring[]

Filter by asset types

assetStatusesstring[]

Filter by asset statuses

string
OR
string[]
string
OR
string[]
string
OR
string[]
string
OR
string[]
string
OR
string[]
string
OR
string[]
initiatorsstring[]

Filter by initiator

kindsstring[]

Filter by kind

lastScanStatusesstring[]

Filter by last scan statuses

risksstring[]

Filter by risk

problemCodesstring[]

Filter by problem codes

problemSeveritiesstring[]

Filter by problem severities

noProjects'true' | 'false'

Filter by profiles with no projects

Example:true
noTags'true' | 'false'

Filter by profiles with no tags

Example:true
dnfstring

Filter by DNF expression

Response

OK

nextCursorstring nullable required
totalCountinteger

Example response

{
  "totalCount": 20,
  "data": [
    {
      "maxDurationMinutes": 240
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.