规则的 REST API 终结点 - GitHub Enterprise Server 3.19 Docs

Get enterprise ruleset history

Get the history of an enterprise ruleset.

“Get enterprise ruleset history”的细粒度访问令牌

此终结点不适用于 GitHub 应用程序用户访问令牌、GitHub 应用程序安装访问令牌或细粒度个人访问令牌。

“Get enterprise ruleset history”的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`enterprise` string 必须 The slug version of the enterprise name.
`ruleset_id` integer 必须 The ID of the ruleset.

查询参数
名称, 类型, 说明
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 默认: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 默认: `1`

“Get enterprise ruleset history”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`404`	Resource not found
`500`	Internal Error

“Get enterprise ruleset history”的示例代码

请求示例

get/enterprises/{enterprise}/rulesets/{ruleset_id}/history

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/rulesets/RULESET_ID/history

Response

Status: 200

[
  {
    "version_id": 3,
    "actor": {
      "id": 1,
      "type": "User"
    },
    "updated_at": "2024-010-23T16:29:47Z"
  },
  {
    "version_id": 2,
    "actor": {
      "id": 2,
      "type": "User"
    },
    "updated_at": "2024-09-23T16:29:47Z"
  },
  {
    "version_id": 1,
    "actor": {
      "id": 1,
      "type": "User"
    },
    "updated_at": "2024-08-23T16:29:47Z"
  }
]

Get enterprise ruleset version

Get a version of an enterprise ruleset.

“Get enterprise ruleset version”的细粒度访问令牌

此终结点不适用于 GitHub 应用程序用户访问令牌、GitHub 应用程序安装访问令牌或细粒度个人访问令牌。

“Get enterprise ruleset version”的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`enterprise` string 必须 The slug version of the enterprise name.
`ruleset_id` integer 必须 The ID of the ruleset.
`version_id` integer 必须 The ID of the version

“Get enterprise ruleset version”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`404`	Resource not found
`500`	Internal Error

“Get enterprise ruleset version”的示例代码

请求示例

get/enterprises/{enterprise}/rulesets/{ruleset_id}/history/{version_id}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/rulesets/RULESET_ID/history/VERSION_ID

Response

Status: 200

[
  {
    "version_id": 3,
    "actor": {
      "id": 1,
      "type": "User"
    },
    "updated_at": "2024-010-23T16:29:47Z",
    "state": {
      "id": 21,
      "name": "super cool ruleset",
      "target": "repository",
      "source_type": "Enterprise",
      "source": "my-enterprise",
      "enforcement": "active",
      "conditions": {
        "organization_name": {
          "include": [
            "important_organization"
          ]
        },
        "repository_name": {
          "include": [
            "~ALL"
          ]
        }
      },
      "rules": [
        {
          "type": "repository_delete"
        }
      ]
    }
  }
]