@octokit/plugin-rest-endpoint-methods
18.0.0 · 1 Aug 2026MIT44.3M / weekRepositoryHomepagenpmAtom feed
206 stable releases, newest first, by release line. Notes are quoted as the maintainers published them.
- 7.x
7.0.1
20 Jan 2023deps: bump
@octokit/types
- 6.x
6.8.0
20 Jan 2023Many unreleased updates to endpoint methods
6.7.0
13 Oct 2022OpenAPI update
6.6.2
16 Sep 20226.6.1
15 Sep 2022Update in-code documentation for
repos.createOrUpdateFileContents(PUT /repos/{owner}/{repo}/contents/{path}) andrepos.deleteFile(DELETE /repos/{owner}/{repo}/contents/{path}) to clarify that calling them in parallel may lead to conflicts
6.6.0
13 Sep 2022typescript: add support for filtering the "List repository collaborators" API (
GET /repos/{owner}/{repo}/collaborators) bypermissionusing a query param
6.5.3
13 Sep 2022Update in-code documentation and generated Markdown documentation to reflect the latest API changes
6.5.2
9 Sep 20226.5.1
9 Sep 2022Tweak documentation for
git.getTree(GET /repos/{owner}/{repo}/git/trees/{tree_sha}) to clarify maximum limits on size and number of entries
6.5.0
7 Sep 2022Add new public beta APIs for creating, reading, updating and deleting custom repo roles (
POST /orgs/{org}/custom_roles,PATCH /orgs/{org}/custom_roles/{role_id},DELETE /orgs/{org}/custom_roles/{role_id},GET /orgs/{org}/fine_grained_permissions)
6.4.1
2 Sep 2022Update docs for
repos.createUsingTemplateto clarify that it doesn't require special permissions with a public repoDocument new
is_alphnumericattribute accepted byrepos.createAutolinkUpdate docs for
repos.createAutolinkso the English reads better
6.4.0
31 Aug 2022Add support for new "Enable or disable a security feature for an organization" API (
POST /orgs/{org}/{security_product}/{enablement})Add support for new SSH signing keys APIs (
GET /user/ssh_signing_keys,POST /user/ssh_signing_keys,GET /user/ssh_signing_keys/{ssh_signing_key_id},DELETE /user/ssh_signing_keys/{ssh_signing_key_id},GET /users/{username}/ssh_signing_keys)
6.3.1
30 Aug 2022Update docs to reflect new request parameters in 3 APIs and updated API descriptions
6.3.0
15 Aug 2022Add support for new "create Pages deployment" API (
createPagesDeployment)Add support for new deployment branch policy APIs (
createDeploymentBranchPolicy,deleteDeploymentBranchPolicy,getDeploymentBranchPolicy,Add support for new Security Managers APIs (
addSecurityManagerTeam,listSecurityManagerTeams,removeSecurityManagerTeam)
6.2.0
29 Jul 2022Add support for
GET /enterprises/{enterprise}/code-scanning/alertsendpoint viaoctokit.rest.codeScanning.listAlertsForEnterprise()function (and description updates for other endpoints)
6.1.2
19 Jul 2022Don't pin to an exact version of
@octokit/types, use^
6.1.1
18 Jul 2022deps: pin to a specific version of
@octokit/types
Bug Fixes
deps: pin to a specific version of
@octokit/types
6.1.0
15 Jul 2022Add support for new
GET /repos/{owner}/{repo}/codespaces/newAPI withoctokit.rest.codespaces.preFlightWithRepoForAuthenticatedUserfunctionAuto-update in-code documentation using latest operation descriptions
Auto-update docs using latest operation and parameter descriptions
Add support for new
GET /repos/{owner}/{repo}/codespaces/newAPI withoctokit.rest.codespaces.preFlightWithRepoForAuthenticatedUserfunctionAuto-update in-code documentation using latest operation descriptions
Auto-update docs using latest operation and parameter descriptions
Auto-generate
scripts/update-endpoints/generated/endpoints.json
6.0.2
14 Jul 2022Improve parameter descriptions for
GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers
6.0.1
12 Jul 2022Update documentation for
POST /orgs/{org}/migrations
6.0.0
8 Jul 2022- Breaking
Drop support for NodeJS v10, v12
Stop testing against NodeJS v10, v12
- 5.x
5.16.2
5 Jul 2022Clarify docs to make it clear that
POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deploymentsis only available to required reviewers
5.16.1
2 Jul 2022Gracefully rename
org_idpath parameter forGET /orgs/{org_id}/codespacestoorgMark
PUT /enterprises/{enterprise}/actions/oidc/customization/issueras GitHub EnterpriseUpdate operation docs to reflect current API
5.16.0
28 Jun 2022PUT /enterprises/{enterprise}/actions/oidc/customization/issuerGET /orgs/{org_id}/codespacesPOST /orgs/{org}/members/{username}/codespaces/{codespace_name}/stop
Features
PUT /enterprises/{enterprise}/actions/oidc/customization/issuerGET /orgs/{org_id}/codespacesPOST /orgs/{org}/members/{username}/codespaces/{codespace_name}/stopGET /orgs/{org}/actions/oidc/customization/subPUT /orgs/{org}/actions/oidc/customization/subDELETE /orgs/{org}/members/{username}/codespaces/{codespace_name}GET /repos/{owner}/{repo}/actions/cachesDELETE /repos/{owner}/{repo}/actions/cachesDELETE /repos/{owner}/{repo}/actions/caches/{cache_id}GET /repos/{owner}/{repo}/actions/oidc/customization/subPUT /repos/{owner}/{repo}/actions/oidc/customization/subFeat
POST /repos/{owner}/{repo}/dependency-graph/snapshots
5.15.0
20 Jun 2022Add new
beforeandafterparameters toGET /orgs/{org}/secret-scanning/alertsandGET /repos/{owner}/{repo}/secret-scanning/alerts
5.14.1
20 Jun 2022Update descriptions and examples
5.14.0
15 Jun 2022.rest.dependabot.addSelectedRepoToOrgSecret().rest.dependabot.removeSelectedRepoFromOrgSecret().rest.teams.listLinkedExternalIdpGroupsToTeamForOrg()
Features
.rest.dependabot.addSelectedRepoToOrgSecret().rest.dependabot.removeSelectedRepoFromOrgSecret().rest.teams.listLinkedExternalIdpGroupsToTeamForOrg().rest.teams.linkExternalIdpGroupToTeamForOrg().rest.teams.unlinkExternalIdpGroupFromTeamForOrg().rest.enterpriseAdmin.listLabelsForSelfHostedRunnerForEnterprise().rest.enterpriseAdmin.addCustomLabelsToSelfHostedRunnerForEnterprise().rest.enterpriseAdmin.setCustomLabelsForSelfHostedRunnerForEnterprise().rest.enterpriseAdmin.removeAllCustomLabelsFromSelfHostedRunnerForEnterprise().rest.actions.listLabelsForSelfHostedRunnerForOrg().rest.actions.addCustomLabelsToSelfHostedRunnerForOrg().rest.actions.setCustomLabelsForSelfHostedRunnerForOrg().rest.actions.removeAllCustomLabelsFromSelfHostedRunnerForOrg().rest.actions.listLabelsForSelfHostedRunnerForRepo().rest.actions.addCustomLabelsToSelfHostedRunnerForRepo().rest.actions.setCustomLabelsForSelfHostedRunnerForRepo().rest.actions.removeAllCustomLabelsFromSelfHostedRunnerForRepo().rest.codespaces.listInRepositoryForAuthenticatedUser().rest.codespaces.createWithRepoForAuthenticatedUser().rest.repos.listTagProtection().rest.repos.createTagProtection().rest.codespaces.listForAuthenticatedUser().rest.codespaces.createForAuthenticatedUser().rest.codespaces.listSecretsForAuthenticatedUser().rest.codespaces.getPublicKeyForAuthenticatedUser().rest.codespaces.getSecretForAuthenticatedUser().rest.codespaces.createOrUpdateSecretForAuthenticatedUser().rest.codespaces.deleteSecretForAuthenticatedUser().rest.codespaces.listRepositoriesForSecretForAuthenticatedUser().rest.codespaces.setRepositoriesForSecretForAuthenticatedUser().rest.codespaces.addRepositoryForSecretForAuthenticatedUser().rest.codespaces.removeRepositoryForSecretForAuthenticatedUser().rest.codespaces.getForAuthenticatedUser().rest.codespaces.updateForAuthenticatedUser().rest.codespaces.deleteForAuthenticatedUser().rest.codespaces.exportForAuthenticatedUser().rest.codespaces.getExportDetailsForAuthenticatedUser().rest.codespaces.codespaceMachinesForAuthenticatedUser().rest.codespaces.startForAuthenticatedUser().rest.codespaces.stopForAuthenticatedUser().rest.dependabot.getOrgSecret().rest.dependabot.createOrUpdateOrgSecret().rest.dependabot.deleteOrgSecret().rest.codespaces.getRepoSecret().rest.codespaces.createOrUpdateRepoSecret().rest.codespaces.deleteRepoSecret().rest.dependabot.getRepoSecret().rest.dependabot.createOrUpdateRepoSecret().rest.dependabot.deleteRepoSecret().rest.actions.getGithubActionsDefaultWorkflowPermissionsOrganization().rest.actions.setGithubActionsDefaultWorkflowPermissionsOrganization().rest.dependabot.listSelectedReposForOrgSecret().rest.dependabot.setSelectedReposForOrgSecret().rest.actions.getWorkflowAccessToRepository().rest.actions.setWorkflowAccessToRepository().rest.actions.getGithubActionsDefaultWorkflowPermissionsRepository().rest.actions.setGithubActionsDefaultWorkflowPermissionsRepository().rest.orgs.listCustomRoles().rest.actions.getActionsCacheUsageForOrg().rest.enterpriseAdmin.removeCustomLabelFromSelfHostedRunnerForEnterprise().rest.actions.removeCustomLabelFromSelfHostedRunnerForOrg().rest.actions.removeCustomLabelFromSelfHostedRunnerForRepo().rest.reactions.deleteForRelease().rest.repos.deleteTagProtection().rest.enterpriseAdmin.getServerStatistics().rest.actions.getActionsCacheUsageForEnterprise().rest.actions.getGithubActionsDefaultWorkflowPermissionsEnterprise().rest.enterpriseAdmin.listSelfHostedRunnerGroupsForEnterprise()-visible-to-organizationparamter.rest.secretScanning.listAlertsForEnterprise().rest.billing.getGithubAdvancedSecurityBillingGhe().rest.actions.getActionsCacheUsageByRepoForOrg().rest.actions.listSelfHostedRunnerGroupsForOrg()- new parameter:visible_to_repository.rest.codeScanning.listAlertsForOrg().rest.orgs.listSamlSsoAuthorizations()- new parameters:per_page,page,login.rest.dependabot.getOrgPublicKey().rest.dependabot.listOrgSecrets().rest.teams.externalIdpGroupInfoForOrg().rest.teams.listExternalIdpGroupsForOrg().rest.secretScanning.listAlertsForOrg()- new parameters:sort,direction.rest.billing.getGithubAdvancedSecurityBillingOrg().rest.repos.codeownersErrors().rest.codespaces.listDevcontainersInRepositoryForAuthenticatedUser().rest.codespaces.repoMachinesForAuthenticatedUser().rest.codespaces.getRepoPublicKey().rest.codespaces.listRepoSecrets().rest.dependabot.getRepoPublicKey().rest.dependabot.listRepoSecrets().rest.dependencyGraph.diffRange().rest.reactions.listForRelease().rest.secretScanning.listLocationsForAlert().rest.actions.updateSelfHostedRunnerGroupForOrg()- new parameters:allows_public_repositories,restricted_to_workflows,selected_workflows.rest.orgs.update()- new parameter:members_can_fork_private_repositories.rest.actions.createSelfHostedRunnerGroupForOrg()- new parameters:allows_public_repositories,restricted_to_workflows,selected_workflows.rest.migrations.startForOrg()- new parrameters:exclude_metadata,exclude_git_data,org_metadata_only.rest.repos.createInOrg()- new parameter:use_squash_pr_title_as_default.rest.actions.reRunJobForWorkflowRun().rest.actions.reRunWorkflowFailedJobs().rest.codespaces.createWithPrForAuthenticatedUser().rest.migrations.startForAuthenticatedUser()- new parrameters:exclude_metadata,exclude_git_data,org_metadata_only.rest.actions.setGithubActionsDefaultWorkflowPermissionsEnterprise().rest.orgs.convertMemberToOutsideCollaborator()- new parameter:async.rest.actions.getActionsCacheUsage().rest.actions.listWorkflowRunsForRepo(): new parameter:check_suite_id.rest.actions.listWorkflowRuns(): new parameter:check_suite_id.rest.codeScanning.listAlertsForRepo(): new parameters:direction,sort.rest.repos.getAllEnvironments(): new parameters:per_page,page.rest.secretScanning.listAlertsForRepo(): new parameters:direction,sort.rest.repos.updatePullRequestReviewProtection(): new parameters:dismissal_restrictions.apps,bypass_pull_request_allowances.rest.repos.updateStatusCheckProtection(): new parameter:checks.rest.codeScanning.updateAlert(): new parameter:dismissed_comment.rest.repos.update():secret_scanning_push_protection,use_squash_pr_title_as_default.rest.actions.reRunWorkflow(): new parameter:enable_debug_logging.rest.users.createGpgKeyForAuthenticatedUser(): new parameter:name.rest.repos.updateBranchProtection(): new parameter:required_status_checks.checks,required_pull_request_reviews.{apps,bypass_pull_request_allowances},block_creations
Bug Fixes
.rest.apps.createFromManifest()has no request body.rest.projects.getPermissionForUser(): correct response type and example.rest.repos.update():visibilityparameter cannot be set tovisibility.rest.actions.reRunWorkflow(): no longer deprecatedRemove defunkt
.rest.reactions.deleteLegacy()Remove defunkt
.rest.apps.createContentAttachment()
5.13.0
11 Oct 2021GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs
5.12.1
8 Oct 2021typescript:
exclude_pull_requestsparameter for action runs endpoints
5.12.0
7 Oct 2021- Deprecated
GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_num},GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_num}/logs,POST /repos/{owner}/{repo}/releases/generate-notes,POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest. Graduatenebula,zzzax,switcheroo,baptistepreviews. Removes defunkt/repos/{owner}/{repo}/actions/runs/{run_id}/retryendpoint. Renames methods to have consistentAuthenticatedUser()suffix, deprecates previous method names
5.11.4
30 Sep 2021Removes defunkt endpoints:
GET /repos/{owner}/{repo}/community/code_of_conduct,DELETE /reactions/{reaction_id}.encrypted_valueandkey_idparameters are required for.rest.actions.{createOrUpdateEnvironmentSecret,setSelectedReposForOrgSecret}().access_tokenparameter is required for.rest.apps.deleteAuthorization(). Previews graduated:ant-man,flash,scarlet-witch,squirrel-girl
5.11.3
27 Sep 2021luke-cagepreview graduated
5.11.2
24 Sep 2021Graduate previews
dorian,inertia,london,lydian,wyandotte
5.11.1
22 Sep 2021octokit.rest.repos.disableLfsForRepo()octokit.rest.repos.enableLfsForRepo()octokit.rest.packages.listPackagesForUseruses correct route (GET /user/{username}/packages->GET /users/{username}/packages)
(should have been a feature release)
Features
octokit.rest.repos.disableLfsForRepo()octokit.rest.repos.enableLfsForRepo()
Bug Fixes
octokit.rest.packages.listPackagesForUseruses correct route (GET /user/{username}/packages->GET /users/{username}/packages)
5.11.0
22 Sep 2021octokit.rest.actions.retryWorkflow(). Deprecatesoctokit.rest.actions.reRunWorkflow()
5.10.4
14 Sep 2021Type updates (
allow_forkingin repositories, diff itemstatusnow has an enum)
5.10.3
13 Sep 2021typescript: response type fixes
5.10.2
12 Sep 2021typescript: do not mark
.userand other response properties as nullable where it does not apply
5.10.1
8 Sep 2021typescript: description updates for
.repos.mergeUpstream()
5.10.0
3 Sep 2021.rest.repos.mergeUpstream({ owner, repo, branch })
5.9.0
31 Aug 2021.packages.deletePackageForUser(),.packages.deletePackageVersionForUser(),.packages.restorePackageForUser(),.packages.restorePackageVersionForUser(),.secretScanning.listAlertsForOrg()typescript: fix type for
labelsparameter in.issues.{add,set}Labels()
5.8.0
10 Aug 2021typescript:
permissionskey in responses now consistently includemaintainandtriageroles
5.7.0
3 Aug 2021typescript:
allow_auto_mergeparameter when creating / updating a repository. Search:ownerin repository items may no longer benull
5.6.0
2 Aug 2021.rest.repos.createAutolink(),.rest.repos.listAutolinks(),.rest.repos.getAutolink(),.rest.repos.deleteAutolink()
5.5.2
29 Jul 2021typescript:
.rest.repos.getRelease()response data now includesmentions_count
5.5.1
23 Jul 2021typescript:
.rest.repos.uploadReleaseAsset()requiresnameparameter..head.repoproperty is optional in pull request response type
5.5.0
21 Jul 2021typescript: add
createdparameter tooctokit.actions.listWorkflowRuns()andoctokit.actions.listWorkflowRunsForRepo()
5.4.2
20 Jul 2021Only updates a dependency:@octokit/types 6.19.1
A whole project to check? Paste its package.json in the dependency check: every deprecated, outdated or vulnerable dependency, with what to upgrade to. Free, no account.