---
title: "getBranchRestriction"
canonical: "https://support.appfire.com/space/SCLI/73371627/getBranchRestriction"
format: markdown
---
See also: [Actions](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73368507)

> Macro (details)
> 
> | **Description** | Get branch level restriction by id or with specific restriction, matching type, and branch value. Restriction defaults to read-only. Restriction applies to branches matching by branch name, pattern, or model. Default is matching on branch name. |
> | --- | --- |
> | **Required Parameters** | [project](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73368805), [repository](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73368867), ([id](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73370775) or [branch](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73370663)) |
> | **Optional Parameters** | [restriction](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73371487), [matchingType](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73370597), [outputType](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73368777), [file](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73370741), [append](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73370891), [encoding](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73368755) |
> | **Type** | [Get](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73370540/Action+Types#ActionTypes-Get) |
> | **Category** | [Branches](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73371318/Action+Categories#ActionCategories-Branches) |
> | **Output Formats** |  |
> | **Replacement Variables** |  |
> | **Hosting** | server,datacenter |
> | **Since Version** |  |
> | **Examples** | [getBranchRestriction](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73371753/Examples#Examples-getBranchRestriction) |

## Related How To's

> Macro (cql-query)