Appearance

List Branch protection rules ​

Endpoint ​

http
GET /unified/ci-cd/branch-protection-rules
Integrations supported
  • Gerrit

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns 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.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_key_by
string

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.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
project_id
string

The unique identifier for the project

Required in
  • Gerrit

Response Body ​

result
object[]

List of Branch protection rules

id
string
REQUIRED · 

The unique identifier for the protection rule

Supported in
  • Gerrit
name
string

The name or description of the protection rule

Supported in
  • Gerrit
repos
object[]
REQUIRED · 

The repositories this rule applies to

id
string
pattern
string
REQUIRED · 

The branch/ref pattern this rule applies to

Supported in
  • Gerrit
is_active
boolean

Whether this protection rule is currently active

require_owner_approval
boolean

Require approval from designated owners

required_checks
object[]

List of required validations/checks

name
string
context
string
require_up_to_date
boolean
access_restrictions
object

Restrictions on who can write to the branch

is_active
boolean

Whether write restrictions are active

allowed_users
object[]

List of user IDs allowed to write

id
string
allowed_groups
object[]

List of group/team IDs allowed to write

id
string
allowed_roles
object[]

List of role names allowed to write

id
string
integration_restrictions
object

Restrictions on who can integrate/merge changes

is_active
boolean

Whether integration restrictions are active

allowed_users
object[]

List of user IDs allowed to integrate

id
string
allowed_groups
object[]

List of group/team IDs allowed to integrate

id
string
allowed_roles
object[]

List of role names allowed to integrate

id
string
allow_branch_deletion
boolean

Allow the branch to be deleted

created_by
object

User who created this protection rule

id
string
username
string
created_at
string · date-time

When the rule was created

updated_at
string · date-time

When the rule was last updated

remote_data
object

Raw data returned from the remote API call.

next_cursor
string

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.