Sample - GitHub REST API
GET/repos/{owner}/{repo}/rulesets/{ruleset_id}/history

List repository ruleset history

Lists the historical versions of a repository ruleset. Use page and per_page to paginate the results. Each result identifies the previous version, the actor who updated it, and the update timestamp.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

5 parameters
ownerstringrequired
The account owner of the repository; the name is not case sensitive.
repostringrequired
The repository name without the `.git` extension; the name is not case sensitive.
ruleset_idintegerrequired
The numeric identifier of the ruleset whose history to list.
per_pageintegeroptional
The number of history entries to return per page, up to 100. Defaults to 30 when omitted.
Default:30
pageintegeroptional
The page number to retrieve. Defaults to 1 when omitted.
Default:1

3 status codes
200Returns an array of historical ruleset versions, each containing its version ID, the actor who updated it, and the update timestamp.
version_idintegerrequired
The ID of the previous version of the ruleset
actorobjectrequired
The actor who updated the ruleset
updated_atstringrequired
404Returned when the repository or ruleset does not exist.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
500Returned when an internal server error occurs.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 404 is returned when the repository or ruleset cannot be found. A 500 is returned for an internal error. per_page must not exceed 100, and owner, repo, and ruleset_id must identify the repository ruleset whose history you want to retrieve.