runner-groups-enterprise

APIs.ioEngineeringPlatform

Properties

Name Type Description
id number
name string
visibility string
default boolean
selected_organizations_url string
runners_url string
allows_public_repositories boolean
workflow_restrictions_read_only boolean If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.
restricted_to_workflows boolean If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.
selected_workflows array List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-runner-groups-enterprise-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/runner-groups-enterprise",
  "title": "runner-groups-enterprise",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "visibility": {
      "type": "string"
    },
    "default": {
      "type": "boolean"
    },
    "selected_organizations_url": {
      "type": "string"
    },
    "runners_url": {
      "type": "string"
    },
    "allows_public_repositories": {
      "type": "boolean"
    },
    "workflow_restrictions_read_only": {
      "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.",
      "type": "boolean",
      "default": false
    },
    "restricted_to_workflows": {
      "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.",
      "type": "boolean",
      "default": false
    },
    "selected_workflows": {
      "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.",
      "type": "array",
      "items": {
        "type": "string",
        "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.",
        "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main"
      }
    }
  },
  "required": [
    "id",
    "name",
    "visibility",
    "allows_public_repositories",
    "default",
    "runners_url"
  ]
}