deployment-branch-policy-settings

The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
protected_branches	boolean	Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `cus
custom_branch_policies	boolean	Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/deployment-branch-policy-settings",
  "title": "deployment-branch-policy-settings",
  "type": "object",
  "description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.",
  "properties": {
    "protected_branches": {
      "type": "boolean",
      "description": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`."
    },
    "custom_branch_policies": {
      "type": "boolean",
      "description": "Whether only branches that match the specified name patterns can deploy to this environment.  If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`."
    }
  },
  "nullable": true,
  "required": [
    "protected_branches",
    "custom_branch_policies"
  ]
}