> For the complete documentation index, see [llms.txt](https://docs.ox.security/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/branch.md).

# branch

A repository branch and its monitoring status.

### Examples

```graphql
type Branch {
  name: String
  isMonitored: Boolean
  isDefault: Boolean
  appName: String
  resourceOrgName: String
  commitSha: String
}
```

### Fields

| Field                    | Description                                                   | Supported fields |
| ------------------------ | ------------------------------------------------------------- | ---------------- |
| name `String`            | Branch name                                                   |                  |
| isMonitored `Boolean`    | Indicates if the branch is currently scanned                  |                  |
| isDefault `Boolean`      | Indicates if this is the repository default branch            |                  |
| appName `String`         | Repository name                                               |                  |
| resourceOrgName `String` | Resource org name                                             |                  |
| commitSha `String`       | Branch HEAD commit SHA at last persist (for rename detection) |                  |

### References

#### Fields with this object:

* [{} ConnectorAppBranchResponse.branches](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/connector-app-branch-response.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/branch.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
