NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
npm · #1609 most downloaded on npm
Octokit plugin adding one method for all of api.github.com REST API endpoints
Last release 1 months ago
01 Aug 2026
Release timing varies
gaps range from 1 weeks to 9 months
Nearly every release is documented
notes for 60 of the last 60 stable releases
Nothing withdrawn
no release was ever pulled
7 years old
213 releases · first in 2019
One column per quarter.
typescript: import { RestEndpointMethodTypes } from "@octokit/plugin-rest-endpoint-methods"
TypeScript: description updates
## 3.5.1 (2020-04-07) ### Bug Fixes * gambit preview graduated
maintain and triage user permissions in orgs
The previous methods have been deprecated.
The previous methods have been deprecated.
octokit.activity.checkStarringRepo() -> octokit.activity.checkRepoIsStarredByAuthenticatedUser()octokit.activity.listEventsForOrg() -> octokit.activity.listOrgEventsForAuthenticatedUser()octokit.activity.listEventsForUser() -> octokit.activity.listEventsForAuthenticatedUser()octokit.activity.listFeeds() -> octokit.activity.getFeeds()octokit.activity.listNotifications() -> octokit.activity.listNotificationsForAuthenticatedUser()octokit.activity.listNotificationsForRepo() -> octokit.activity.listRepoNotificationsForAuthenticatedUser()octokit.activity.listPublicEventsForOrg() -> octokit.activity.listPublicOrgEvents()octokit.activity.markAsRead() -> octokit.activity.markNotificationsAsRead()octokit.activity.markNotificationsAsReadForRepo() -> octokit.activity.markRepoNotificationsAsRead()octokit.activity.starRepo() -> octokit.activity.starRepoForAuthenticatedUser()octokit.activity.unstarRepo() -> octokit.activity.unstarRepoForAuthenticatedUser()## 3.3.3 (2020-03-25) ### Bug Fixes * URL to GitHub Developer Guids
preview and response type fixes
fury preview is no longer required
new delete reaction endpoints. Deprecates octokit.reactions.delete()
octokit.actions.listArtifactsForRepo()
typescript: action workflow run responses
octokit.repos.deleteDeployment()
typescript: pagination parameters for octokit.issues.listCommentsForRepo()
All deprecated methods and options have been removed. Upgrade to the latest 2.x.x version and address all deprecation messages for an easy upgrade.
octokit.issues.create(parameters) are no longer validated on the client. We recommend using TypeScript or taking advantage of the TypeScript definitions in JavaScript.2.x.x version and address all deprecation messages for an easy upgrade.
octokit.request(). Note that this is only a temporary solution, as the REST API endpoints will be removed in future.
octokit.oauthAuthorizations.createAuthorization()octokit.request("POST /authorizations", parameters)octokit.oauthAuthorizations.deleteAuthorization()octokit.request("DELETE /authorizations/:authorization_id", parameters)octokit.oauthAuthorizations.deleteGrant()octokit.request("DELETE /applications/grants/:grant_id", parameters)octokit.oauthAuthorizations.getAuthorization()octokit.request("GET /authorizations/:authorization_id", parameters)octokit.oauthAuthorizations.getGrant()octokit.request("GET /applications/grants/:grant_id", parameters)octokit.oauthAuthorizations.getOrCreateAuthorizationForApp()octokit.request("PUT /authorizations/clients/:client_id", parameters)octokit.oauthAuthorizations.getOrCreateAuthorizationForAppAndFingerprint()octokit.request("PUT /authorizations/clients/:client_id/:fingerprint", parameters)octokit.oauthAuthorizations.listAuthorizations()octokit.request("GET /authorizations", parameters)octokit.oauthAuthorizations.listGrants()octokit.request("GET /applications/grants", parameters)octokit.oauthAuthorizations.updateAuthorization()octokit.request("PATCH /authorizations/:authorization_id", parameters)octokit.pulls.createFromIssue()octokit.request("POST /repos/:owner/:repo/pulls", parameters)octokit.repos.getCommitRefSha()octokit.request("GET /repos/:owner/:repo/commits/:ref", parameters)octokit.teams.addMemberLegacy()octokit.request("PUT /teams/:team_id/members/:username", parameters)octokit.teams.getLegacy()octokit.request("GET /teams/:team_id", parameters)octokit.teams.getMemberLegacy()octokit.request("GET /teams/:team_id/members/:username", parameters)octokit.teams.removeMemberLegacy()octokit.request("DELETE /teams/:team_id/members/:username", parameters)octokit.apps.checkAuthorization()octokit.apps.checkToken()octokit.apps.resetAuthorization()octokit.apps.resetToken()octokit.apps.revokeAuthorizationForApplication()octokit.apps.deleteToken()octokit.apps.revokeGrantForApplication()octokit.apps.deleteAuthorization()octokit.reactions.createForTeamDiscussionLegacy()octokit.reactions.createForTeamDiscussionInOrg()octokit.reactions.createForTeamDiscussionCommentLegacy()octokit.reactions.createForTeamDiscussionCommentInOrg()octokit.reactions.listForTeamDiscussionLegacy()octokit.reactions.listForTeamDiscussionInOrg()octokit.reactions.listForTeamDiscussionCommentLegacy()octokit.reactions.listForTeamDiscussionCommentInOrg()octokit.teams.addMemberLegacy()octokit.teams.addMemberInOrg()octokit.teams.addOrUpdateMembershipLegacy()octokit.teams.addOrUpdateMembershipInOrg()octokit.teams.addOrUpdateProjectLegacy()octokit.teams.addOrUpdateProjectInOrg()octokit.teams.addOrUpdateRepoLegacy()octokit.teams.addOrUpdateRepoInOrg()octokit.teams.checkManagesRepoLegacy()octokit.teams.checkManagesRepoInOrg()octokit.teams.createDiscussionLegacy()octokit.teams.createDiscussionInOrg()octokit.teams.createDiscussionCommentLegacy()octokit.teams.createDiscussionCommentInOrg()octokit.teams.deleteLegacy()octokit.teams.deleteInOrg()octokit.teams.deleteDiscussionLegacy()octokit.teams.deleteDiscussionInOrg()octokit.teams.deleteDiscussionCommentLegacy()octokit.teams.deleteDiscussionCommentInOrg()octokit.teams.getLegacy()octokit.teams.getInOrg()octokit.teams.getDiscussionLegacy()octokit.teams.getDiscussionInOrg()octokit.teams.getDiscussionCommentLegacy()octokit.teams.getDiscussionCommentInOrg()octokit.teams.getMemberLegacy()octokit.teams.getMemberInOrg()octokit.teams.getMembershipLegacy()octokit.teams.getMembershipInOrg()octokit.teams.listChildLegacy()octokit.teams.listChildInOrg()octokit.teams.listDiscussionCommentsLegacy()octokit.teams.listDiscussionCommentsInOrg()octokit.teams.listDiscussionsLegacy()octokit.teams.listDiscussionsInOrg()octokit.teams.listMembersLegacy()octokit.teams.listMembersInOrg()octokit.teams.listPendingInvitationsLegacy()octokit.teams.listPendingInvitationsInOrg()octokit.teams.listProjectsLegacy()octokit.teams.listProjectsInOrg()octokit.teams.listReposLegacy()octokit.teams.listReposInOrg()octokit.teams.removeMemberLegacy()octokit.teams.removeMemberInOrg()octokit.teams.removeMembershipLegacy()octokit.teams.removeMembershipInOrg()octokit.teams.removeProjectLegacy()octokit.teams.removeProjectInOrg()octokit.teams.removeRepoLegacy()octokit.teams.removeRepoInOrg()octokit.teams.reviewProjectLegacy()octokit.teams.reviewProjectInOrg()octokit.teams.updateLegacy()octokit.teams.updateInOrg()octokit.teams.updateDiscussionLegacy()octokit.teams.updateDiscussionInOrg()octokit.teams.updateDiscussionCommentLegacy()octokit.teams.updateDiscussionCommentInOrg()octokit.issues.updateLabel({current_name, name})octokit.issues.updateLabel({name, new_name})
(current_name is now name, name is now new_name)reduction in bundle size: 15.3kb down to 6.3kB
octokit.repos.uploadReleaseAsset(parameters) now accepts URL parameters
ownerreporelease_idPassing url will still work, but is not recommended. Use octokit.request instead:
octokit.request(url, {
method: "POST",
...parameters
})
deprecate octokit.gitdata.*, octokit.pullRequests.*
octokit.actions.listDownloadsForSelfHostedRunnerApplication({ owner, repo })
remainging deprecated endpoint methods removed.
*Legacy methods have been removed. They have all been deprecated in the previous versionoctokit.registerEndpoints() has been removed.Instead of
await octokit.registerEndpoints({
misc: {
getRoot: {
method: "GET",
url: "/"
}
}
});
do
octokit.misc.getRoot = octokit.request.defaults({
method: "GET",
url: "/"
});
or
Object.assign(octokit.misc, {
getRoot: octokit.request.defaults({
method: "GET",
url: "/"
})
})
octokit.issues.updateLabel({ current_name, name}) is now octokit.issues.updateLabel({ name, new_name})octokit.pulls.createFromIssue removed. The API endpoint is deprecated and will be removed in futureoctokit.git.listRefs removed. Use octokit.git.listMatchingRefs() instead.octokit.repos.getCommitRefSha removed. Use octokit.repos.getCommit({ mediaType: { format: "sha" }, owner, repo, ref }) insteadoctokit.git.listRefs() logs deprecation
deprecate octokit.gitdata.*, octokit.pullRequests.*
octokit.actions.listDownloadsForSelfHostedRunnerApplication()
file parameter is now data for .repos.uploadReleaseAsset()
Typescript: update types for latest endpoint methods
key_id parameter is a string, not integer
package: remove peer dependency
methods for new GitHub Actions endpoints
deprecated endpoint methods have .endpoint() method, too
Add back octokit.teams.removeMember() and octokit.teams.removeMembership()
everest preview graduated (4bfe6c6)octokit.teams.removeMember() and octokit.teams.removeMembership() (c3780f2).activity.* endpoints (dd632ae)octokit.search.emailLegacy() removedoctokit.search.issuesLegacy() removedoctokit.search.reposLegacy() removedoctokit.search.usersLegacy() removedoctokit.activity.checkWatchingRepoLegacy() removedoctokit.activity.stopWatchingRepoLegacy() removedoctokit.activity.watchRepoLegacy() removedrename & deprecation of endpoint methods using /teams/:team_id* path internally. The are being replaced by *ForOrg methods that use /orgs/:org/teams/:…
.apps.revokeInstallationToken().migrations.listReposForOrg(), .migrations.listReposForUser().repos.listForOrg()'s type parameter can now be set to "internal" (GitHub Enterprise Cloud only)visibility parameter for .repos.createForAuthenticatedUser() and .repos.createInOrg()delete_branch_on_merge parameter for .repos.createForAuthenticatedUser(), .repos.createInOrg(), .repos.update().orgs.update(): members_can_create_internal_repositories, members_can_create_private_repositories, members_can_create_public_repositories.repos.updateBranchProtection(): allow_deletions, allow_force_pushes, required_linear_history/teams/:team_id* path internally. The are being replaced by *ForOrg methods that use /orgs/:org/teams/:team_slug* internally. With the next breaking version, the *ForOrg suffix will be removed using another deprecation.barred-rock, echo, hagarworkaround "error TS4023: Exported variable Octokit has or is using name EndpointMethodsObject from external module node_modules/@octokit/plugin-rest-
package: minimal peerDependency requirement for @octokit/core
Typescript: octokit.rest.* -> octokit.* - for now
1:1 feature parity with REST API methods from @octokit/rest
Your coding agent can read these notes before it upgrades. Set up the MCP server →