Skip to content
forgit api docs

Get repository ruleset version

GET
/repos/{owner}/{repo}/rulesets/{ruleset_id}/history/{version_id}

Get a version of a repository ruleset.

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
owner
required
string

The account owner of the repository. The name is not case sensitive.

repo
required
string

The name of the repository without the .git extension. The name is not case sensitive.

ruleset_id
required
integer

The ID of the ruleset.

version_id
required
integer

The ID of the version

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
object
version_id
required

The ID of the previous version of the ruleset

integer
actor
required

The actor who updated the ruleset

object
id
integer
type
string
updated_at
required
string format: date-time
state
required

The state of the ruleset version

object
Examples
Example default 
{
  "version_id": 3,
  "actor": {
    "id": 1,
    "type": "User"
  },
  "updated_at": "2024-10-23T16:29:47Z",
  "state": {
    "id": 42,
    "name": "super cool ruleset",
    "target": "branch",
    "source_type": "Repository",
    "source": "monalisa/my-repo",
    "enforcement": "active",
    "bypass_actors": [
      {
        "actor_id": 234,
        "actor_type": "Team",
        "bypass_mode": "always"
      }
    ],
    "conditions": {
      "ref_name": {
        "include": [
          "refs/heads/main",
          "refs/heads/master"
        ],
        "exclude": [
          "refs/heads/dev*"
        ]
      }
    },
    "rules": [
      {
        "type": "commit_author_email_pattern",
        "parameters": {
          "operator": "contains",
          "pattern": "github"
        }
      }
    ]
  }
}

404

Section titled “ 404 ”

Resource not found

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

500

Section titled “ 500 ”

Internal Error

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}