List Branch protection rules
/unified/ci-cd/branch-protection-rules
Query Parameters
Refer Specifying query parameters in Truto APIs
The unique identifier for the project
1 supported1 required
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.
Defaults to unified.
unifiedunifiedrawnormalizedstream
By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.
idIgnores the limit query parameter.
Excludes the remote_data attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barResponse Body
The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.
List of Branch protection rules
The unique identifier for the protection rule
1 supported
The branch/ref pattern this rule applies to
1 supported
The repositories this rule applies to
1 property
Restrictions on who can write to the branch
4 properties
List of group/team IDs allowed to write
1 property
List of role names allowed to write
1 property
List of user IDs allowed to write
1 property
Whether write restrictions are active
Allow the branch to be deleted
When the rule was created
User who created this protection rule
2 properties
Restrictions on who can integrate/merge changes
4 properties
List of group/team IDs allowed to integrate
1 property
List of role names allowed to integrate
1 property
List of user IDs allowed to integrate
1 property
Whether integration restrictions are active
Whether this protection rule is currently active
The name or description of the protection rule
1 supported
Raw data returned from the remote API call.
Require approval from designated owners
List of required validations/checks
3 properties
When the rule was last updated
curl -X GET 'https://api.truto.one/unified/ci-cd/branch-protection-rules?integrated_account_id=<integrated_account_id>' \
-H 'Authorization: Bearer <your_api_token>' \
-H 'Content-Type: application/json'const integratedAccountId = '<integrated_account_id>';
const response = await fetch(`https://api.truto.one/unified/ci-cd/branch-protection-rules?integrated_account_id=${integratedAccountId}`, {
method: 'GET',
headers: {
'Authorization': 'Bearer <your_api_token>',
'Content-Type': 'application/json',
},
});
const data = await response.json();
console.log(data);import requests
url = "https://api.truto.one/unified/ci-cd/branch-protection-rules"
headers = {
"Authorization": "Bearer <your_api_token>",
"Content-Type": "application/json",
}
params = {
"integrated_account_id": "<integrated_account_id>"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())import Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.list(
'ci-cd',
'branchprotectionrules',
{ integrated_account_id: '<integrated_account_id>' }
);
console.log(result);import asyncio
from truto_python_sdk import TrutoApi
truto_api = TrutoApi(token="<your_api_token>")
async def main():
async for item in truto_api.unified_api.list(
"ci-cd",
"branchprotectionrules",
{"integrated_account_id": "<integrated_account_id>"}
):
print(item)
asyncio.run(main())