--- title: "Update repository preferences for check suites" method: PATCH path: "/repos/{owner}/{repo}/check-suites/preferences" tags: ["checks"] --- # Update repository preferences for check suites `PATCH /repos/{owner}/{repo}/check-suites/preferences` Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. ## Path parameters - `owner` string, required - `repo` string, required ## Request body - object - `auto_trigger_checks` object[] — Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. - `app_id` integer, required — The `id` of the GitHub App. - `setting` boolean, required — Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them. ## Response `200` Response - CheckSuitePreference — Check suite configuration preferences for a repository. - `preferences` object, required - `auto_trigger_checks` object[] - `app_id` integer, required - `setting` boolean, required - `repository` MinimalRepository, required — Minimal Repository - `id` integer, required - `node_id` string, required - `name` string, required - `full_name` string, required - `owner` SimpleUser, required — A GitHub user. - `name` string, nullable - `email` string, nullable - `login` string, required - `id` integer, required - `node_id` string, required - `avatar_url` string, uri, required - `gravatar_id` string, nullable, required - `url` string, uri, required - `html_url` string, uri, required - `followers_url` string, uri, required - `following_url` string, required - `gists_url` string, required - `starred_url` string, required - `subscriptions_url` string, uri, required - `organizations_url` string, uri, required - `repos_url` string, uri, required - `events_url` string, required - `received_events_url` string, uri, required - `type` string, required - `site_admin` boolean, required - `starred_at` string - `user_view_type` string - `private` boolean, required - `html_url` string, uri, required - `description` string, nullable, required - `fork` boolean, required - `url` string, uri, required - `archive_url` string, required - `assignees_url` string, required - `blobs_url` string, required - `branches_url` string, required - `collaborators_url` string, required - `comments_url` string, required - `commits_url` string, required - `compare_url` string, required - `contents_url` string, required - `contributors_url` string, uri, required - `deployments_url` string, uri, required - `downloads_url` string, uri, required - `events_url` string, uri, required - `forks_url` string, uri, required - `git_commits_url` string, required - `git_refs_url` string, required - `git_tags_url` string, required - `git_url` string - `issue_comment_url` string, required - `issue_events_url` string, required - `issues_url` string, required - `keys_url` string, required - `labels_url` string, required - `languages_url` string, uri, required - `merges_url` string, uri, required - `milestones_url` string, required - `notifications_url` string, required - `pulls_url` string, required - `releases_url` string, required - `ssh_url` string - `stargazers_url` string, uri, required - `statuses_url` string, required - `subscribers_url` string, uri, required - `subscription_url` string, uri, required - `tags_url` string, uri, required - `teams_url` string, uri, required - `trees_url` string, required - `clone_url` string - `mirror_url` string, nullable - `hooks_url` string, uri, required - `svn_url` string - `homepage` string, nullable - `language` string, nullable - `forks_count` integer - `stargazers_count` integer - `watchers_count` integer - `size` integer — The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. - `default_branch` string - `open_issues_count` integer - `is_template` boolean - `topics` string[] - `has_issues` boolean - `has_projects` boolean - `has_wiki` boolean - `has_pages` boolean - `has_downloads` boolean - `has_discussions` boolean - `has_pull_requests` boolean - `pull_request_creation_policy` 'all' | 'collaborators_only' — The policy controlling who can create pull requests: all or collaborators_only. - `archived` boolean - `disabled` boolean - `visibility` string - `pushed_at` string, date-time, nullable - `created_at` string, date-time, nullable - `updated_at` string, date-time, nullable - `permissions` object - `admin` boolean - `maintain` boolean - `push` boolean - `triage` boolean - `pull` boolean - `role_name` string - `temp_clone_token` string - `delete_branch_on_merge` boolean - `subscribers_count` integer - `network_count` integer - `code_of_conduct` CodeOfConduct — Code Of Conduct - `key` string, required - `name` string, required - `url` string, uri, required - `body` string - `html_url` string, uri, nullable, required - `license` object, nullable - `key` string - `name` string - `spdx_id` string - `url` string, nullable - `node_id` string - `forks` integer - `open_issues` integer - `watchers` integer - `allow_forking` boolean - `web_commit_signoff_required` boolean - `security_and_analysis` SecurityAndAnalysis, nullable - `advanced_security` object — Enable or disable GitHub Advanced Security for the repository. For standalone Code Scanning or Secret Protection products, this parameter cannot be used. - `status` 'enabled' | 'disabled' - `code_security` object - `status` 'enabled' | 'disabled' - `dependabot_security_updates` object — Enable or disable Dependabot security updates for the repository. - `status` 'enabled' | 'disabled' — The enablement status of Dependabot security updates for the repository. - `secret_scanning` object - `status` 'enabled' | 'disabled' - `secret_scanning_push_protection` object - `status` 'enabled' | 'disabled' - `secret_scanning_non_provider_patterns` object - `status` 'enabled' | 'disabled' - `secret_scanning_ai_detection` object - `status` 'enabled' | 'disabled' - `secret_scanning_delegated_alert_dismissal` object - `status` 'enabled' | 'disabled' - `secret_scanning_delegated_bypass` object - `status` 'enabled' | 'disabled' - `secret_scanning_delegated_bypass_options` object - `reviewers` object[] — The bypass reviewers for secret scanning delegated bypass - `reviewer_id` integer, required — The ID of the team or role selected as a bypass reviewer - `reviewer_type` 'TEAM' | 'ROLE', required — The type of the bypass reviewer - `mode` 'ALWAYS' | 'EXEMPT' — The bypass mode for the reviewer - `custom_properties` object — The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. --- [API](https://skmtc.net/github/apis/rest-api.md) · [All operations](https://skmtc.net/github/apis/rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/github/rest-api/versions/80850db290cd/schema)