Get Quality Gate settings API in Test Reporting & Analytics
Use this API to get the Quality Gate settings programmatically and automate workflows.
To learn more about Quality Gate, read further here..
Get Quality Gate settings
Request parameters
Request
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://api-automation.browserstack.com/ext/v1/quality-gates/{normalized-project-name}/settings
-
No parameter required. Substitute ‘{normalized-project-name}’ with your project name.
Response Attributes 200 OK JSON
Response
{
"enabled": true,
"shouldOverrideBuildStatus": true,
"qualityProfiles": [
{
"id": "b7b534ae-8258-4b30-a76d-b4bbac15c74e",
"name": "Browserstack Default Profile", // profile name
"rulesCount": 4,
"enabled": true,
"applicableBuilds": {
"allBuilds": true
},
"isGlobalProfile": true // applicable to all projects or to specific ones
}
]
}
-
enabled Boolean
Denotes whether the Quality Gate is enabled or not.
-
shouldOverrideBuildStatus Boolean
Denotes whether the Quality Gate should override the build status.
-
qualityProfiles Object
▶ SHOW VALUESAn object containing the various Quality Profiles, rules count, applicable builds, and configurations
-
id String
Unique ID of the Quality Profile.
-
name String
Name of the Quality Profile.
-
rules_count Integer
Number of rules in the Quality Profile.
-
applicable_builds Object
▶ SHOW VALUESAn object with information on whether all builds are to be included or not in each status that the Quality Profile is applicable to.
-
allBuilds Boolean
Denotes whether the Quality Profile is applicable to all builds or not.
-
-
isGlobalProfile Boolean
Denotes whether the Quality Profile is a global profile or not.
-
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.