📄️ Available Clients
Python
📄️ Get API Version
Version of the RESTful API can be retrieved by visiting below url:
📄️ Interact with Audits
This API is added since QuickBuild 6.0.6.
📄️ Interact with Configurations
Get child configurations of specified configuration
📄️ Interact with Builds
Access build by build id
📄️ Interact with Latest Builds
This API is provided for the purpose of accessing latest build information of one or more configurations efficiently.
📄️ Interact with Build Requests
Build request object can be used to request new build or cancel running build.
📄️ Trigger Build via GET Request
Build can be triggered by posting build request as described in page Interact with Build Requests. Sometimes it is useful to trigger build via GET request, and here is how:
📄️ Interact with Users
Get all users in the system
📄️ Interact with Groups
Get all groups in the system
📄️ Interact with Group Memberships
Get all memberships in the system
📄️ Interact with Dashboards
Get all dashboards in the system
📄️ Interact with Group Share
Group share is the object used to control dashboard sharing with groups
📄️ Interact with User Share
User share is the object used to control dashboard sharing with users
📄️ Interact with Cloud Profiles
Get all cloud profiles in the system
📄️ Interact with Configuration Authorizations
Get all authorizations in the system
📄️ Interact with Resources
Get all resources in the system
📄️ Interact with Agent Tokens
By operating tokens, one can authorize/unauthorize agents, or access agent details including token value and latest usage information.
📄️ Get System Attributes of Grid Node
System attributes of grid node can be fetched via RESTful call.
📄️ Get and Set User Attributes of Grid Node
User attributes of grid node can be fetched/modified via RESTful API.
📄️ Interact with Reports
For those reports supported by QuickBuild, you can retrieve the report data via RESTful APIs. The supported reports included:
📄️ Interact with Changes
Since QuickBuild 4.0, you can retrieve changes via RESTful APIs. The base URI for changes RESTful APIs is:
📄️ Interact with Issues
Since QuickBuild 4.0, you can retrieve issues via RESTful APIs. The base URI for changes RESTful APIs is:
📄️ Query Build Notifications
Syntax
📄️ Query Grid Measurements
Grid measurements can be fetched from REST API.
📄️ Access Information of Published Files
Syntax
📄️ Interact with Build Agents
Get list of active build agents
📄️ Backup Database
QuickBuild database backup can be taken via RESTful call.
📄️ Pause System
QuickBuild can be paused to prevent builds from running via RESTful call.
📄️ Resume System
QuickBuild can be resumed to allow builds from running via RESTful call.
📄️ Check System Pause Information
Get system pause information including pause reason.
📄️ Retrieve Object Identifier
Most of QuickBuild RESTful API relies on identifier of the object, which can be retrieved with the id service explained here.
📄️ Manage GitHub Webhook
Since QuickBuild 15.0, you can manage GitHub Webhook settings via REST API.
📄️ Manage GitLab Webhook
Since QuickBuild 15.0, you can manage GitLab Webhook settings via REST API.