Get All Whitelist Rules

SCA API 2.0

Request

Retrieves all of the whitelist rules of an organization. Whitelisted libraries are pre-approved by the organization so no policy alerts will be created for them, and they will be ignored by all organizational policies

Security

bearer-key

Path

orgTokenstringrequired

org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: Integrate tab > API Key).

Query

pageSizestring, <= 10000

Enter the number of items to return in each page of the result.

Default:"50"

pagestring

Default:"0"

GET

/api/v2.0/orgs/{orgToken}/settings/whiteList

curl -i -X GET \
  'https://api-saas.mend.io/api/v2.0/orgs/{orgToken}/settings/whiteList?pageSize=50&page=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

additionalDataobject(Provides insights into endpoint-supported pagination information.)

totalItems: The total count of data points returned in an API response.
isLastPage: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.

Example:

{
  "totalItems": "422",
  "isLastPage": "true"
}

supportTokenstring(Support Token)

Example:"1171c60d"

retValArray of objects(WhiteListRuleDTO)

Response

{
  "additionalData": {
    "totalItems": "422",
    "isLastPage": "true"
  },
  "supportToken": "1171c60d",
  "retVal": [
    { … }
  ]
}