REST-API-Endpunkte für Regeln

Verwende die REST-API, um Regelsätze für ein Unternehmen zu verwalten. Regelsätze steuern, wie Personen mit Repositorys und Code interagieren können.

Get enterprise ruleset history

Get the history of an enterprise ruleset.

Differenzierte Zugriffstoken für "Get enterprise ruleset history"

Dieser Endpunkt funktioniert nicht mit GitHub-App-Benutzerzugriffstoken, GitHub-App-Installationszugriffstoken oder differenzierten persönlichen Zugriffstoken.

Parameter für „Get enterprise ruleset history“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`enterprise` string Erforderlich The slug version of the enterprise name.
`ruleset_id` integer Erforderlich The ID of the ruleset.

Abfrageparameter
Name, type, BESCHREIBUNG
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Standard: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Standard: `1`

HTTP-Antwortstatuscodes für „Get enterprise ruleset history“

Statuscode	BESCHREIBUNG
`200`	OK
`404`	Resource not found
`500`	Internal Error

Codebeispiele für „Get enterprise ruleset history“

Anforderungsbeispiel

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.

Differenzierte Zugriffstoken für "Get enterprise ruleset version"

Dieser Endpunkt funktioniert nicht mit GitHub-App-Benutzerzugriffstoken, GitHub-App-Installationszugriffstoken oder differenzierten persönlichen Zugriffstoken.

Parameter für „Get enterprise ruleset version“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`enterprise` string Erforderlich The slug version of the enterprise name.
`ruleset_id` integer Erforderlich The ID of the ruleset.
`version_id` integer Erforderlich The ID of the version

HTTP-Antwortstatuscodes für „Get enterprise ruleset version“

Statuscode	BESCHREIBUNG
`200`	OK
`404`	Resource not found
`500`	Internal Error

Codebeispiele für „Get enterprise ruleset version“

Anforderungsbeispiel

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"
        }
      ]
    }
  }
]