@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.
- 4.x
4.2.0
13 Sep 2020- Deprecated
octokit.codeScanning.listRecentAnalyses,octokit.codeScanning.updateAlert,octokit.codeScanning.uploadSarif. Deprecation:alert_idparameter has been deprecated. Usealert_numberinstead
4.1.4
3 Sep 2020machine-manpreview graduated
4.1.3
25 Aug 2020README: usage example
4.1.2
23 Jul 2020typescript: description updates
4.1.1
22 Jul 2020Send request to correct path for
.migrations.listReposForUser()
4.1.0
15 Jul 2020typescript: types updates
actions.createWorkflowDispatch(),actions.deleteWorkflowRun(),billing.getGithubActionsBillingOrg(),billing.getGithubActionsBillingUser(),billing.getGithubPackagesBillingOrg(),billing.getGithubPackagesBillingUser(),billing.getSharedStorageBillingOrg(),billing.getSharedStorageBillingUser(),checks.deleteLegacy()Set required previews by default for
octokit.repos.getCommunityProfileMetrics()andoctokit.repos.topics()
4.0.0
10 Jun 2020- Deprecated
Deprecated
octokit.reactions.deleteLegacy()has ben removed - Deprecated
Deprecated
octokit.repos.getDownloads()has ben removed - Deprecated
Deprecated
octokit.repos.listDownloads()has ben removed
Breaking changes
- Deprecated
Deprecated
octokit.reactions.deleteLegacy()has ben removed - Deprecated
Deprecated
octokit.repos.getDownloads()has ben removed - Deprecated
Deprecated
octokit.repos.listDownloads()has ben removed - Deprecated
Deprecated
octokit.repos.deleteDownloads()has ben removed - Breaking
octokit.actions.createOrUpdateRepoSecret(): parameternamehas been renamed tosecret_name - Breaking
octokit.actions.createOrUpdateSecretForRepo()has been renamed tooctokit.actions.createOrUpdateRepoSecret() - Breaking
octokit.actions.createOrUpdateRepoSecret(): parameternamehas been renamed tosecret_name - Breaking
octokit.actions.createRegistrationToken()has been renamed tooctokit.actions.createRegistrationTokenForRepo() - Breaking
octokit.actions.createRemoveToken()has been renamed tooctokit.actions.createRemoveTokenForRepo() - Breaking
octokit.actions.deleteRepoSecret(): parameternamehas been renamed tosecret_name - Breaking
octokit.actions.deleteSecretFromRepo()has been renamed tooctokit.actions.deleteRepoSecret() - Breaking
octokit.actions.deleteRepoSecret(): parameternamehas been renamed tosecret_name - Breaking
octokit.actions.downloadWorkflowJobLogs()has been renamed tooctokit.actions.downloadJobLogsForWorkflowRun() - Breaking
octokit.actions.getPublicKey()has been renamed tooctokit.actions.getRepoPublicKey() - Breaking
octokit.actions.getRepoSecret(): parameternamehas been renamed tosecret_name - Breaking
octokit.actions.getSecret()has been renamed tooctokit.actions.getRepoSecret() - Breaking
octokit.actions.getRepoSecret(): parameternamehas been renamed tosecret_name - Breaking
octokit.actions.getSelfHostedRunner()has been renamed tooctokit.actions.getSelfHostedRunnerForRepo() - Breaking
octokit.actions.getWorkflowJob()has been renamed tooctokit.actions.getJobForWorkflowRun() - Breaking
octokit.actions.listDownloadsForSelfHostedRunnerApplication()has been renamed tooctokit.actions.listRunnerApplicationsForRepo() - Breaking
octokit.actions.listRepoWorkflowRuns()has been renamed tooctokit.actions.listWorkflowRunsForRepo() - Breaking
octokit.actions.listSecretsForRepo()has been renamed tooctokit.actions.listRepoSecrets() - Breaking
octokit.actions.listWorkflowJobLogs()has been renamed tooctokit.actions.downloadWorkflowJobLogs() - Breaking
octokit.actions.listWorkflowRunLogs()has been renamed tooctokit.actions.downloadWorkflowRunLogs() - Breaking
octokit.actions.removeSelfHostedRunner()has been renamed tooctokit.actions.deleteSelfHostedRunnerFromRepo() - Breaking
octokit.activity.checkStarringRepo()has been renamed tooctokit.activity.checkRepoIsStarredByAuthenticatedUser() - Breaking
octokit.activity.getThreadSubscription()has been renamed tooctokit.activity.getThreadSubscriptionForAuthenticatedUser() - Breaking
octokit.activity.listEventsForOrg()has been renamed tooctokit.activity.listOrgEventsForAuthenticatedUser() - Breaking
octokit.activity.listEventsForUser()has been renamed tooctokit.activity.listEventsForAuthenticatedUser() - Breaking
octokit.activity.listFeeds()has been renamed tooctokit.activity.getFeeds() - Breaking
octokit.activity.listNotifications()has been renamed tooctokit.activity.listNotificationsForAuthenticatedUser() - Breaking
octokit.activity.listNotificationsForRepo()has been renamed tooctokit.activity.listRepoNotificationsForAuthenticatedUser() - Breaking
octokit.activity.listPublicEventsForOrg()has been renamed tooctokit.activity.listPublicOrgEvents() - Breaking
octokit.activity.markAsRead()has been renamed tooctokit.activity.markNotificationsAsRead() - Breaking
octokit.activity.markNotificationsAsReadForRepo()has been renamed tooctokit.activity.markRepoNotificationsAsRead() - Breaking
octokit.activity.starRepo()has been renamed tooctokit.activity.starRepoForAuthenticatedUser() - Breaking
octokit.activity.unstarRepo()has been renamed tooctokit.activity.unstarRepoForAuthenticatedUser() - Breaking
octokit.apps.checkAccountIsAssociatedWithAny()has been renamed tooctokit.apps.getSubscriptionPlanForAccount() - Breaking
octokit.apps.checkAccountIsAssociatedWithAnyStubbed()has been renamed tooctokit.apps.getSubscriptionPlanForAccountStubbed() - Breaking
octokit.apps.createInstallationToken()has been renamed tooctokit.apps.createInstallationAccessToken() - Breaking
octokit.apps.listAccountsUserOrOrgOnPlan()has been renamed tooctokit.apps.listAccountsForPlan() - Breaking
octokit.apps.listAccountsUserOrOrgOnPlanStubbed()has been renamed tooctokit.apps.listAccountsForPlanStubbed() - Breaking
octokit.apps.listMarketplacePurchasesForAuthenticatedUser()has been renamed tooctokit.apps.listSubscriptionsForAuthenticatedUser() - Breaking
octokit.apps.listMarketplacePurchasesForAuthenticatedUserStubbed()has been renamed tooctokit.apps.listSubscriptionsForAuthenticatedUserStubbed() - Breaking
octokit.apps.listRepos()has been renamed tooctokit.apps.listReposAccessibleToInstallation() - Breaking
octokit.apps.revokeInstallationToken()has been renamed tooctokit.apps.revokeInstallationAccessToken() - Breaking
octokit.codesOfConduct.listConductCodes()has been renamed tooctokit.codesOfConduct.getAllCodesOfConduct() - Breaking
octokit.gists.listPublicForUser()has been renamed tooctokit.gists.listForUser() - Breaking
octokit.gitignore.listTemplates()has been renamed tooctokit.gitignore.getAllTemplates() - Breaking
octokit.interactions.addOrUpdateRestrictionsForOrg()has been renamed tooctokit.interactions.setRestrictionsForOrg() - Breaking
octokit.interactions.addOrUpdateRestrictionsForRepo()has been renamed tooctokit.interactions.setRestrictionsForRepo() - Breaking
octokit.issues.checkAssignee()has been renamed tooctokit.issues.checkUserCanBeAssigned() - Breaking
octokit.issues.listMilestonesForRepo()has been renamed tooctokit.issues.listMilestones() - Breaking
octokit.issues.removeLabels()has been renamed tooctokit.issues.removeAllLabels() - Breaking
octokit.issues.replaceAllLabels()has been renamed tooctokit.issues.setLabels() - Breaking
octokit.issues.replaceLabels()has been renamed tooctokit.issues.replaceAllLabels() - Breaking
octokit.licenses.listCommonlyUsed()has been renamed tooctokit.licenses.getAllCommonlyUsed() - Breaking
octokit.migrations.getImportProgress()has been renamed tooctokit.migrations.getImportStatus() - Breaking
octokit.orgs.addOrUpdateMembership()has been renamed tooctokit.orgs.setMembershipForUser() - Breaking
octokit.orgs.checkMembership()has been renamed tooctokit.orgs.checkMembershipForUser() - Breaking
octokit.orgs.checkPublicMembership()has been renamed tooctokit.orgs.checkPublicMembershipForUser() - Breaking
octokit.orgs.concealMembership()has been renamed tooctokit.orgs.removePublicMembershipForAuthenticatedUser() - Breaking
octokit.orgs.createHook()has been renamed tooctokit.orgs.createWebhook() - Breaking
octokit.orgs.deleteHook()has been renamed tooctokit.orgs.deleteWebhook() - Breaking
octokit.orgs.getHook()has been renamed tooctokit.orgs.getWebhook() - Breaking
octokit.orgs.getMembership()has been renamed tooctokit.orgs.getMembershipForUser() - Breaking
octokit.orgs.listHooks()has been renamed tooctokit.orgs.listWebhooks() - Breaking
octokit.orgs.listInstallations()has been renamed tooctokit.orgs.listAppInstallations() - Breaking
octokit.orgs.listMemberships()has been renamed tooctokit.orgs.listMembershipsForAuthenticatedUser() - Breaking
octokit.orgs.pingHook()has been renamed tooctokit.orgs.pingWebhook() - Breaking
octokit.orgs.publicizeMembership()has been renamed tooctokit.orgs.setPublicMembershipForAuthenticatedUser() - Breaking
octokit.orgs.removeMembership()has been renamed tooctokit.orgs.removeMembershipForUser() - Breaking
octokit.orgs.updateHook()has been renamed tooctokit.orgs.updateWebhook() - Breaking
octokit.orgs.updateMembership()has been renamed tooctokit.orgs.updateMembershipForAuthenticatedUser() - Breaking
octokit.projects.reviewUserPermissionLevel()has been renamed tooctokit.projects.getPermissionForUser() - Breaking
octokit.pulls.createComment()has been renamed tooctokit.pulls.createReviewComment() - Breaking
octokit.pulls.createReviewCommentReply()has been renamed tooctokit.pulls.createReplyForReviewComment() - Breaking
octokit.pulls.createReviewRequest()has been renamed tooctokit.pulls.requestReviewers() - Breaking
octokit.pulls.deleteComment()has been renamed tooctokit.pulls.deleteReviewComment() - Breaking
octokit.pulls.deleteReviewRequest()has been renamed tooctokit.pulls.removeRequestedReviewers() - Breaking
octokit.pulls.getComment()has been renamed tooctokit.pulls.getReviewComment() - Breaking
octokit.pulls.getCommentsForReview()has been renamed tooctokit.pulls.listCommentsForReview() - Breaking
octokit.pulls.listComments()has been renamed tooctokit.pulls.listReviewComments() - Breaking
octokit.pulls.listCommentsForRepo()has been renamed tooctokit.pulls.listReviewCommentsForRepo() - Breaking
octokit.pulls.listReviewRequests()has been renamed tooctokit.pulls.listRequestedReviewers() - Breaking
octokit.pulls.updateComment()has been renamed tooctokit.pulls.updateReviewComment() - Breaking
octokit.reactions.delete()has been renamed tooctokit.reactions.deleteLegacy() - Breaking
octokit.repos.addDeployKey()has been renamed tooctokit.repos.createDeployKey() - Breaking
octokit.repos.addProtectedBranchAdminEnforcement()has been renamed tooctokit.repos.setAdminBranchProtection() - Breaking
octokit.repos.addProtectedBranchAppRestrictions()has been renamed tooctokit.repos.addAppAccessRestrictions() - Breaking
octokit.repos.addProtectedBranchRequiredSignatures()has been renamed tooctokit.repos.createCommitSignatureProtection() - Breaking
octokit.repos.addProtectedBranchRequiredStatusChecksContexts()has been renamed tooctokit.repos.addStatusCheckContexts() - Breaking
octokit.repos.addProtectedBranchTeamRestrictions()has been renamed tooctokit.repos.addTeamAccessRestrictions() - Breaking
octokit.repos.addProtectedBranchUserRestrictions()has been renamed tooctokit.repos.addUserAccessRestrictions() - Breaking
octokit.repos.createHook()has been renamed tooctokit.repos.createWebhook() - Breaking
octokit.repos.createOrUpdateFile()has been renamed tooctokit.repos.createOrUpdateFileContents() - Breaking
octokit.repos.createStatus()has been renamed tooctokit.repos.createCommitStatus() - Breaking
octokit.repos.deleteHook()has been renamed tooctokit.repos.deleteWebhook() - Breaking
octokit.repos.disablePagesSite()has been renamed tooctokit.repos.deletePagesSite() - Breaking
octokit.repos.enablePagesSite()has been renamed tooctokit.repos.createPagesSite() - Breaking
octokit.repos.getArchiveLink()has been renamed tooctokit.repos.downloadArchive() - Breaking
octokit.repos.getContents()has been renamed tooctokit.repos.getContent() - Breaking
octokit.repos.getHook()has been renamed tooctokit.repos.getWebhook() - Breaking
octokit.repos.getProtectedBranchAdminEnforcement()has been renamed tooctokit.repos.getAdminBranchProtection() - Breaking
octokit.repos.getProtectedBranchPullRequestReviewEnforcement()has been renamed tooctokit.repos.getPullRequestReviewProtection() - Breaking
octokit.repos.getProtectedBranchRequiredSignatures()has been renamed tooctokit.repos.getCommitSignatureProtection() - Breaking
octokit.repos.getProtectedBranchRequiredStatusChecks()has been renamed tooctokit.repos.getStatusChecksProtection() - Breaking
octokit.repos.getProtectedBranchRestrictions()has been renamed tooctokit.repos.getAccessRestrictions() - Breaking
octokit.repos.list()has been renamed tooctokit.repos.listForAuthenticatedUser() - Breaking
octokit.repos.listAssetsForRelease()has been renamed tooctokit.repos.listReleaseAssets() - Breaking
octokit.repos.listCommitComments()has been renamed tooctokit.repos.listCommitCommentsForRepo() - Breaking
octokit.repos.listHooks()has been renamed tooctokit.repos.listWebhooks() - Breaking
octokit.repos.listProtectedBranchRequiredStatusChecksContexts()has been renamed tooctokit.repos.getAllStatusCheckContexts() - Breaking
octokit.repos.listStatusesForRef()has been renamed tooctokit.repos.listCommitStatusesForRef() - Breaking
octokit.repos.listTopics()has been renamed tooctokit.repos.getAllTopics() - Breaking
octokit.repos.pingHook()has been renamed tooctokit.repos.pingWebhook() - Breaking
octokit.repos.removeBranchProtection()has been renamed tooctokit.repos.deleteBranchProtection() - Breaking
octokit.repos.removeDeployKey()has been renamed tooctokit.repos.deleteDeployKey() - Breaking
octokit.repos.removeProtectedBranchAdminEnforcement()has been renamed tooctokit.repos.deleteAdminBranchProtection() - Breaking
octokit.repos.removeProtectedBranchAppRestrictions()has been renamed tooctokit.repos.removeAppAccessRestrictions() - Breaking
octokit.repos.removeProtectedBranchPullRequestReviewEnforcement()has been renamed tooctokit.repos.deletePullRequestReviewProtection() - Breaking
octokit.repos.removeProtectedBranchRequiredSignatures()has been renamed tooctokit.repos.deleteCommitSignatureProtection() - Breaking
octokit.repos.removeProtectedBranchRequiredStatusChecks()has been renamed tooctokit.repos.removeStatusChecksProtection() - Breaking
octokit.repos.removeProtectedBranchRequiredStatusChecksContexts()has been renamed tooctokit.repos.removeStatusCheckContexts() - Breaking
octokit.repos.removeProtectedBranchRestrictions()has been renamed tooctokit.repos.deleteAccessRestrictions() - Breaking
octokit.repos.removeProtectedBranchTeamRestrictions()has been renamed tooctokit.repos.removeTeamAccessRestrictions() - Breaking
octokit.repos.removeProtectedBranchUserRestrictions()has been renamed tooctokit.repos.removeUserAccessRestrictions() - Breaking
octokit.repos.replaceProtectedBranchAppRestrictions()has been renamed tooctokit.repos.setAppAccessRestrictions() - Breaking
octokit.repos.replaceProtectedBranchRequiredStatusChecksContexts()has been renamed tooctokit.repos.setStatusCheckContexts() - Breaking
octokit.repos.replaceProtectedBranchTeamRestrictions()has been renamed tooctokit.repos.setTeamAccessRestrictions() - Breaking
octokit.repos.replaceProtectedBranchUserRestrictions()has been renamed tooctokit.repos.setUserAccessRestrictions() - Breaking
octokit.repos.replaceTopics()has been renamed tooctokit.repos.replaceAllTopics() - Breaking
octokit.repos.requestPageBuild()has been renamed tooctokit.repos.requestPagesBuild() - Breaking
octokit.repos.retrieveCommunityProfileMetrics()has been renamed tooctokit.repos.getCommunityProfileMetrics() - Breaking
octokit.repos.testPushHook()has been renamed tooctokit.repos.testPushWebhook() - Breaking
octokit.repos.updateHook()has been renamed tooctokit.repos.updateWebhook() - Breaking
octokit.repos.updateProtectedBranchPullRequestReviewEnforcement()has been renamed tooctokit.repos.updatePullRequestReviewProtection() - Breaking
octokit.repos.updateProtectedBranchRequiredStatusChecks()has been renamed tooctokit.repos.updateStatusChecksProtection() - Breaking
octokit.teams.addOrUpdateMembershipInOrg()has been renamed tooctokit.teams.addOrUpdateMembershipForUserInOrg() - Breaking
octokit.teams.addOrUpdateProjectInOrg()has been renamed tooctokit.teams.addOrUpdateProjectPermissionsInOrg() - Breaking
octokit.teams.addOrUpdateRepoInOrg()has been renamed tooctokit.teams.addOrUpdateRepoPermissionsInOrg() - Breaking
octokit.teams.checkManagesRepoInOrg()has been renamed tooctokit.teams.checkPermissionsForRepoInOrg() - Breaking
octokit.teams.getMembershipInOrg()has been renamed tooctokit.teams.getMembershipForUserInOrg() - Breaking
octokit.teams.removeMembershipInOrg()has been renamed tooctokit.teams.removeMembershipForUserInOrg() - Breaking
octokit.teams.reviewProjectInOrg()has been renamed tooctokit.teams.checkPermissionsForProjectInOrg() - Breaking
octokit.users.addEmails()has been renamed tooctokit.users.addEmailsForAuthenticated() - Breaking
octokit.users.checkFollowing()has been renamed tooctokit.users.checkPersonIsFollowedByAuthenticated() - Breaking
octokit.users.createGpgKey()has been renamed tooctokit.users.createGpgKeyForAuthenticated() - Breaking
octokit.users.createPublicKey()has been renamed tooctokit.users.createPublicSshKeyForAuthenticated() - Breaking
octokit.users.deleteEmails()has been renamed tooctokit.users.deleteEmailsForAuthenticated() - Breaking
octokit.users.deleteGpgKey()has been renamed tooctokit.users.deleteGpgKeyForAuthenticated() - Breaking
octokit.users.deletePublicKey()has been renamed tooctokit.users.deletePublicSshKeyForAuthenticated() - Breaking
octokit.users.getGpgKey()has been renamed tooctokit.users.getGpgKeyForAuthenticated() - Breaking
octokit.users.getPublicKey()has been renamed tooctokit.users.getPublicSshKeyForAuthenticated() - Breaking
octokit.users.listBlocked()has been renamed tooctokit.users.listBlockedByAuthenticated() - Breaking
octokit.users.listEmails()has been renamed tooctokit.users.listEmailsForAuthenticated() - Breaking
octokit.users.listFollowingForAuthenticatedUser()has been renamed tooctokit.users.listFollowedByAuthenticated() - Breaking
octokit.users.listGpgKeys()has been renamed tooctokit.users.listGpgKeysForAuthenticated() - Breaking
octokit.users.listPublicEmails()has been renamed tooctokit.users.listPublicEmailsForAuthenticatedUser() - Breaking
octokit.users.listPublicKeys()has been renamed tooctokit.users.listPublicSshKeysForAuthenticated() - Breaking
octokit.users.togglePrimaryEmailVisibility()has been renamed tooctokit.users.setPrimaryEmailVisibilityForAuthenticated()
- 3.x
3.17.0
7 Jun 2020- Deprecated
repos.getProtectedBranchRestrictions - Deprecated
pulls.getCommentsForReview - Deprecated
pulls.deleteReviewRequest
Features
repos.getAccessRestrictionspulls.listCommentsForReviewpulls.removeRequestedReviewerspulls.requestReviewerspulls.listRequestedReviewerspulls.createReplyForReviewCommentpulls.createReviewCommentpulls.listReviewCommentspulls.deleteReviewCommentpulls.updateReviewCommentpulls.getReviewCommentpulls.listReviewCommentsForRepoprojects.getPermissionForUserorgs.listPublicEmailsForAuthenticatedUserorgs.updateMembershipForAuthenticatedUserorgs.listMembershipsForAuthenticatedUserusers.deletePublicSshKeyForAuthenticatedusers.getPublicSshKeyForAuthenticatedusers.createPublicSshKeyForAuthenticatedusers.listPublicSshKeysForAuthenticatedusers.deleteGpgKeyForAuthenticatedusers.getGpgKeyForAuthenticatedusers.createGpgKeyForAuthenticatedusers.listGpgKeysForAuthenticatedusers.checkPersonIsFollowedByAuthenticatedusers.deleteEmailsForAuthenticatedusers.addEmailsForAuthenticatedusers.listEmailsForAuthenticatedusers.setPrimaryEmailVisibilityForAuthenticatedusers.listBlockedByAuthenticatedscim.deleteUserFromOrgscim.updateAttributeForUserscim.setInformationForProvisionedUserscim.getProvisioningInformationForUserscim.provisionAndInviteUserrepos.downloadArchiverepos.createCommitStatusrepos.listReleaseAssetsrepos.requestPagesBuildrepos.deletePagesSiterepos.createPagesSiterepos.deleteDeployKeyrepos.createDeployKeytestPushWebhookpingWebhookdeleteWebhookupdateWebhookgetWebhookcreateWebhooklistWebhooksrepos.createOrUpdateFileContentsrepos.getContentrepos.getCommunityProfileMetricsrepos.listCommitStatusesForRefrepos.listCommitCommentsrepos.removeUserAccessRestrictionsrepos.addUserAccessRestrictionsrepos.setUserAccessRestrictionsrepos.removeTeamAccessRestrictionsrepos.addTeamAccessRestrictionsrepos.setTeamAccessRestrictionsrepos.removeAppAccessRestrictionsrepos.addAppAccessRestrictionsrepos.setAppAccessRestrictionsrepos.removeProtectedBranchRestrictionsrepos.removeStatusCheckContextsrepos.addStatusCheckContextsrepos.setStatusCheckContextsrepos.getAllStatusCheckContextsrepos.removeStatusChecksProtectionrepos.updateStatusChecksProtectionrepos.getStatusChecksProtectionrepos.deleteCommitSignatureProtectionrepos.createCommitSignatureProtectionrepos.getCommitSignatureProtectionrepos.deletePullRequestReviewProtectionrepos.updatePullRequestReviewProtectionrepos.getPullRequestReviewProtectionrepos.deleteAdminBranchProtectionrepos.setAdminBranchProtectionrepos.getAdminBranchProtectionrepos.deleteBranchProtectionorgs.removePublicMembershipForAuthenticatedUserorgs.setPublicMembershipForAuthenticatedUserorgs.checkPublicMembershipForUserorgs.removeMembershipForUserorgs.setMembershipForUserorgs.getMembershipForUserorgs.checkMembershipForUserorgs.listAppInstallationsorgs.pingHookorgs.deleteHookorgs.updateHookorgs.getHookorgs.createHookorgs.listHooksorgs.removeCredentialAuthorizationorgs.listSamlSsoAuthorizationsrepos.listCommitCommentsForRepo
Deprecations
- Deprecated
repos.getProtectedBranchRestrictions - Deprecated
pulls.getCommentsForReview - Deprecated
pulls.deleteReviewRequest - Deprecated
pulls.createReviewRequest - Deprecated
pulls.listReviewRequests - Deprecated
pulls.createReviewCommentReply - Deprecated
pulls.createComment - Deprecated
pulls.listComments - Deprecated
pulls.deleteComment - Deprecated
pulls.updateComment - Deprecated
pulls.getComment - Deprecated
pulls.listCommentsForRepo - Deprecated
projects.reviewUserPermissionLevel - Deprecated
orgs.listPublicEmails - Deprecated
orgs.updateMembership - Deprecated
orgs.listMemberships - Deprecated
users.deletePublicKey - Deprecated
users.getPublicKey - Deprecated
users.createPublicKey - Deprecated
users.listPublicKeys - Deprecated
users.deleteGpgKey - Deprecated
users.getGpgKey - Deprecated
users.createGpgKey - Deprecated
users.listGpgKeys - Deprecated
users.checkFollowing - Deprecated
users.deleteEmailsForAuthenticated - Deprecated
users.addEmailsForAuthenticated - Deprecated
users.listEmailsForAuthenticated - Deprecated
users.togglePrimaryEmailVisibility - Deprecated
users.listBlocked - Deprecated
scim.removeUserFromOrg - Deprecated
scim.updateUserAttribute - Deprecated
scim.replaceProvisionedUserInformation - Deprecated
scim.getProvisioningDetailsForUser - Deprecated
scim.provisionAndInviteUsers - Deprecated
repos.getArchiveLink - Deprecated
repos.createStatus - Deprecated
repos.listAssetsForRelease - Deprecated
repos.requestPageBuild - Deprecated
repos.disbalePagesSite - Deprecated
repos.enablePagesSite - Deprecated
repos.removeDeployKey - Deprecated
repos.addDeployKey - Deprecated
testPushHook - Deprecated
pingHook - Deprecated
deleteHook - Deprecated
updateHook - Deprecated
getHook - Deprecated
createHook - Deprecated
listHooks - Deprecated
repos.createOrUpdateFile - Deprecated
repos.getContents - Deprecated
repos.retrieveCommunityProfileMetrics - Deprecated
repos.listStatusesForRef - Deprecated
repos.listCommentsForCommit - Deprecated
repos.removeProtectedBranchUserRestrictions - Deprecated
repos.addProtectedBranchUserRestrictions - Deprecated
repos.replaceProtectedBranchUserRestrictions - Deprecated
repos.removeProtectedBranchTeamRestrictions - Deprecated
repos.addProtectedBranchTeamRestrictions - Deprecated
repos.replaceProtectedBranchTeamRestrictions - Deprecated
repos.removeProtectedBranchAppRestrictions - Deprecated
repos.addProtectedBranchAppRestrictions - Deprecated
repos.replaceProtectedBranchAppRestrictions - Deprecated
repos.deleteAccessRestrictions - Deprecated
repos.removeProtectedBranchRequiredStatusChecksContexts - Deprecated
repos.addProtectedBranchRequiredStatusChecksContexts - Deprecated
repos.replaceProtectedBranchRequiredStatusChecksContexts - Deprecated
repos.listProtectedBranchRequiredStatusChecksContexts - Deprecated
repos.removeProtectedBranchRequiredStatusChecks - Deprecated
repos.updateProtectedBranchRequiredStatusChecks - Deprecated
repos.getProtectedBranchRequiredStatusChecks - Deprecated
repos.removeProtectedBranchRequiredSignatures - Deprecated
repos.addProtectedBranchRequiredSignatures - Deprecated
repos.getProtectedBranchRequiredSignatures - Deprecated
repos.removeProtectedBranchPullRequestReviewEnforcement - Deprecated
repos.updateProtectedBranchPullRequestReviewEnforcement - Deprecated
repos.getProtectedBranchPullRequestReviewEnforcement - Deprecated
repos.removeProtectedBranchAdminEnforcement - Deprecated
repos.addProtectedBranchAdminEnforcement - Deprecated
repos.getProtectedBranchAdminEnforcement - Deprecated
repos.removeBranchProtection - Deprecated
orgs.concealMembership - Deprecated
orgs.publicizeMembership - Deprecated
orgs.checkPublicMembership - Deprecated
orgs.removeMembership - Deprecated
orgs.addOrUpdateMembership - Deprecated
orgs.getMembership - Deprecated
orgs.checkMembership - Deprecated
orgs.listInstallations - Deprecated
orgs.pingWebhook - Deprecated
orgs.deleteWebhook - Deprecated
orgs.updateWebhook - Deprecated
orgs.getWebhook - Deprecated
orgs.createWebhook - Deprecated
orgs.listWebhooks - Deprecated
orgs.removeSamlSsoAuthorization - Deprecated
orgs.listCredentialAuthorizations - Deprecated
repos.listCommitComments.
3.16.0
5 Jun 2020- Deprecated
gitignore.listTemplates - Deprecated
licenses.listCommonlyUsed gitignore.getAllTemplates
Features
gitignore.getAllTemplateslicenses.getAllCommonlyUsed
Deprecations
- Deprecated
gitignore.listTemplates - Deprecated
licenses.listCommonlyUsed
3.15.0
4 Jun 2020- Deprecated
actions.downloadWorkflowJobLogs - Deprecated
actions.getWorkflowJob - Deprecated
actions.listRepoWorkflowRuns
Features
actions.downloadJobLogsForWorkflowRunactions.getJobForWorkflowRunactions.listWorkflowRunsForRepoactions.createInstallationAccessTokenapps.listReposAccessibleToInstallationapps.revokeInstallationAccessTokeninteractions.setRestrictionsForOrginteractions.setRestrictionsForRepo.
Deprecations
- Deprecated
actions.downloadWorkflowJobLogs - Deprecated
actions.getWorkflowJob - Deprecated
actions.listRepoWorkflowRuns - Deprecated
actions.createInstallationToken - Deprecated
apps.listRepos - Deprecated
apps.revokeInstallationToken - Deprecated
interactions.addOrUpdateRestrictionsForOrg - Deprecated
interactions.addOrUpdateRestrictionsForRepo - Deprecated
issues.replaceAllLabels
3.14.0
2 Jun 2020teams.getMembershipForUserInOrgteams.addOrUpdateMembershipForUserInOrgteams.removeMembershipForUserInOrg
Features
teams.getMembershipForUserInOrgteams.addOrUpdateMembershipForUserInOrgteams.removeMembershipForUserInOrgteams.addOrUpdateProjectPermissionsInOrgteams.checkPermissionsForProjectInOrgteams.checkPermissionsForRepoInOrgteams.addOrUpdateRepoPermissionsInOrgissues.checkUserCanBeAssignedmigrations.getImportStatusissues.listMilestones
Bug Fixes
typescript: replace duplicated keys in method and parameter/response types
3.13.3
1 Jun 2020typescript:
repository_selectionresponse key is an enum string
3.13.2
31 May 2020typescript:
node_idin git commit responses
3.13.1
30 May 2020submitted_atresponse key for pull request endpoint methods
3.13.0
29 May 2020twitter_usernameproperty for users and organizations
3.12.3
28 May 2020typescript: method description updates
3.12.2
18 May 2020Handle deprecated parameters
3.12.1
18 May 2020Recover deprecated
octokit.actions.deleteSecretFromRepo()method, send correct request foroctokit.actions.createOrUpdateSecretForRepo()
3.12.0
17 May 2020Organization secrets endpoint methods
3.11.1
17 May 2020`git.gists.update({ gist_id, files })
3.11.0
11 May 2020typescript: optional
refparameter for.codeScanning.listAlertsForRepo()method
3.10.0
6 May 2020octokit.codeScanning.{getAlert,listAlertsForRepo}
3.9.0
5 May 2020octokit.actions.downloadWorkflow{Job,Run}logs,octokit.apps.{suspend,unsuspend}Installation. Deprecatesoctokit.actions.listWorkflow{Job,Run}Logs
3.8.0
22 Apr 2020Remove incorrect
?{page,per_page}parametersNew endpoints for self hosted runners in organizations
3.7.1
20 Apr 2020"Circular definition of import alias RestEndpointMethodTypes" error
typescript: define
.defaults()method on rest endpoint method types
3.7.0
20 Apr 2020typescript:
import { RestEndpointMethodTypes } from "@octokit/plugin-rest-endpoint-methods"
3.6.0
16 Apr 2020octokit.actions.deleteWorkflowRunLogs()
3.5.2
12 Apr 2020TypeScript: description updates
3.5.1
7 Apr 2020gambitpreview graduated
3.5.0
7 Apr 2020maintainandtriageuser permissions in orgs
3.4.0
26 Mar 2020octokit.activity.checkStarringRepo()->octokit.activity.checkRepoIsStarredByAuthenticatedUser()octokit.activity.listEventsForOrg()->octokit.activity.listOrgEventsForAuthenticatedUser()octokit.activity.listEventsForUser()->octokit.activity.listEventsForAuthenticatedUser()
Renames
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
25 Mar 2020URL to GitHub Developer Guids
3.3.2
24 Mar 2020Preview and response type fixes
3.3.1
12 Mar 2020Fury preview is no longer required
3.3.0
11 Mar 2020New delete reaction endpoints. Deprecates
octokit.reactions.delete()New endpoints and deprecations coming from restructuring in GitHubs REST API docs
3.2.0
21 Feb 2020octokit.actions.listArtifactsForRepo()
3.1.1
18 Feb 2020typescript: action workflow run responses
3.1.0
18 Feb 2020octokit.repos.deleteDeployment()
3.0.1
13 Feb 2020typescript: pagination parameters for
octokit.issues.listCommentsForRepo()
3.0.0
6 Feb 2020- Breaking
Node 10 is no longer supported.
- Breaking
Parameters passed to endpoint methods such as
octokit.issues.create(parameters)are no longer validated on the client. We recommend using TypeScript or taking advantage of the TypeScript definitions in JavaScript. - Breaking
All deprecated methods and options have been removed. Upgrade to the latest
2.x.xversion and address all deprecation messages for an easy upgrade.
Breaking Changes
- Breaking
Node 10 is no longer supported.
- Breaking
Parameters passed to endpoint methods such as
octokit.issues.create(parameters)are no longer validated on the client. We recommend using TypeScript or taking advantage of the TypeScript definitions in JavaScript. - Breaking
All deprecated methods and options have been removed. Upgrade to the latest
2.x.xversion and address all deprecation messages for an easy upgrade.For deprecated endpoint methods that have no replacement, you can fall back to
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)
(see deprecation notice)octokit.oauthAuthorizations.deleteAuthorization()
➡octokit.request("DELETE /authorizations/:authorization_id", parameters)
(see deprecation notice)octokit.oauthAuthorizations.deleteGrant()
➡octokit.request("DELETE /applications/grants/:grant_id", parameters)
(see deprecation notice)octokit.oauthAuthorizations.getAuthorization()
➡octokit.request("GET /authorizations/:authorization_id", parameters)
(see deprecation notice)octokit.oauthAuthorizations.getGrant()
➡octokit.request("GET /applications/grants/:grant_id", parameters)
(see deprecation notice)octokit.oauthAuthorizations.getOrCreateAuthorizationForApp()
➡octokit.request("PUT /authorizations/clients/:client_id", parameters)
(see deprecation notice)octokit.oauthAuthorizations.getOrCreateAuthorizationForAppAndFingerprint()
➡octokit.request("PUT /authorizations/clients/:client_id/:fingerprint", parameters)
(see deprecation notice)octokit.oauthAuthorizations.listAuthorizations()
➡octokit.request("GET /authorizations", parameters)
(see deprecation notice)octokit.oauthAuthorizations.listGrants()
➡octokit.request("GET /applications/grants", parameters)
(see deprecation notice)octokit.oauthAuthorizations.updateAuthorization()
➡octokit.request("PATCH /authorizations/:authorization_id", parameters)
(see deprecation notice)octokit.pulls.createFromIssue()
➡octokit.request("POST /repos/:owner/:repo/pulls", parameters)
(see deprecation notice)octokit.repos.getCommitRefSha()
➡octokit.request("GET /repos/:owner/:repo/commits/:ref", parameters)
(see deprecation notice)octokit.teams.addMemberLegacy()
➡octokit.request("PUT /teams/:team_id/members/:username", parameters)
(see deprecation notice)octokit.teams.getLegacy()
➡octokit.request("GET /teams/:team_id", parameters)
(see deprecation notice)octokit.teams.getMemberLegacy()
➡octokit.request("GET /teams/:team_id/members/:username", parameters)
(see deprecation notice)octokit.teams.removeMemberLegacy()
➡octokit.request("DELETE /teams/:team_id/members/:username", parameters)
(see deprecation notice)
Methods have been replaced by new ones, some of which require new 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()
(An "org" parameter is now required)octokit.reactions.createForTeamDiscussionCommentLegacy()
➡octokit.reactions.createForTeamDiscussionCommentInOrg()
(An "org" parameter is now required)octokit.reactions.listForTeamDiscussionLegacy()
➡octokit.reactions.listForTeamDiscussionInOrg()
(An "org" parameter is now required)octokit.reactions.listForTeamDiscussionCommentLegacy()
➡octokit.reactions.listForTeamDiscussionCommentInOrg()
(An "org" parameter is now required)octokit.teams.addMemberLegacy()
➡octokit.teams.addMemberInOrg()
(An "org" parameter is now required)octokit.teams.addOrUpdateMembershipLegacy()
➡octokit.teams.addOrUpdateMembershipInOrg()
(An "org" parameter is now required)octokit.teams.addOrUpdateProjectLegacy()
➡octokit.teams.addOrUpdateProjectInOrg()
(An "org" parameter is now required)octokit.teams.addOrUpdateRepoLegacy()
➡octokit.teams.addOrUpdateRepoInOrg()
(An "org" parameter is now required)octokit.teams.checkManagesRepoLegacy()
➡octokit.teams.checkManagesRepoInOrg()
(An "org" parameter is now required)octokit.teams.createDiscussionLegacy()
➡octokit.teams.createDiscussionInOrg()
(An "org" parameter is now required)octokit.teams.createDiscussionCommentLegacy()
➡octokit.teams.createDiscussionCommentInOrg()
(An "org" parameter is now required)octokit.teams.deleteLegacy()
➡octokit.teams.deleteInOrg()
(An "org" parameter is now required)octokit.teams.deleteDiscussionLegacy()
➡octokit.teams.deleteDiscussionInOrg()
(An "org" parameter is now required)octokit.teams.deleteDiscussionCommentLegacy()
➡octokit.teams.deleteDiscussionCommentInOrg()
(An "org" parameter is now required)octokit.teams.getLegacy()
➡octokit.teams.getInOrg()
(An "org" parameter is now required)octokit.teams.getDiscussionLegacy()
➡octokit.teams.getDiscussionInOrg()
(An "org" parameter is now required)octokit.teams.getDiscussionCommentLegacy()
➡octokit.teams.getDiscussionCommentInOrg()
(An "org" parameter is now required)octokit.teams.getMemberLegacy()
➡octokit.teams.getMemberInOrg()
(An "org" parameter is now required)octokit.teams.getMembershipLegacy()
➡octokit.teams.getMembershipInOrg()
(An "org" parameter is now required)octokit.teams.listChildLegacy()
➡octokit.teams.listChildInOrg()
(An "org" parameter is now required)octokit.teams.listDiscussionCommentsLegacy()
➡octokit.teams.listDiscussionCommentsInOrg()
(An "org" parameter is now required)octokit.teams.listDiscussionsLegacy()
➡octokit.teams.listDiscussionsInOrg()
(An "org" parameter is now required)octokit.teams.listMembersLegacy()
➡octokit.teams.listMembersInOrg()
(An "org" parameter is now required)octokit.teams.listPendingInvitationsLegacy()
➡octokit.teams.listPendingInvitationsInOrg()
(An "org" parameter is now required)octokit.teams.listProjectsLegacy()
➡octokit.teams.listProjectsInOrg()
(An "org" parameter is now required)octokit.teams.listReposLegacy()
➡octokit.teams.listReposInOrg()
(An "org" parameter is now required)octokit.teams.removeMemberLegacy()
➡octokit.teams.removeMemberInOrg()
(An "org" parameter is now required)octokit.teams.removeMembershipLegacy()
➡octokit.teams.removeMembershipInOrg()
(An "org" parameter is now required)octokit.teams.removeProjectLegacy()
➡octokit.teams.removeProjectInOrg()
(An "org" parameter is now required)octokit.teams.removeRepoLegacy()
➡octokit.teams.removeRepoInOrg()
(An "org" parameter is now required)octokit.teams.reviewProjectLegacy()
➡octokit.teams.reviewProjectInOrg()
(An "org" parameter is now required)octokit.teams.updateLegacy()
➡octokit.teams.updateInOrg()
(An "org" parameter is now required)octokit.teams.updateDiscussionLegacy()
➡octokit.teams.updateDiscussionInOrg()
(An "org" parameter is now required)octokit.teams.updateDiscussionCommentLegacy()
➡octokit.teams.updateDiscussionCommentInOrg()
(An "org" parameter is now required)octokit.issues.updateLabel({current_name, name})
➡octokit.issues.updateLabel({name, new_name})
(current_nameis nowname,nameis nownew_name)
Features
Reduction in bundle size: 15.3kb down to 6.3kB
octokit.repos.uploadReleaseAsset(parameters)now accepts URL parametersownerreporelease_id
Passing
urlwill still work, but is not recommended. Useoctokit.requestinstead:octokit.request(url, { method: "POST", ...parameters })
- 2.x
2.4.1
7 Oct 2020octokit.git.listRefs()logs deprecation
2.4.0
3 Feb 2020- Deprecated
Deprecate
octokit.gitdata.*,octokit.pullRequests.*
2.3.0
2 Feb 2020Octokit.actions.listDownloadsForSelfHostedRunnerApplication()
2.2.0
31 Jan 2020fileparameter is nowdatafor.repos.uploadReleaseAsset()
2.1.3
31 Jan 2020Typescript: update types for latest endpoint methods
2.1.2
29 Jan 2020key_idparameter is a string, not integer
2.1.1
28 Jan 2020package: remove peer dependency
2.1.0
27 Jan 2020Methods for new GitHub Actions endpoints
2.0.1
26 Jan 2020- Deprecated
Deprecated endpoint methods have .endpoint() method, too
Typescript: update to latest
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.