Enum github_rest::end_points::EndPoints

pub enum EndPoints {
    Get(),
    GetApp(),
    PostAppManifestscodeConversions(String),
    GetAppHookConfig(),
    PatchAppHookConfig(),
    GetAppHookDeliveries(),
    GetAppHookDeliveriesdeliveryId(String),
    PostAppHookDeliveriesdeliveryIdAttempts(String),
    GetAppInstallations(),
    GetAppInstallationsinstallationId(String),
    DeleteAppInstallationsinstallationId(String),
    PostAppInstallationsinstallationIdAccessTokens(String),
    PutAppInstallationsinstallationIdSuspended(String),
    DeleteAppInstallationsinstallationIdSuspended(String),
    GetApplicationsGrants(),
    GetApplicationsGrantsgrantId(String),
    DeleteApplicationsGrantsgrantId(String),
    DeleteApplicationsclientIdGrant(String),
    PostApplicationsclientIdToken(String),
    PatchApplicationsclientIdToken(String),
    DeleteApplicationsclientIdToken(String),
    PostApplicationsclientIdTokenScoped(String),
    GetAppsappSlug(String),
    GetAuthorizations(),
    PostAuthorizations(),
    PutAuthorizationsClientsclientId(String),
    PutAuthorizationsClientsclientIdfingerprint(String, String),
    GetAuthorizationsauthorizationId(String),
    PatchAuthorizationsauthorizationId(String),
    DeleteAuthorizationsauthorizationId(String),
    GetCodesOfConduct(),
    GetCodesOfConductkey(String),
    GetEmojis(),
    GetEnterprisesenterpriseActionsPermissions(String),
    PutEnterprisesenterpriseActionsPermissions(String),
    GetEnterprisesenterpriseActionsPermissionsOrganizations(String),
    PutEnterprisesenterpriseActionsPermissionsOrganizations(String),
    PutEnterprisesenterpriseActionsPermissionsOrganizationsorgId(String, String),
    DeleteEnterprisesenterpriseActionsPermissionsOrganizationsorgId(String, String),
    GetEnterprisesenterpriseActionsPermissionsSelectedActions(String),
    PutEnterprisesenterpriseActionsPermissionsSelectedActions(String),
    GetEnterprisesenterpriseActionsRunnerGroups(String),
    PostEnterprisesenterpriseActionsRunnerGroups(String),
    GetEnterprisesenterpriseActionsRunnerGroupsrunnerGroupId(String, String),
    PatchEnterprisesenterpriseActionsRunnerGroupsrunnerGroupId(String, String),
    DeleteEnterprisesenterpriseActionsRunnerGroupsrunnerGroupId(String, String),
    GetEnterprisesenterpriseActionsRunnerGroupsrunnerGroupIdOrganizations(String, String),
    PutEnterprisesenterpriseActionsRunnerGroupsrunnerGroupIdOrganizations(String, String),
    PutEnterprisesenterpriseActionsRunnerGroupsrunnerGroupIdOrganizationsorgId(String, String, String),
    DeleteEnterprisesenterpriseActionsRunnerGroupsrunnerGroupIdOrganizationsorgId(String, String, String),
    GetEnterprisesenterpriseActionsRunnerGroupsrunnerGroupIdRunners(String, String),
    PutEnterprisesenterpriseActionsRunnerGroupsrunnerGroupIdRunners(String, String),
    PutEnterprisesenterpriseActionsRunnerGroupsrunnerGroupIdRunnersrunnerId(String, String, String),
    DeleteEnterprisesenterpriseActionsRunnerGroupsrunnerGroupIdRunnersrunnerId(String, String, String),
    GetEnterprisesenterpriseActionsRunners(String),
    GetEnterprisesenterpriseActionsRunnersDownloads(String),
    PostEnterprisesenterpriseActionsRunnersRegistrationToken(String),
    PostEnterprisesenterpriseActionsRunnersRemoveToken(String),
    GetEnterprisesenterpriseActionsRunnersrunnerId(String, String),
    DeleteEnterprisesenterpriseActionsRunnersrunnerId(String, String),
    GetEnterprisesenterpriseActionsRunnersrunnerIdLabels(String, String),
    PostEnterprisesenterpriseActionsRunnersrunnerIdLabels(String, String),
    PutEnterprisesenterpriseActionsRunnersrunnerIdLabels(String, String),
    DeleteEnterprisesenterpriseActionsRunnersrunnerIdLabels(String, String),
    DeleteEnterprisesenterpriseActionsRunnersrunnerIdLabelsname(String, String, String),
    GetEnterprisesenterpriseAuditLog(String),
    GetEnterprisesenterpriseSecretScanningAlerts(String),
    GetEnterprisesenterpriseSettingsBillingActions(String),
    GetEnterprisesenterpriseSettingsBillingAdvancedSecurity(String),
    GetEnterprisesenterpriseSettingsBillingPackages(String),
    GetEnterprisesenterpriseSettingsBillingSharedStorage(String),
    GetEvents(),
    GetFeeds(),
    GetGists(),
    PostGists(),
    GetGistsPublic(),
    GetGistsStarred(),
    GetGistsgistId(String),
    PatchGistsgistId(String),
    DeleteGistsgistId(String),
    GetGistsgistIdComments(String),
    PostGistsgistIdComments(String),
    GetGistsgistIdCommentscommentId(String, String),
    PatchGistsgistIdCommentscommentId(String, String),
    DeleteGistsgistIdCommentscommentId(String, String),
    GetGistsgistIdCommits(String),
    GetGistsgistIdForks(String),
    PostGistsgistIdForks(String),
    GetGistsgistIdStar(String),
    PutGistsgistIdStar(String),
    DeleteGistsgistIdStar(String),
    GetGistsgistIdsha(String, String),
    GetGitignoreTemplates(),
    GetGitignoreTemplatesname(String),
    GetInstallationRepositories(),
    DeleteInstallationToken(),
    GetIssues(),
    GetLicenses(),
    GetLicenseslicense(String),
    PostMarkdown(),
    PostMarkdownRaw(),
    GetMarketplaceListingAccountsaccountId(String),
    GetMarketplaceListingPlans(),
    GetMarketplaceListingPlansplanIdAccounts(String),
    GetMarketplaceListingStubbedAccountsaccountId(String),
    GetMarketplaceListingStubbedPlans(),
    GetMarketplaceListingStubbedPlansplanIdAccounts(String),
    GetMeta(),
    GetNetworksownerrepoEvents(String, String),
    GetNotifications(),
    PutNotifications(),
    GetNotificationsThreadsthreadId(String),
    PatchNotificationsThreadsthreadId(String),
    GetNotificationsThreadsthreadIdSubscription(String),
    PutNotificationsThreadsthreadIdSubscription(String),
    DeleteNotificationsThreadsthreadIdSubscription(String),
    GetOctocat(),
    GetOrganizations(),
    GetOrganizationsorganizationIdCustomRoles(String),
    GetOrganizationsorgTeamteamSlugExternalGroups(String, String),
    GetOrgsorg(String),
    PatchOrgsorg(String),
    GetOrgsorgActionsPermissions(String),
    PutOrgsorgActionsPermissions(String),
    GetOrgsorgActionsPermissionsRepositories(String),
    PutOrgsorgActionsPermissionsRepositories(String),
    PutOrgsorgActionsPermissionsRepositoriesrepositoryId(String, String),
    DeleteOrgsorgActionsPermissionsRepositoriesrepositoryId(String, String),
    GetOrgsorgActionsPermissionsSelectedActions(String),
    PutOrgsorgActionsPermissionsSelectedActions(String),
    GetOrgsorgActionsPermissionsWorkflow(String),
    PutOrgsorgActionsPermissionsWorkflow(String),
    GetOrgsorgActionsRunnerGroups(String),
    PostOrgsorgActionsRunnerGroups(String),
    GetOrgsorgActionsRunnerGroupsrunnerGroupId(String, String),
    PatchOrgsorgActionsRunnerGroupsrunnerGroupId(String, String),
    DeleteOrgsorgActionsRunnerGroupsrunnerGroupId(String, String),
    GetOrgsorgActionsRunnerGroupsrunnerGroupIdRepositories(String, String),
    PutOrgsorgActionsRunnerGroupsrunnerGroupIdRepositories(String, String),
    PutOrgsorgActionsRunnerGroupsrunnerGroupIdRepositoriesrepositoryId(String, String, String),
    DeleteOrgsorgActionsRunnerGroupsrunnerGroupIdRepositoriesrepositoryId(String, String, String),
    GetOrgsorgActionsRunnerGroupsrunnerGroupIdRunners(String, String),
    PutOrgsorgActionsRunnerGroupsrunnerGroupIdRunners(String, String),
    PutOrgsorgActionsRunnerGroupsrunnerGroupIdRunnersrunnerId(String, String, String),
    DeleteOrgsorgActionsRunnerGroupsrunnerGroupIdRunnersrunnerId(String, String, String),
    GetOrgsorgActionsRunners(String),
    GetOrgsorgActionsRunnersDownloads(String),
    PostOrgsorgActionsRunnersRegistrationToken(String),
    PostOrgsorgActionsRunnersRemoveToken(String),
    GetOrgsorgActionsRunnersrunnerId(String, String),
    DeleteOrgsorgActionsRunnersrunnerId(String, String),
    GetOrgsorgActionsRunnersrunnerIdLabels(String, String),
    PostOrgsorgActionsRunnersrunnerIdLabels(String, String),
    PutOrgsorgActionsRunnersrunnerIdLabels(String, String),
    DeleteOrgsorgActionsRunnersrunnerIdLabels(String, String),
    DeleteOrgsorgActionsRunnersrunnerIdLabelsname(String, String, String),
    GetOrgsorgActionsSecrets(String),
    GetOrgsorgActionsSecretsPublicKey(String),
    GetOrgsorgActionsSecretssecretName(String, String),
    PutOrgsorgActionsSecretssecretName(String, String),
    DeleteOrgsorgActionsSecretssecretName(String, String),
    GetOrgsorgActionsSecretssecretNameRepositories(String, String),
    PutOrgsorgActionsSecretssecretNameRepositories(String, String),
    PutOrgsorgActionsSecretssecretNameRepositoriesrepositoryId(String, String, String),
    DeleteOrgsorgActionsSecretssecretNameRepositoriesrepositoryId(String, String, String),
    GetOrgsorgAuditLog(String),
    GetOrgsorgBlocks(String),
    GetOrgsorgBlocksusername(String, String),
    PutOrgsorgBlocksusername(String, String),
    DeleteOrgsorgBlocksusername(String, String),
    GetOrgsorgCodeScanningAlerts(String),
    GetOrgsorgCredentialAuthorizations(String),
    DeleteOrgsorgCredentialAuthorizationscredentialId(String, String),
    GetOrgsorgDependabotSecrets(String),
    GetOrgsorgDependabotSecretsPublicKey(String),
    GetOrgsorgDependabotSecretssecretName(String, String),
    PutOrgsorgDependabotSecretssecretName(String, String),
    DeleteOrgsorgDependabotSecretssecretName(String, String),
    GetOrgsorgDependabotSecretssecretNameRepositories(String, String),
    PutOrgsorgDependabotSecretssecretNameRepositories(String, String),
    PutOrgsorgDependabotSecretssecretNameRepositoriesrepositoryId(String, String, String),
    DeleteOrgsorgDependabotSecretssecretNameRepositoriesrepositoryId(String, String, String),
    GetOrgsorgEvents(String),
    GetOrgsorgExternalGroupgroupId(String, String),
    GetOrgsorgExternalGroups(String),
    GetOrgsorgFailedInvitations(String),
    GetOrgsorgHooks(String),
    PostOrgsorgHooks(String),
    GetOrgsorgHookshookId(String, String),
    PatchOrgsorgHookshookId(String, String),
    DeleteOrgsorgHookshookId(String, String),
    GetOrgsorgHookshookIdConfig(String, String),
    PatchOrgsorgHookshookIdConfig(String, String),
    GetOrgsorgHookshookIdDeliveries(String, String),
    GetOrgsorgHookshookIdDeliveriesdeliveryId(String, String, String),
    PostOrgsorgHookshookIdDeliveriesdeliveryIdAttempts(String, String, String),
    PostOrgsorgHookshookIdPings(String, String),
    GetOrgsorgInstallation(String),
    GetOrgsorgInstallations(String),
    GetOrgsorgInteractionLimits(String),
    PutOrgsorgInteractionLimits(String),
    DeleteOrgsorgInteractionLimits(String),
    GetOrgsorgInvitations(String),
    PostOrgsorgInvitations(String),
    DeleteOrgsorgInvitationsinvitationId(String, String),
    GetOrgsorgInvitationsinvitationIdTeams(String, String),
    GetOrgsorgIssues(String),
    GetOrgsorgMembers(String),
    GetOrgsorgMembersusername(String, String),
    DeleteOrgsorgMembersusername(String, String),
    GetOrgsorgMembershipsusername(String, String),
    PutOrgsorgMembershipsusername(String, String),
    DeleteOrgsorgMembershipsusername(String, String),
    GetOrgsorgMigrations(String),
    PostOrgsorgMigrations(String),
    GetOrgsorgMigrationsmigrationId(String, String),
    GetOrgsorgMigrationsmigrationIdArchive(String, String),
    DeleteOrgsorgMigrationsmigrationIdArchive(String, String),
    DeleteOrgsorgMigrationsmigrationIdReposrepoNameLock(String, String, String),
    GetOrgsorgMigrationsmigrationIdRepositories(String, String),
    GetOrgsorgOutsideCollaborators(String),
    PutOrgsorgOutsideCollaboratorsusername(String, String),
    DeleteOrgsorgOutsideCollaboratorsusername(String, String),
    GetOrgsorgPackages(String),
    GetOrgsorgPackagespackageTypepackageName(String, String, String),
    DeleteOrgsorgPackagespackageTypepackageName(String, String, String),
    PostOrgsorgPackagespackageTypepackageNameRestore(String, String, String),
    GetOrgsorgPackagespackageTypepackageNameVersions(String, String, String),
    GetOrgsorgPackagespackageTypepackageNameVersionspackageVersionId(String, String, String, String),
    DeleteOrgsorgPackagespackageTypepackageNameVersionspackageVersionId(String, String, String, String),
    PostOrgsorgPackagespackageTypepackageNameVersionspackageVersionIdRestore(String, String, String, String),
    GetOrgsorgProjects(String),
    PostOrgsorgProjects(String),
    GetOrgsorgPublicMembers(String),
    GetOrgsorgPublicMembersusername(String, String),
    PutOrgsorgPublicMembersusername(String, String),
    DeleteOrgsorgPublicMembersusername(String, String),
    GetOrgsorgRepos(String),
    PostOrgsorgRepos(String),
    GetOrgsorgSecretScanningAlerts(String),
    GetOrgsorgSettingsBillingActions(String),
    GetOrgsorgSettingsBillingAdvancedSecurity(String),
    GetOrgsorgSettingsBillingPackages(String),
    GetOrgsorgSettingsBillingSharedStorage(String),
    GetOrgsorgTeamSyncGroups(String),
    GetOrgsorgTeams(String),
    PostOrgsorgTeams(String),
    GetOrgsorgTeamsteamSlug(String, String),
    PatchOrgsorgTeamsteamSlug(String, String),
    DeleteOrgsorgTeamsteamSlug(String, String),
    GetOrgsorgTeamsteamSlugDiscussions(String, String),
    PostOrgsorgTeamsteamSlugDiscussions(String, String),
    GetOrgsorgTeamsteamSlugDiscussionsdiscussionNumber(String, String, String),
    PatchOrgsorgTeamsteamSlugDiscussionsdiscussionNumber(String, String, String),
    DeleteOrgsorgTeamsteamSlugDiscussionsdiscussionNumber(String, String, String),
    GetOrgsorgTeamsteamSlugDiscussionsdiscussionNumberComments(String, String, String),
    PostOrgsorgTeamsteamSlugDiscussionsdiscussionNumberComments(String, String, String),
    GetOrgsorgTeamsteamSlugDiscussionsdiscussionNumberCommentscommentNumber(String, String, String, String),
    PatchOrgsorgTeamsteamSlugDiscussionsdiscussionNumberCommentscommentNumber(String, String, String, String),
    DeleteOrgsorgTeamsteamSlugDiscussionsdiscussionNumberCommentscommentNumber(String, String, String, String),
    GetOrgsorgTeamsteamSlugDiscussionsdiscussionNumberCommentscommentNumberReactions(String, String, String, String),
    PostOrgsorgTeamsteamSlugDiscussionsdiscussionNumberCommentscommentNumberReactions(String, String, String, String),
    DeleteOrgsorgTeamsteamSlugDiscussionsdiscussionNumberCommentscommentNumberReactionsreactionId(String, String, String, String, String),
    GetOrgsorgTeamsteamSlugDiscussionsdiscussionNumberReactions(String, String, String),
    PostOrgsorgTeamsteamSlugDiscussionsdiscussionNumberReactions(String, String, String),
    DeleteOrgsorgTeamsteamSlugDiscussionsdiscussionNumberReactionsreactionId(String, String, String, String),
    PatchOrgsorgTeamsteamSlugExternalGroups(String, String),
    DeleteOrgsorgTeamsteamSlugExternalGroups(String, String),
    GetOrgsorgTeamsteamSlugInvitations(String, String),
    GetOrgsorgTeamsteamSlugMembers(String, String),
    GetOrgsorgTeamsteamSlugMembershipsusername(String, String, String),
    PutOrgsorgTeamsteamSlugMembershipsusername(String, String, String),
    DeleteOrgsorgTeamsteamSlugMembershipsusername(String, String, String),
    GetOrgsorgTeamsteamSlugProjects(String, String),
    GetOrgsorgTeamsteamSlugProjectsprojectId(String, String, String),
    PutOrgsorgTeamsteamSlugProjectsprojectId(String, String, String),
    DeleteOrgsorgTeamsteamSlugProjectsprojectId(String, String, String),
    GetOrgsorgTeamsteamSlugRepos(String, String),
    GetOrgsorgTeamsteamSlugReposownerrepo(String, String, String, String),
    PutOrgsorgTeamsteamSlugReposownerrepo(String, String, String, String),
    DeleteOrgsorgTeamsteamSlugReposownerrepo(String, String, String, String),
    GetOrgsorgTeamsteamSlugTeamSyncGroupMappings(String, String),
    PatchOrgsorgTeamsteamSlugTeamSyncGroupMappings(String, String),
    GetOrgsorgTeamsteamSlugTeams(String, String),
    GetProjectsColumnsCardscardId(String),
    PatchProjectsColumnsCardscardId(String),
    DeleteProjectsColumnsCardscardId(String),
    PostProjectsColumnsCardscardIdMoves(String),
    GetProjectsColumnscolumnId(String),
    PatchProjectsColumnscolumnId(String),
    DeleteProjectsColumnscolumnId(String),
    GetProjectsColumnscolumnIdCards(String),
    PostProjectsColumnscolumnIdCards(String),
    PostProjectsColumnscolumnIdMoves(String),
    GetProjectsprojectId(String),
    PatchProjectsprojectId(String),
    DeleteProjectsprojectId(String),
    GetProjectsprojectIdCollaborators(String),
    PutProjectsprojectIdCollaboratorsusername(String, String),
    DeleteProjectsprojectIdCollaboratorsusername(String, String),
    GetProjectsprojectIdCollaboratorsusernamePermission(String, String),
    GetProjectsprojectIdColumns(String),
    PostProjectsprojectIdColumns(String),
    GetRateLimit(),
    DeleteReactionsreactionId(String),
    GetReposownerrepo(String, String),
    PatchReposownerrepo(String, String),
    DeleteReposownerrepo(String, String),
    GetReposownerrepoActionsArtifacts(String, String),
    GetReposownerrepoActionsArtifactsartifactId(String, String, String),
    DeleteReposownerrepoActionsArtifactsartifactId(String, String, String),
    GetReposownerrepoActionsArtifactsartifactIdarchiveFormat(String, String, String, String),
    GetReposownerrepoActionsJobsjobId(String, String, String),
    GetReposownerrepoActionsJobsjobIdLogs(String, String, String),
    GetReposownerrepoActionsPermissions(String, String),
    PutReposownerrepoActionsPermissions(String, String),
    GetReposownerrepoActionsPermissionsSelectedActions(String, String),
    PutReposownerrepoActionsPermissionsSelectedActions(String, String),
    GetReposownerrepoActionsRunners(String, String),
    GetReposownerrepoActionsRunnersDownloads(String, String),
    PostReposownerrepoActionsRunnersRegistrationToken(String, String),
    PostReposownerrepoActionsRunnersRemoveToken(String, String),
    GetReposownerrepoActionsRunnersrunnerId(String, String, String),
    DeleteReposownerrepoActionsRunnersrunnerId(String, String, String),
    GetReposownerrepoActionsRunnersrunnerIdLabels(String, String, String),
    PostReposownerrepoActionsRunnersrunnerIdLabels(String, String, String),
    PutReposownerrepoActionsRunnersrunnerIdLabels(String, String, String),
    DeleteReposownerrepoActionsRunnersrunnerIdLabels(String, String, String),
    DeleteReposownerrepoActionsRunnersrunnerIdLabelsname(String, String, String, String),
    GetReposownerrepoActionsRuns(String, String),
    GetReposownerrepoActionsRunsrunId(String, String, String),
    DeleteReposownerrepoActionsRunsrunId(String, String, String),
    GetReposownerrepoActionsRunsrunIdApprovals(String, String, String),
    PostReposownerrepoActionsRunsrunIdApprove(String, String, String),
    GetReposownerrepoActionsRunsrunIdArtifacts(String, String, String),
    GetReposownerrepoActionsRunsrunIdAttemptsattemptNumber(String, String, String, String),
    GetReposownerrepoActionsRunsrunIdAttemptsattemptNumberJobs(String, String, String, String),
    GetReposownerrepoActionsRunsrunIdAttemptsattemptNumberLogs(String, String, String, String),
    PostReposownerrepoActionsRunsrunIdCancel(String, String, String),
    GetReposownerrepoActionsRunsrunIdJobs(String, String, String),
    GetReposownerrepoActionsRunsrunIdLogs(String, String, String),
    DeleteReposownerrepoActionsRunsrunIdLogs(String, String, String),
    GetReposownerrepoActionsRunsrunIdPendingDeployments(String, String, String),
    PostReposownerrepoActionsRunsrunIdPendingDeployments(String, String, String),
    PostReposownerrepoActionsRunsrunIdRerun(String, String, String),
    GetReposownerrepoActionsRunsrunIdTiming(String, String, String),
    GetReposownerrepoActionsSecrets(String, String),
    GetReposownerrepoActionsSecretsPublicKey(String, String),
    GetReposownerrepoActionsSecretssecretName(String, String, String),
    PutReposownerrepoActionsSecretssecretName(String, String, String),
    DeleteReposownerrepoActionsSecretssecretName(String, String, String),
    GetReposownerrepoActionsWorkflows(String, String),
    GetReposownerrepoActionsWorkflowsworkflowId(String, String, String),
    PutReposownerrepoActionsWorkflowsworkflowIdDisable(String, String, String),
    PostReposownerrepoActionsWorkflowsworkflowIdDispatches(String, String, String),
    PutReposownerrepoActionsWorkflowsworkflowIdEnable(String, String, String),
    GetReposownerrepoActionsWorkflowsworkflowIdRuns(String, String, String),
    GetReposownerrepoActionsWorkflowsworkflowIdTiming(String, String, String),
    GetReposownerrepoAssignees(String, String),
    GetReposownerrepoAssigneesassignee(String, String, String),
    GetReposownerrepoAutolinks(String, String),
    PostReposownerrepoAutolinks(String, String),
    GetReposownerrepoAutolinksautolinkId(String, String, String),
    DeleteReposownerrepoAutolinksautolinkId(String, String, String),
    PutReposownerrepoAutomatedSecurityFixes(String, String),
    DeleteReposownerrepoAutomatedSecurityFixes(String, String),
    GetReposownerrepoBranches(String, String),
    GetReposownerrepoBranchesbranch(String, String, String),
    GetReposownerrepoBranchesbranchProtection(String, String, String),
    PutReposownerrepoBranchesbranchProtection(String, String, String),
    DeleteReposownerrepoBranchesbranchProtection(String, String, String),
    GetReposownerrepoBranchesbranchProtectionEnforceAdmins(String, String, String),
    PostReposownerrepoBranchesbranchProtectionEnforceAdmins(String, String, String),
    DeleteReposownerrepoBranchesbranchProtectionEnforceAdmins(String, String, String),
    GetReposownerrepoBranchesbranchProtectionRequiredPullRequestReviews(String, String, String),
    PatchReposownerrepoBranchesbranchProtectionRequiredPullRequestReviews(String, String, String),
    DeleteReposownerrepoBranchesbranchProtectionRequiredPullRequestReviews(String, String, String),
    GetReposownerrepoBranchesbranchProtectionRequiredSignatures(String, String, String),
    PostReposownerrepoBranchesbranchProtectionRequiredSignatures(String, String, String),
    DeleteReposownerrepoBranchesbranchProtectionRequiredSignatures(String, String, String),
    GetReposownerrepoBranchesbranchProtectionRequiredStatusChecks(String, String, String),
    PatchReposownerrepoBranchesbranchProtectionRequiredStatusChecks(String, String, String),
    DeleteReposownerrepoBranchesbranchProtectionRequiredStatusChecks(String, String, String),
    GetReposownerrepoBranchesbranchProtectionRequiredStatusChecksContexts(String, String, String),
    PostReposownerrepoBranchesbranchProtectionRequiredStatusChecksContexts(String, String, String),
    PutReposownerrepoBranchesbranchProtectionRequiredStatusChecksContexts(String, String, String),
    DeleteReposownerrepoBranchesbranchProtectionRequiredStatusChecksContexts(String, String, String),
    GetReposownerrepoBranchesbranchProtectionRestrictions(String, String, String),
    DeleteReposownerrepoBranchesbranchProtectionRestrictions(String, String, String),
    GetReposownerrepoBranchesbranchProtectionRestrictionsApps(String, String, String),
    PostReposownerrepoBranchesbranchProtectionRestrictionsApps(String, String, String),
    PutReposownerrepoBranchesbranchProtectionRestrictionsApps(String, String, String),
    DeleteReposownerrepoBranchesbranchProtectionRestrictionsApps(String, String, String),
    GetReposownerrepoBranchesbranchProtectionRestrictionsTeams(String, String, String),
    PostReposownerrepoBranchesbranchProtectionRestrictionsTeams(String, String, String),
    PutReposownerrepoBranchesbranchProtectionRestrictionsTeams(String, String, String),
    DeleteReposownerrepoBranchesbranchProtectionRestrictionsTeams(String, String, String),
    GetReposownerrepoBranchesbranchProtectionRestrictionsUsers(String, String, String),
    PostReposownerrepoBranchesbranchProtectionRestrictionsUsers(String, String, String),
    PutReposownerrepoBranchesbranchProtectionRestrictionsUsers(String, String, String),
    DeleteReposownerrepoBranchesbranchProtectionRestrictionsUsers(String, String, String),
    PostReposownerrepoBranchesbranchRename(String, String, String),
    PostReposownerrepoCheckRuns(String, String),
    GetReposownerrepoCheckRunscheckRunId(String, String, String),
    PatchReposownerrepoCheckRunscheckRunId(String, String, String),
    GetReposownerrepoCheckRunscheckRunIdAnnotations(String, String, String),
    PostReposownerrepoCheckRunscheckRunIdRerequest(String, String, String),
    PostReposownerrepoCheckSuites(String, String),
    PatchReposownerrepoCheckSuitesPreferences(String, String),
    GetReposownerrepoCheckSuitescheckSuiteId(String, String, String),
    GetReposownerrepoCheckSuitescheckSuiteIdCheckRuns(String, String, String),
    PostReposownerrepoCheckSuitescheckSuiteIdRerequest(String, String, String),
    GetReposownerrepoCodeScanningAlerts(String, String),
    GetReposownerrepoCodeScanningAlertsalertNumber(String, String, String),
    PatchReposownerrepoCodeScanningAlertsalertNumber(String, String, String),
    GetReposownerrepoCodeScanningAlertsalertNumberInstances(String, String, String),
    GetReposownerrepoCodeScanningAnalyses(String, String),
    GetReposownerrepoCodeScanningAnalysesanalysisId(String, String, String),
    DeleteReposownerrepoCodeScanningAnalysesanalysisId(String, String, String),
    PostReposownerrepoCodeScanningSarifs(String, String),
    GetReposownerrepoCodeScanningSarifssarifId(String, String, String),
    GetReposownerrepoCodespaces(String, String),
    PostReposownerrepoCodespaces(String, String),
    GetReposownerrepoCodespacesMachines(String, String),
    GetReposownerrepoCollaborators(String, String),
    GetReposownerrepoCollaboratorsusername(String, String, String),
    PutReposownerrepoCollaboratorsusername(String, String, String),
    DeleteReposownerrepoCollaboratorsusername(String, String, String),
    GetReposownerrepoCollaboratorsusernamePermission(String, String, String),
    GetReposownerrepoComments(String, String),
    GetReposownerrepoCommentscommentId(String, String, String),
    PatchReposownerrepoCommentscommentId(String, String, String),
    DeleteReposownerrepoCommentscommentId(String, String, String),
    GetReposownerrepoCommentscommentIdReactions(String, String, String),
    PostReposownerrepoCommentscommentIdReactions(String, String, String),
    DeleteReposownerrepoCommentscommentIdReactionsreactionId(String, String, String, String),
    GetReposownerrepoCommits(String, String),
    GetReposownerrepoCommitscommitShaBranchesWhereHead(String, String, String),
    GetReposownerrepoCommitscommitShaComments(String, String, String),
    PostReposownerrepoCommitscommitShaComments(String, String, String),
    GetReposownerrepoCommitscommitShaPulls(String, String, String),
    GetReposownerrepoCommitsref(String, String, String),
    GetReposownerrepoCommitsrefCheckRuns(String, String, String),
    GetReposownerrepoCommitsrefCheckSuites(String, String, String),
    GetReposownerrepoCommitsrefStatus(String, String, String),
    GetReposownerrepoCommitsrefStatuses(String, String, String),
    GetReposownerrepoCommunityProfile(String, String),
    GetReposownerrepoComparebasehead(String, String, String),
    GetReposownerrepoContentspath(String, String, String),
    PutReposownerrepoContentspath(String, String, String),
    DeleteReposownerrepoContentspath(String, String, String),
    GetReposownerrepoContributors(String, String),
    GetReposownerrepoDependabotSecrets(String, String),
    GetReposownerrepoDependabotSecretsPublicKey(String, String),
    GetReposownerrepoDependabotSecretssecretName(String, String, String),
    PutReposownerrepoDependabotSecretssecretName(String, String, String),
    DeleteReposownerrepoDependabotSecretssecretName(String, String, String),
    GetReposownerrepoDeployments(String, String),
    PostReposownerrepoDeployments(String, String),
    GetReposownerrepoDeploymentsdeploymentId(String, String, String),
    DeleteReposownerrepoDeploymentsdeploymentId(String, String, String),
    GetReposownerrepoDeploymentsdeploymentIdStatuses(String, String, String),
    PostReposownerrepoDeploymentsdeploymentIdStatuses(String, String, String),
    GetReposownerrepoDeploymentsdeploymentIdStatusesstatusId(String, String, String, String),
    PostReposownerrepoDispatches(String, String),
    GetReposownerrepoEnvironments(String, String),
    GetReposownerrepoEnvironmentsenvironmentName(String, String, String),
    PutReposownerrepoEnvironmentsenvironmentName(String, String, String),
    DeleteReposownerrepoEnvironmentsenvironmentName(String, String, String),
    GetReposownerrepoEvents(String, String),
    GetReposownerrepoForks(String, String),
    PostReposownerrepoForks(String, String),
    PostReposownerrepoGitBlobs(String, String),
    GetReposownerrepoGitBlobsfileSha(String, String, String),
    PostReposownerrepoGitCommits(String, String),
    GetReposownerrepoGitCommitscommitSha(String, String, String),
    GetReposownerrepoGitMatchingRefsref(String, String, String),
    GetReposownerrepoGitRefref(String, String, String),
    PostReposownerrepoGitRefs(String, String),
    PatchReposownerrepoGitRefsref(String, String, String),
    DeleteReposownerrepoGitRefsref(String, String, String),
    PostReposownerrepoGitTags(String, String),
    GetReposownerrepoGitTagstagSha(String, String, String),
    PostReposownerrepoGitTrees(String, String),
    GetReposownerrepoGitTreestreeSha(String, String, String),
    GetReposownerrepoHooks(String, String),
    PostReposownerrepoHooks(String, String),
    GetReposownerrepoHookshookId(String, String, String),
    PatchReposownerrepoHookshookId(String, String, String),
    DeleteReposownerrepoHookshookId(String, String, String),
    GetReposownerrepoHookshookIdConfig(String, String, String),
    PatchReposownerrepoHookshookIdConfig(String, String, String),
    GetReposownerrepoHookshookIdDeliveries(String, String, String),
    GetReposownerrepoHookshookIdDeliveriesdeliveryId(String, String, String, String),
    PostReposownerrepoHookshookIdDeliveriesdeliveryIdAttempts(String, String, String, String),
    PostReposownerrepoHookshookIdPings(String, String, String),
    PostReposownerrepoHookshookIdTests(String, String, String),
    GetReposownerrepoImport(String, String),
    PutReposownerrepoImport(String, String),
    PatchReposownerrepoImport(String, String),
    DeleteReposownerrepoImport(String, String),
    GetReposownerrepoImportAuthors(String, String),
    PatchReposownerrepoImportAuthorsauthorId(String, String, String),
    GetReposownerrepoImportLargeFiles(String, String),
    PatchReposownerrepoImportLfs(String, String),
    GetReposownerrepoInstallation(String, String),
    GetReposownerrepoInteractionLimits(String, String),
    PutReposownerrepoInteractionLimits(String, String),
    DeleteReposownerrepoInteractionLimits(String, String),
    GetReposownerrepoInvitations(String, String),
    PatchReposownerrepoInvitationsinvitationId(String, String, String),
    DeleteReposownerrepoInvitationsinvitationId(String, String, String),
    GetReposownerrepoIssues(String, String),
    PostReposownerrepoIssues(String, String),
    GetReposownerrepoIssuesComments(String, String),
    GetReposownerrepoIssuesCommentscommentId(String, String, String),
    PatchReposownerrepoIssuesCommentscommentId(String, String, String),
    DeleteReposownerrepoIssuesCommentscommentId(String, String, String),
    GetReposownerrepoIssuesCommentscommentIdReactions(String, String, String),
    PostReposownerrepoIssuesCommentscommentIdReactions(String, String, String),
    DeleteReposownerrepoIssuesCommentscommentIdReactionsreactionId(String, String, String, String),
    GetReposownerrepoIssuesEvents(String, String),
    GetReposownerrepoIssuesEventseventId(String, String, String),
    GetReposownerrepoIssuesissueNumber(String, String, String),
    PatchReposownerrepoIssuesissueNumber(String, String, String),
    PostReposownerrepoIssuesissueNumberAssignees(String, String, String),
    DeleteReposownerrepoIssuesissueNumberAssignees(String, String, String),
    GetReposownerrepoIssuesissueNumberComments(String, String, String),
    PostReposownerrepoIssuesissueNumberComments(String, String, String),
    GetReposownerrepoIssuesissueNumberEvents(String, String, String),
    GetReposownerrepoIssuesissueNumberLabels(String, String, String),
    PostReposownerrepoIssuesissueNumberLabels(String, String, String),
    PutReposownerrepoIssuesissueNumberLabels(String, String, String),
    DeleteReposownerrepoIssuesissueNumberLabels(String, String, String),
    DeleteReposownerrepoIssuesissueNumberLabelsname(String, String, String, String),
    PutReposownerrepoIssuesissueNumberLock(String, String, String),
    DeleteReposownerrepoIssuesissueNumberLock(String, String, String),
    GetReposownerrepoIssuesissueNumberReactions(String, String, String),
    PostReposownerrepoIssuesissueNumberReactions(String, String, String),
    DeleteReposownerrepoIssuesissueNumberReactionsreactionId(String, String, String, String),
    GetReposownerrepoIssuesissueNumberTimeline(String, String, String),
    GetReposownerrepoKeys(String, String),
    PostReposownerrepoKeys(String, String),
    GetReposownerrepoKeyskeyId(String, String, String),
    DeleteReposownerrepoKeyskeyId(String, String, String),
    GetReposownerrepoLabels(String, String),
    PostReposownerrepoLabels(String, String),
    GetReposownerrepoLabelsname(String, String, String),
    PatchReposownerrepoLabelsname(String, String, String),
    DeleteReposownerrepoLabelsname(String, String, String),
    GetReposownerrepoLanguages(String, String),
    PutReposownerrepoLfs(String, String),
    DeleteReposownerrepoLfs(String, String),
    GetReposownerrepoLicense(String, String),
    PostReposownerrepoMergeUpstream(String, String),
    PostReposownerrepoMerges(String, String),
    GetReposownerrepoMilestones(String, String),
    PostReposownerrepoMilestones(String, String),
    GetReposownerrepoMilestonesmilestoneNumber(String, String, String),
    PatchReposownerrepoMilestonesmilestoneNumber(String, String, String),
    DeleteReposownerrepoMilestonesmilestoneNumber(String, String, String),
    GetReposownerrepoMilestonesmilestoneNumberLabels(String, String, String),
    GetReposownerrepoNotifications(String, String),
    PutReposownerrepoNotifications(String, String),
    GetReposownerrepoPages(String, String),
    PostReposownerrepoPages(String, String),
    PutReposownerrepoPages(String, String),
    DeleteReposownerrepoPages(String, String),
    GetReposownerrepoPagesBuilds(String, String),
    PostReposownerrepoPagesBuilds(String, String),
    GetReposownerrepoPagesBuildsLatest(String, String),
    GetReposownerrepoPagesBuildsbuildId(String, String, String),
    GetReposownerrepoPagesHealth(String, String),
    GetReposownerrepoProjects(String, String),
    PostReposownerrepoProjects(String, String),
    GetReposownerrepoPulls(String, String),
    PostReposownerrepoPulls(String, String),
    GetReposownerrepoPullsComments(String, String),
    GetReposownerrepoPullsCommentscommentId(String, String, String),
    PatchReposownerrepoPullsCommentscommentId(String, String, String),
    DeleteReposownerrepoPullsCommentscommentId(String, String, String),
    GetReposownerrepoPullsCommentscommentIdReactions(String, String, String),
    PostReposownerrepoPullsCommentscommentIdReactions(String, String, String),
    DeleteReposownerrepoPullsCommentscommentIdReactionsreactionId(String, String, String, String),
    GetReposownerrepoPullspullNumber(String, String, String),
    PatchReposownerrepoPullspullNumber(String, String, String),
    PostReposownerrepoPullspullNumberCodespaces(String, String, String),
    GetReposownerrepoPullspullNumberComments(String, String, String),
    PostReposownerrepoPullspullNumberComments(String, String, String),
    PostReposownerrepoPullspullNumberCommentscommentIdReplies(String, String, String, String),
    GetReposownerrepoPullspullNumberCommits(String, String, String),
    GetReposownerrepoPullspullNumberFiles(String, String, String),
    GetReposownerrepoPullspullNumberMerge(String, String, String),
    PutReposownerrepoPullspullNumberMerge(String, String, String),
    GetReposownerrepoPullspullNumberRequestedReviewers(String, String, String),
    PostReposownerrepoPullspullNumberRequestedReviewers(String, String, String),
    DeleteReposownerrepoPullspullNumberRequestedReviewers(String, String, String),
    GetReposownerrepoPullspullNumberReviews(String, String, String),
    PostReposownerrepoPullspullNumberReviews(String, String, String),
    GetReposownerrepoPullspullNumberReviewsreviewId(String, String, String, String),
    PutReposownerrepoPullspullNumberReviewsreviewId(String, String, String, String),
    DeleteReposownerrepoPullspullNumberReviewsreviewId(String, String, String, String),
    GetReposownerrepoPullspullNumberReviewsreviewIdComments(String, String, String, String),
    PutReposownerrepoPullspullNumberReviewsreviewIdDismissals(String, String, String, String),
    PostReposownerrepoPullspullNumberReviewsreviewIdEvents(String, String, String, String),
    PutReposownerrepoPullspullNumberUpdateBranch(String, String, String),
    GetReposownerrepoReadme(String, String),
    GetReposownerrepoReadmedir(String, String, String),
    GetReposownerrepoReleases(String, String),
    PostReposownerrepoReleases(String, String),
    GetReposownerrepoReleasesAssetsassetId(String, String, String),
    PatchReposownerrepoReleasesAssetsassetId(String, String, String),
    DeleteReposownerrepoReleasesAssetsassetId(String, String, String),
    PostReposownerrepoReleasesGenerateNotes(String, String),
    GetReposownerrepoReleasesLatest(String, String),
    GetReposownerrepoReleasesTagstag(String, String, String),
    GetReposownerrepoReleasesreleaseId(String, String, String),
    PatchReposownerrepoReleasesreleaseId(String, String, String),
    DeleteReposownerrepoReleasesreleaseId(String, String, String),
    GetReposownerrepoReleasesreleaseIdAssets(String, String, String),
    PostReposownerrepoReleasesreleaseIdAssets(String, String, String),
    PostReposownerrepoReleasesreleaseIdReactions(String, String, String),
    GetReposownerrepoSecretScanningAlerts(String, String),
    GetReposownerrepoSecretScanningAlertsalertNumber(String, String, String),
    PatchReposownerrepoSecretScanningAlertsalertNumber(String, String, String),
    GetReposownerrepoSecretScanningAlertsalertNumberLocations(String, String, String),
    GetReposownerrepoStargazers(String, String),
    GetReposownerrepoStatsCodeFrequency(String, String),
    GetReposownerrepoStatsCommitActivity(String, String),
    GetReposownerrepoStatsContributors(String, String),
    GetReposownerrepoStatsParticipation(String, String),
    GetReposownerrepoStatsPunchCard(String, String),
    PostReposownerrepoStatusessha(String, String, String),
    GetReposownerrepoSubscribers(String, String),
    GetReposownerrepoSubscription(String, String),
    PutReposownerrepoSubscription(String, String),
    DeleteReposownerrepoSubscription(String, String),
    GetReposownerrepoTags(String, String),
    GetReposownerrepoTarballref(String, String, String),
    GetReposownerrepoTeams(String, String),
    GetReposownerrepoTopics(String, String),
    PutReposownerrepoTopics(String, String),
    GetReposownerrepoTrafficClones(String, String),
    GetReposownerrepoTrafficPopularPaths(String, String),
    GetReposownerrepoTrafficPopularReferrers(String, String),
    GetReposownerrepoTrafficViews(String, String),
    PostReposownerrepoTransfer(String, String),
    GetReposownerrepoVulnerabilityAlerts(String, String),
    PutReposownerrepoVulnerabilityAlerts(String, String),
    DeleteReposownerrepoVulnerabilityAlerts(String, String),
    GetReposownerrepoZipballref(String, String, String),
    PostRepostemplateOwnertemplateRepoGenerate(String, String),
    GetRepositories(),
    GetRepositoriesrepositoryIdEnvironmentsenvironmentNameSecrets(String, String),
    GetRepositoriesrepositoryIdEnvironmentsenvironmentNameSecretsPublicKey(String, String),
    GetRepositoriesrepositoryIdEnvironmentsenvironmentNameSecretssecretName(String, String, String),
    PutRepositoriesrepositoryIdEnvironmentsenvironmentNameSecretssecretName(String, String, String),
    DeleteRepositoriesrepositoryIdEnvironmentsenvironmentNameSecretssecretName(String, String, String),
    GetScimV2EnterprisesenterpriseGroups(String),
    PostScimV2EnterprisesenterpriseGroups(String),
    GetScimV2EnterprisesenterpriseGroupsscimGroupId(String, String),
    PutScimV2EnterprisesenterpriseGroupsscimGroupId(String, String),
    PatchScimV2EnterprisesenterpriseGroupsscimGroupId(String, String),
    DeleteScimV2EnterprisesenterpriseGroupsscimGroupId(String, String),
    GetScimV2EnterprisesenterpriseUsers(String),
    PostScimV2EnterprisesenterpriseUsers(String),
    GetScimV2EnterprisesenterpriseUsersscimUserId(String, String),
    PutScimV2EnterprisesenterpriseUsersscimUserId(String, String),
    PatchScimV2EnterprisesenterpriseUsersscimUserId(String, String),
    DeleteScimV2EnterprisesenterpriseUsersscimUserId(String, String),
    GetScimV2OrganizationsorgUsers(String),
    PostScimV2OrganizationsorgUsers(String),
    GetScimV2OrganizationsorgUsersscimUserId(String, String),
    PutScimV2OrganizationsorgUsersscimUserId(String, String),
    PatchScimV2OrganizationsorgUsersscimUserId(String, String),
    DeleteScimV2OrganizationsorgUsersscimUserId(String, String),
    GetSearchCode(),
    GetSearchCommits(),
    GetSearchIssues(),
    GetSearchLabels(),
    GetSearchRepositories(),
    GetSearchTopics(),
    GetSearchUsers(),
    GetTeamsteamId(String),
    PatchTeamsteamId(String),
    DeleteTeamsteamId(String),
    GetTeamsteamIdDiscussions(String),
    PostTeamsteamIdDiscussions(String),
    GetTeamsteamIdDiscussionsdiscussionNumber(String, String),
    PatchTeamsteamIdDiscussionsdiscussionNumber(String, String),
    DeleteTeamsteamIdDiscussionsdiscussionNumber(String, String),
    GetTeamsteamIdDiscussionsdiscussionNumberComments(String, String),
    PostTeamsteamIdDiscussionsdiscussionNumberComments(String, String),
    GetTeamsteamIdDiscussionsdiscussionNumberCommentscommentNumber(String, String, String),
    PatchTeamsteamIdDiscussionsdiscussionNumberCommentscommentNumber(String, String, String),
    DeleteTeamsteamIdDiscussionsdiscussionNumberCommentscommentNumber(String, String, String),
    GetTeamsteamIdDiscussionsdiscussionNumberCommentscommentNumberReactions(String, String, String),
    PostTeamsteamIdDiscussionsdiscussionNumberCommentscommentNumberReactions(String, String, String),
    GetTeamsteamIdDiscussionsdiscussionNumberReactions(String, String),
    PostTeamsteamIdDiscussionsdiscussionNumberReactions(String, String),
    GetTeamsteamIdInvitations(String),
    GetTeamsteamIdMembers(String),
    GetTeamsteamIdMembersusername(String, String),
    PutTeamsteamIdMembersusername(String, String),
    DeleteTeamsteamIdMembersusername(String, String),
    GetTeamsteamIdMembershipsusername(String, String),
    PutTeamsteamIdMembershipsusername(String, String),
    DeleteTeamsteamIdMembershipsusername(String, String),
    GetTeamsteamIdProjects(String),
    GetTeamsteamIdProjectsprojectId(String, String),
    PutTeamsteamIdProjectsprojectId(String, String),
    DeleteTeamsteamIdProjectsprojectId(String, String),
    GetTeamsteamIdRepos(String),
    GetTeamsteamIdReposownerrepo(String, String, String),
    PutTeamsteamIdReposownerrepo(String, String, String),
    DeleteTeamsteamIdReposownerrepo(String, String, String),
    GetTeamsteamIdTeamSyncGroupMappings(String),
    PatchTeamsteamIdTeamSyncGroupMappings(String),
    GetTeamsteamIdTeams(String),
    GetUser(),
    PatchUser(),
    GetUserBlocks(),
    GetUserBlocksusername(String),
    PutUserBlocksusername(String),
    DeleteUserBlocksusername(String),
    GetUserCodespaces(),
    PostUserCodespaces(),
    GetUserCodespacesSecrets(),
    GetUserCodespacesSecretsPublicKey(),
    GetUserCodespacesSecretssecretName(String),
    PutUserCodespacesSecretssecretName(String),
    DeleteUserCodespacesSecretssecretName(String),
    GetUserCodespacesSecretssecretNameRepositories(String),
    PutUserCodespacesSecretssecretNameRepositories(String),
    PutUserCodespacesSecretssecretNameRepositoriesrepositoryId(String, String),
    DeleteUserCodespacesSecretssecretNameRepositoriesrepositoryId(String, String),
    GetUserCodespacescodespaceName(String),
    PatchUserCodespacescodespaceName(String),
    DeleteUserCodespacescodespaceName(String),
    PostUserCodespacescodespaceNameExports(String),
    GetUserCodespacescodespaceNameExportsexportId(String, String),
    GetUserCodespacescodespaceNameMachines(String),
    PostUserCodespacescodespaceNameStart(String),
    PostUserCodespacescodespaceNameStop(String),
    PatchUserEmailVisibility(),
    GetUserEmails(),
    PostUserEmails(),
    DeleteUserEmails(),
    GetUserFollowers(),
    GetUserFollowing(),
    GetUserFollowingusername(String),
    PutUserFollowingusername(String),
    DeleteUserFollowingusername(String),
    GetUserGpgKeys(),
    PostUserGpgKeys(),
    GetUserGpgKeysgpgKeyId(String),
    DeleteUserGpgKeysgpgKeyId(String),
    GetUserInstallations(),
    GetUserInstallationsinstallationIdRepositories(String),
    PutUserInstallationsinstallationIdRepositoriesrepositoryId(String, String),
    DeleteUserInstallationsinstallationIdRepositoriesrepositoryId(String, String),
    GetUserInteractionLimits(),
    PutUserInteractionLimits(),
    DeleteUserInteractionLimits(),
    GetUserIssues(),
    GetUserKeys(),
    PostUserKeys(),
    GetUserKeyskeyId(String),
    DeleteUserKeyskeyId(String),
    GetUserMarketplacePurchases(),
    GetUserMarketplacePurchasesStubbed(),
    GetUserMembershipsOrgs(),
    GetUserMembershipsOrgsorg(String),
    PatchUserMembershipsOrgsorg(String),
    GetUserMigrations(),
    PostUserMigrations(),
    GetUserMigrationsmigrationId(String),
    GetUserMigrationsmigrationIdArchive(String),
    DeleteUserMigrationsmigrationIdArchive(String),
    DeleteUserMigrationsmigrationIdReposrepoNameLock(String, String),
    GetUserMigrationsmigrationIdRepositories(String),
    GetUserOrgs(),
    GetUserPackages(),
    GetUserPackagespackageTypepackageName(String, String),
    DeleteUserPackagespackageTypepackageName(String, String),
    PostUserPackagespackageTypepackageNameRestore(String, String),
    GetUserPackagespackageTypepackageNameVersions(String, String),
    GetUserPackagespackageTypepackageNameVersionspackageVersionId(String, String, String),
    DeleteUserPackagespackageTypepackageNameVersionspackageVersionId(String, String, String),
    PostUserPackagespackageTypepackageNameVersionspackageVersionIdRestore(String, String, String),
    PostUserProjects(),
    GetUserPublicEmails(),
    GetUserRepos(),
    PostUserRepos(),
    GetUserRepositoryInvitations(),
    PatchUserRepositoryInvitationsinvitationId(String),
    DeleteUserRepositoryInvitationsinvitationId(String),
    GetUserStarred(),
    GetUserStarredownerrepo(String, String),
    PutUserStarredownerrepo(String, String),
    DeleteUserStarredownerrepo(String, String),
    GetUserSubscriptions(),
    GetUserTeams(),
    GetUsers(),
    GetUsersusername(String),
    GetUsersusernameEvents(String),
    GetUsersusernameEventsOrgsorg(String, String),
    GetUsersusernameEventsPublic(String),
    GetUsersusernameFollowers(String),
    GetUsersusernameFollowing(String),
    GetUsersusernameFollowingtargetUser(String, String),
    GetUsersusernameGists(String),
    GetUsersusernameGpgKeys(String),
    GetUsersusernameHovercard(String),
    GetUsersusernameInstallation(String),
    GetUsersusernameKeys(String),
    GetUsersusernameOrgs(String),
    GetUsersusernamePackages(String),
    GetUsersusernamePackagespackageTypepackageName(String, String, String),
    DeleteUsersusernamePackagespackageTypepackageName(String, String, String),
    PostUsersusernamePackagespackageTypepackageNameRestore(String, String, String),
    GetUsersusernamePackagespackageTypepackageNameVersions(String, String, String),
    GetUsersusernamePackagespackageTypepackageNameVersionspackageVersionId(String, String, String, String),
    DeleteUsersusernamePackagespackageTypepackageNameVersionspackageVersionId(String, String, String, String),
    PostUsersusernamePackagespackageTypepackageNameVersionspackageVersionIdRestore(String, String, String, String),
    GetUsersusernameProjects(String),
    GetUsersusernameReceivedEvents(String),
    GetUsersusernameReceivedEventsPublic(String),
    GetUsersusernameRepos(String),
    GetUsersusernameSettingsBillingActions(String),
    GetUsersusernameSettingsBillingPackages(String),
    GetUsersusernameSettingsBillingSharedStorage(String),
    GetUsersusernameStarred(String),
    GetUsersusernameSubscriptions(String),
    GetZen(),
}

Variants

Get()

• tags meta
• get /
• docs https://docs.github.com/rest/overview/resources-in-the-rest-api#root-endpoint

GitHub API Root Get Hypermedia links to resources accessible in GitHub’s REST API

GetApp()

• tags apps
• get /app
• docs https://docs.github.com/rest/reference/apps#get-the-authenticated-app

Get the authenticated app Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app’s installations, see the “List installations for the authenticated app” endpoint.

You must use a JWT to access this endpoint.

PostAppManifestscodeConversions(String)

• tags apps
• post /app-manifests/{code}/conversions
• docs https://docs.github.com/rest/reference/apps#create-a-github-app-from-a-manifest

Create a GitHub App from a manifest Use this endpoint to complete the handshake necessary when implementing the GitHub App Manifest flow. When you create a GitHub App with the manifest flow, you receive a temporary code used to retrieve the GitHub App’s id, pem (private key), and webhook_secret.

GetAppHookConfig()

• tags apps
• get /app/hook/config
• docs https://docs.github.com/rest/reference/apps#get-a-webhook-configuration-for-an-app

Get a webhook configuration for an app Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see “Creating a GitHub App.”

You must use a JWT to access this endpoint.

PatchAppHookConfig()

• tags apps
• patch /app/hook/config
• docs https://docs.github.com/rest/reference/apps#update-a-webhook-configuration-for-an-app

Update a webhook configuration for an app Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see “Creating a GitHub App.”

You must use a JWT to access this endpoint.

GetAppHookDeliveries()

• tags apps
• get /app/hook/deliveries
• docs https://docs.github.com/rest/reference/apps#list-deliveries-for-an-app-webhook

List deliveries for an app webhook Returns a list of webhook deliveries for the webhook configured for a GitHub App.

You must use a JWT to access this endpoint.

GetAppHookDeliveriesdeliveryId(String)

• tags apps
• get /app/hook/deliveries/{delivery_id}
• docs https://docs.github.com/rest/reference/apps#get-a-delivery-for-an-app-webhook

Get a delivery for an app webhook Returns a delivery for the webhook configured for a GitHub App.

You must use a JWT to access this endpoint.

PostAppHookDeliveriesdeliveryIdAttempts(String)

• tags apps
• post /app/hook/deliveries/{delivery_id}/attempts
• docs https://docs.github.com/rest/reference/apps#redeliver-a-delivery-for-an-app-webhook

Redeliver a delivery for an app webhook Redeliver a delivery for the webhook configured for a GitHub App.

You must use a JWT to access this endpoint.

GetAppInstallations()

• tags apps
• get /app/installations
• docs https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app

List installations for the authenticated app You must use a JWT to access this endpoint.

The permissions the installation has are included under the permissions key.

GetAppInstallationsinstallationId(String)

• tags apps
• get /app/installations/{installation_id}
• docs https://docs.github.com/rest/reference/apps#get-an-installation-for-the-authenticated-app

Get an installation for the authenticated app Enables an authenticated GitHub App to find an installation’s information using the installation id.

You must use a JWT to access this endpoint.

DeleteAppInstallationsinstallationId(String)

• tags apps
• delete /app/installations/{installation_id}
• docs https://docs.github.com/rest/reference/apps#delete-an-installation-for-the-authenticated-app

Delete an installation for the authenticated app Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app’s access to your account’s resources, then we recommend the “Suspend an app installation” endpoint.

You must use a JWT to access this endpoint.

PostAppInstallationsinstallationIdAccessTokens(String)

• tags apps
• post /app/installations/{installation_id}/access_tokens
• docs https://docs.github.com/rest/reference/apps/#create-an-installation-access-token-for-an-app

Create an installation access token for an app Creates an installation access token that enables a GitHub App to make authenticated API requests for the app’s installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of 401 - Unauthorized, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the repository_ids when creating the token. When you omit repository_ids, the response does not contain the repositories key.

You must use a JWT to access this endpoint.

PutAppInstallationsinstallationIdSuspended(String)

• tags apps
• put /app/installations/{installation_id}/suspended
• docs https://docs.github.com/rest/reference/apps#suspend-an-app-installation

Suspend an app installation Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account’s resources. When a GitHub App is suspended, the app’s access to the GitHub API or webhook events is blocked for that account.

You must use a JWT to access this endpoint.

DeleteAppInstallationsinstallationIdSuspended(String)

• tags apps
• delete /app/installations/{installation_id}/suspended
• docs https://docs.github.com/rest/reference/apps#unsuspend-an-app-installation

Unsuspend an app installation Removes a GitHub App installation suspension.

You must use a JWT to access this endpoint.

GetApplicationsGrants()

• tags oauth-authorizations
• get /applications/grants
• docs https://docs.github.com/rest/reference/oauth-authorizations#list-your-grants

List your grants Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return ["repo", "user"].

GetApplicationsGrantsgrantId(String)

• tags oauth-authorizations
• get /applications/grants/{grant_id}
• docs https://docs.github.com/rest/reference/oauth-authorizations#get-a-single-grant

Get a single grant Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

DeleteApplicationsGrantsgrantId(String)

• tags oauth-authorizations
• delete /applications/grants/{grant_id}
• docs https://docs.github.com/rest/reference/oauth-authorizations#delete-a-grant

Delete a grant Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

Deleting an OAuth application’s grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on the application authorizations settings screen within GitHub.

DeleteApplicationsclientIdGrant(String)

• tags apps
• delete /applications/{client_id}/grant
• docs https://docs.github.com/rest/reference/apps#delete-an-app-authorization

Delete an app authorization OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use Basic Authentication when accessing this endpoint, using the OAuth application’s client_id and client_secret as the username and password. You must also provide a valid OAuth access_token as an input parameter and the grant for the token’s owner will be deleted. Deleting an OAuth application’s grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user’s account and will no longer be listed on the application authorizations settings screen within GitHub.

PostApplicationsclientIdToken(String)

• tags apps
• post /applications/{client_id}/token
• docs https://docs.github.com/rest/reference/apps#check-a-token

Check a token OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use Basic Authentication to use this endpoint, where the username is the OAuth application client_id and the password is its client_secret. Invalid tokens will return 404 NOT FOUND.

PatchApplicationsclientIdToken(String)

• tags apps
• patch /applications/{client_id}/token
• docs https://docs.github.com/rest/reference/apps#reset-a-token

Reset a token OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the “token” property in the response because changes take effect immediately. You must use Basic Authentication when accessing this endpoint, using the OAuth application’s client_id and client_secret as the username and password. Invalid tokens will return 404 NOT FOUND.

DeleteApplicationsclientIdToken(String)

• tags apps
• delete /applications/{client_id}/token
• docs https://docs.github.com/rest/reference/apps#delete-an-app-token

Delete an app token OAuth application owners can revoke a single token for an OAuth application. You must use Basic Authentication when accessing this endpoint, using the OAuth application’s client_id and client_secret as the username and password.

PostApplicationsclientIdTokenScoped(String)

• tags apps
• post /applications/{client_id}/token/scoped
• docs https://docs.github.com/rest/reference/apps#create-a-scoped-access-token

Create a scoped access token Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use Basic Authentication when accessing this endpoint, using the OAuth application’s client_id and client_secret as the username and password. Invalid tokens will return 404 NOT FOUND.

GetAppsappSlug(String)

• tags apps
• get /apps/{app_slug}
• docs https://docs.github.com/rest/reference/apps/#get-an-app

Get an app Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).

If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token to access this endpoint.

GetAuthorizations()

• tags oauth-authorizations
• get /authorizations
• docs https://docs.github.com/rest/reference/oauth-authorizations#list-your-authorizations

List your authorizations Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

PostAuthorizations()

• tags oauth-authorizations
• post /authorizations
• docs https://docs.github.com/rest/reference/oauth-authorizations#create-a-new-authorization

Create a new authorization Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

Warning: Apps must use the web application flow to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the blog post.

Creates OAuth tokens using Basic Authentication. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see “Working with two-factor authentication.”

To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app’s client ID and secret, found on your OAuth application’s settings page. If your OAuth application intends to create multiple tokens for one user, use fingerprint to differentiate between them.

You can also create tokens on GitHub from the personal access tokens settings page. Read more about these tokens in the GitHub Help documentation.

Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in the GitHub Help documentation.

PutAuthorizationsClientsclientId(String)

• tags oauth-authorizations
• put /authorizations/clients/{client_id}
• docs https://docs.github.com/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app

Get-or-create an authorization for a specific app Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

Warning: Apps must use the web application flow to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the blog post.

Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn’t already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user’s existing authorization for the application if one is present. Otherwise, it creates and returns a new one.

If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see “Working with two-factor authentication.”

Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

PutAuthorizationsClientsclientIdfingerprint(String, String)

• tags oauth-authorizations
• put /authorizations/clients/{client_id}/{fingerprint}
• docs https://docs.github.com/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app-and-fingerprint

Get-or-create an authorization for a specific app and fingerprint Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

Warning: Apps must use the web application flow to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the blog post.

This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. fingerprint is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user’s existing authorization for the application if one is present. Otherwise, it creates and returns a new one.

If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see “Working with two-factor authentication.”

GetAuthorizationsauthorizationId(String)

• tags oauth-authorizations
• get /authorizations/{authorization_id}
• docs https://docs.github.com/rest/reference/oauth-authorizations#get-a-single-authorization

Get a single authorization Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

PatchAuthorizationsauthorizationId(String)

• tags oauth-authorizations
• patch /authorizations/{authorization_id}
• docs https://docs.github.com/rest/reference/oauth-authorizations#update-an-existing-authorization

Update an existing authorization Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see “Working with two-factor authentication.”

You can only send one of these scope keys at a time.

DeleteAuthorizationsauthorizationId(String)

• tags oauth-authorizations
• delete /authorizations/{authorization_id}
• docs https://docs.github.com/rest/reference/oauth-authorizations#delete-an-authorization

Delete an authorization Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

GetCodesOfConduct()

• tags codes-of-conduct
• get /codes_of_conduct
• docs https://docs.github.com/rest/reference/codes-of-conduct#get-all-codes-of-conduct

Get all codes of conduct

GetCodesOfConductkey(String)

• tags codes-of-conduct
• get /codes_of_conduct/{key}
• docs https://docs.github.com/rest/reference/codes-of-conduct#get-a-code-of-conduct

Get a code of conduct

GetEmojis()

• tags emojis
• get /emojis
• docs https://docs.github.com/rest/reference/emojis#get-emojis

Get emojis Lists all the emojis available to use on GitHub.

GetEnterprisesenterpriseActionsPermissions(String)

• tags enterprise-admin
• get /enterprises/{enterprise}/actions/permissions
• docs https://docs.github.com/rest/reference/enterprise-admin#get-github-actions-permissions-for-an-enterprise

Get GitHub Actions permissions for an enterprise Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

PutEnterprisesenterpriseActionsPermissions(String)

• tags enterprise-admin
• put /enterprises/{enterprise}/actions/permissions
• docs https://docs.github.com/rest/reference/enterprise-admin#set-github-actions-permissions-for-an-enterprise

Set GitHub Actions permissions for an enterprise Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

GetEnterprisesenterpriseActionsPermissionsOrganizations(String)

• tags enterprise-admin
• get /enterprises/{enterprise}/actions/permissions/organizations
• docs https://docs.github.com/rest/reference/enterprise-admin#list-selected-organizations-enabled-for-github-actions-in-an-enterprise

List selected organizations enabled for GitHub Actions in an enterprise Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see “Set GitHub Actions permissions for an enterprise.”

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

PutEnterprisesenterpriseActionsPermissionsOrganizations(String)

• tags enterprise-admin
• put /enterprises/{enterprise}/actions/permissions/organizations
• docs https://docs.github.com/rest/reference/enterprise-admin#set-selected-organizations-enabled-for-github-actions-in-an-enterprise

Set selected organizations enabled for GitHub Actions in an enterprise Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see “Set GitHub Actions permissions for an enterprise.”

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

PutEnterprisesenterpriseActionsPermissionsOrganizationsorgId(String, String)

• tags enterprise-admin
• put /enterprises/{enterprise}/actions/permissions/organizations/{org_id}
• docs https://docs.github.com/rest/reference/enterprise-admin#enable-a-selected-organization-for-github-actions-in-an-enterprise

Enable a selected organization for GitHub Actions in an enterprise Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see “Set GitHub Actions permissions for an enterprise.”

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

DeleteEnterprisesenterpriseActionsPermissionsOrganizationsorgId(String, String)

• tags enterprise-admin
• delete /enterprises/{enterprise}/actions/permissions/organizations/{org_id}
• docs https://docs.github.com/rest/reference/enterprise-admin#disable-a-selected-organization-for-github-actions-in-an-enterprise

Disable a selected organization for GitHub Actions in an enterprise Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see “Set GitHub Actions permissions for an enterprise.”

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

GetEnterprisesenterpriseActionsPermissionsSelectedActions(String)

• tags enterprise-admin
• get /enterprises/{enterprise}/actions/permissions/selected-actions
• docs https://docs.github.com/rest/reference/enterprise-admin#get-allowed-actions-for-an-enterprise

Get allowed actions for an enterprise Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see “Set GitHub Actions permissions for an enterprise.”

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

PutEnterprisesenterpriseActionsPermissionsSelectedActions(String)

• tags enterprise-admin
• put /enterprises/{enterprise}/actions/permissions/selected-actions
• docs https://docs.github.com/rest/reference/enterprise-admin#set-allowed-actions-for-an-enterprise

Set allowed actions for an enterprise Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see “Set GitHub Actions permissions for an enterprise.”

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

GetEnterprisesenterpriseActionsRunnerGroups(String)

• tags enterprise-admin
• get /enterprises/{enterprise}/actions/runner-groups
• docs https://docs.github.com/rest/reference/enterprise-admin#list-self-hosted-runner-groups-for-an-enterprise

List self-hosted runner groups for an enterprise Lists all self-hosted runner groups for an enterprise.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

PostEnterprisesenterpriseActionsRunnerGroups(String)

• tags enterprise-admin
• post /enterprises/{enterprise}/actions/runner-groups
• docs https://docs.github.com/rest/reference/enterprise-admin#create-self-hosted-runner-group-for-an-enterprise

Create a self-hosted runner group for an enterprise Creates a new self-hosted runner group for an enterprise.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

GetEnterprisesenterpriseActionsRunnerGroupsrunnerGroupId(String, String)

• tags enterprise-admin
• get /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}
• docs https://docs.github.com/rest/reference/enterprise-admin#get-a-self-hosted-runner-group-for-an-enterprise

Get a self-hosted runner group for an enterprise Gets a specific self-hosted runner group for an enterprise.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

PatchEnterprisesenterpriseActionsRunnerGroupsrunnerGroupId(String, String)

• tags enterprise-admin
• patch /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}
• docs https://docs.github.com/rest/reference/enterprise-admin#update-a-self-hosted-runner-group-for-an-enterprise

Update a self-hosted runner group for an enterprise Updates the name and visibility of a self-hosted runner group in an enterprise.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

DeleteEnterprisesenterpriseActionsRunnerGroupsrunnerGroupId(String, String)

• tags enterprise-admin
• delete /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}
• docs https://docs.github.com/rest/reference/enterprise-admin#delete-a-self-hosted-runner-group-from-an-enterprise

Delete a self-hosted runner group from an enterprise Deletes a self-hosted runner group for an enterprise.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

GetEnterprisesenterpriseActionsRunnerGroupsrunnerGroupIdOrganizations(String, String)

• tags enterprise-admin
• get /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations
• docs https://docs.github.com/rest/reference/enterprise-admin#list-organization-access-to-a-self-hosted-runner-group-in-a-enterprise

List organization access to a self-hosted runner group in an enterprise Lists the organizations with access to a self-hosted runner group.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

PutEnterprisesenterpriseActionsRunnerGroupsrunnerGroupIdOrganizations(String, String)

• tags enterprise-admin
• put /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations
• docs https://docs.github.com/rest/reference/enterprise-admin#set-organization-access-to-a-self-hosted-runner-group-in-an-enterprise

Set organization access for a self-hosted runner group in an enterprise Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

PutEnterprisesenterpriseActionsRunnerGroupsrunnerGroupIdOrganizationsorgId(String, String, String)

• tags enterprise-admin
• put /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}
• docs https://docs.github.com/rest/reference/enterprise-admin#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise

Add organization access to a self-hosted runner group in an enterprise Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see “Create a self-hosted runner group for an enterprise.”

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

DeleteEnterprisesenterpriseActionsRunnerGroupsrunnerGroupIdOrganizationsorgId(String, String, String)

• tags enterprise-admin
• delete /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}
• docs https://docs.github.com/rest/reference/enterprise-admin#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise

Remove organization access to a self-hosted runner group in an enterprise Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see “Create a self-hosted runner group for an enterprise.”

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

GetEnterprisesenterpriseActionsRunnerGroupsrunnerGroupIdRunners(String, String)

• tags enterprise-admin
• get /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners
• docs https://docs.github.com/rest/reference/enterprise-admin#list-self-hosted-runners-in-a-group-for-an-enterprise

List self-hosted runners in a group for an enterprise Lists the self-hosted runners that are in a specific enterprise group.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

PutEnterprisesenterpriseActionsRunnerGroupsrunnerGroupIdRunners(String, String)

• tags enterprise-admin
• put /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners
• docs https://docs.github.com/rest/reference/enterprise-admin#set-self-hosted-runners-in-a-group-for-an-enterprise

Set self-hosted runners in a group for an enterprise Replaces the list of self-hosted runners that are part of an enterprise runner group.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

PutEnterprisesenterpriseActionsRunnerGroupsrunnerGroupIdRunnersrunnerId(String, String, String)

• tags enterprise-admin
• put /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}
• docs https://docs.github.com/rest/reference/enterprise-admin#add-a-self-hosted-runner-to-a-group-for-an-enterprise

Add a self-hosted runner to a group for an enterprise Adds a self-hosted runner to a runner group configured in an enterprise.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

DeleteEnterprisesenterpriseActionsRunnerGroupsrunnerGroupIdRunnersrunnerId(String, String, String)

• tags enterprise-admin
• delete /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}
• docs https://docs.github.com/rest/reference/enterprise-admin#remove-a-self-hosted-runner-from-a-group-for-an-enterprise

Remove a self-hosted runner from a group for an enterprise Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

GetEnterprisesenterpriseActionsRunners(String)

• tags enterprise-admin
• get /enterprises/{enterprise}/actions/runners
• docs https://docs.github.com/rest/reference/enterprise-admin#list-self-hosted-runners-for-an-enterprise

List self-hosted runners for an enterprise Lists all self-hosted runners configured for an enterprise.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

GetEnterprisesenterpriseActionsRunnersDownloads(String)

• tags enterprise-admin
• get /enterprises/{enterprise}/actions/runners/downloads
• docs https://docs.github.com/rest/reference/enterprise-admin#list-runner-applications-for-an-enterprise

List runner applications for an enterprise Lists binaries for the runner application that you can download and run.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

PostEnterprisesenterpriseActionsRunnersRegistrationToken(String)

• tags enterprise-admin
• post /enterprises/{enterprise}/actions/runners/registration-token
• docs https://docs.github.com/rest/reference/enterprise-admin#create-a-registration-token-for-an-enterprise

Create a registration token for an enterprise Returns a token that you can pass to the config script. The token expires after one hour.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

Example using registration token

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN

PostEnterprisesenterpriseActionsRunnersRemoveToken(String)

• tags enterprise-admin
• post /enterprises/{enterprise}/actions/runners/remove-token
• docs https://docs.github.com/rest/reference/enterprise-admin#create-a-remove-token-for-an-enterprise

Create a remove token for an enterprise Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

Example using remove token

To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this endpoint.

./config.sh remove --token TOKEN

GetEnterprisesenterpriseActionsRunnersrunnerId(String, String)

• tags enterprise-admin
• get /enterprises/{enterprise}/actions/runners/{runner_id}
• docs https://docs.github.com/rest/reference/enterprise-admin#get-a-self-hosted-runner-for-an-enterprise

Get a self-hosted runner for an enterprise Gets a specific self-hosted runner configured in an enterprise.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

DeleteEnterprisesenterpriseActionsRunnersrunnerId(String, String)

• tags enterprise-admin
• delete /enterprises/{enterprise}/actions/runners/{runner_id}
• docs https://docs.github.com/rest/reference/enterprise-admin#delete-self-hosted-runner-from-an-enterprise

Delete a self-hosted runner from an enterprise Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

GetEnterprisesenterpriseActionsRunnersrunnerIdLabels(String, String)

• tags enterprise-admin
• get /enterprises/{enterprise}/actions/runners/{runner_id}/labels
• docs https://docs.github.com/rest/reference/enterprise-admin#list-labels-for-a-self-hosted-runner-for-an-enterprise

List labels for a self-hosted runner for an enterprise Lists all labels for a self-hosted runner configured in an enterprise.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

PostEnterprisesenterpriseActionsRunnersrunnerIdLabels(String, String)

• tags enterprise-admin
• post /enterprises/{enterprise}/actions/runners/{runner_id}/labels
• docs https://docs.github.com/rest/reference/enterprise-admin#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise

Add custom labels to a self-hosted runner for an enterprise Add custom labels to a self-hosted runner configured in an enterprise.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

PutEnterprisesenterpriseActionsRunnersrunnerIdLabels(String, String)

• tags enterprise-admin
• put /enterprises/{enterprise}/actions/runners/{runner_id}/labels
• docs https://docs.github.com/rest/reference/enterprise-admin#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise

Set custom labels for a self-hosted runner for an enterprise Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in an enterprise.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

DeleteEnterprisesenterpriseActionsRunnersrunnerIdLabels(String, String)

• tags enterprise-admin
• delete /enterprises/{enterprise}/actions/runners/{runner_id}/labels
• docs https://docs.github.com/rest/reference/enterprise-admin#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise

Remove all custom labels from a self-hosted runner for an enterprise Remove all custom labels from a self-hosted runner configured in an enterprise. Returns the remaining read-only labels from the runner.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

DeleteEnterprisesenterpriseActionsRunnersrunnerIdLabelsname(String, String, String)

• tags enterprise-admin
• delete /enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}
• docs https://docs.github.com/rest/reference/enterprise-admin#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise

Remove a custom label from a self-hosted runner for an enterprise Remove a custom label from a self-hosted runner configured in an enterprise. Returns the remaining labels from the runner.

This endpoint returns a 404 Not Found status if the custom label is not present on the runner.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

GetEnterprisesenterpriseAuditLog(String)

• tags enterprise-admin
• get /enterprises/{enterprise}/audit-log
• docs https://docs.github.com/rest/reference/enterprise-admin#get-the-audit-log-for-an-enterprise

Get the audit log for an enterprise Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the admin:enterprise scope.

GetEnterprisesenterpriseSecretScanningAlerts(String)

• tags secret-scanning
• get /enterprises/{enterprise}/secret-scanning/alerts
• docs https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-an-enterprise

List secret scanning alerts for an enterprise Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. To use this endpoint, you must be a member of the enterprise, and you must use an access token with the repo scope or security_events scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager.

GetEnterprisesenterpriseSettingsBillingActions(String)

• tags billing
• get /enterprises/{enterprise}/settings/billing/actions
• docs https://docs.github.com/rest/reference/billing#get-github-actions-billing-for-an-enterprise

Get GitHub Actions billing for an enterprise Gets the summary of the free and paid GitHub Actions minutes used.

Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see “Managing billing for GitHub Actions”.

The authenticated user must be an enterprise admin.

GetEnterprisesenterpriseSettingsBillingAdvancedSecurity(String)

• tags billing
• get /enterprises/{enterprise}/settings/billing/advanced-security
• docs https://docs.github.com/rest/reference/billing#export-advanced-security-active-committers-data-for-enterprise

Get GitHub Advanced Security active committers for an enterprise Gets the GitHub Advanced Security active committers for an enterprise per repository. Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.

GetEnterprisesenterpriseSettingsBillingPackages(String)

• tags billing
• get /enterprises/{enterprise}/settings/billing/packages
• docs https://docs.github.com/rest/reference/billing#get-github-packages-billing-for-an-enterprise

Get GitHub Packages billing for an enterprise Gets the free and paid storage used for GitHub Packages in gigabytes.

Paid minutes only apply to packages stored for private repositories. For more information, see “Managing billing for GitHub Packages.”

The authenticated user must be an enterprise admin.

GetEnterprisesenterpriseSettingsBillingSharedStorage(String)

• tags billing
• get /enterprises/{enterprise}/settings/billing/shared-storage
• docs https://docs.github.com/rest/reference/billing#get-shared-storage-billing-for-an-enterprise

Get shared storage billing for an enterprise Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages.

Paid minutes only apply to packages stored for private repositories. For more information, see “Managing billing for GitHub Packages.”

The authenticated user must be an enterprise admin.

GetEvents()

• tags activity
• get /events
• docs https://docs.github.com/rest/reference/activity#list-public-events

List public events We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.

GetFeeds()

• tags activity
• get /feeds
• docs https://docs.github.com/rest/reference/activity#get-feeds

Get feeds GitHub provides several timeline resources in Atom format. The Feeds API lists all the feeds available to the authenticated user:

• Timeline: The GitHub global public timeline
• User: The public timeline for any user, using URI template
• Current user public: The public timeline for the authenticated user
• Current user: The private timeline for the authenticated user
• Current user actor: The private timeline for activity created by the authenticated user
• Current user organizations: The private timeline for the organizations the authenticated user is a member of.
• Security advisories: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.

Note: Private feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.

GetGists()

• tags gists
• get /gists
• docs https://docs.github.com/rest/reference/gists#list-gists-for-the-authenticated-user

List gists for the authenticated user Lists the authenticated user’s gists or if called anonymously, this endpoint returns all public gists:

PostGists()

• tags gists
• post /gists
• docs https://docs.github.com/rest/reference/gists#create-a-gist

Create a gist Allows you to add a new gist with one or more files.

Note: Don’t name your files “gistfile” with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.

GetGistsPublic()

• tags gists
• get /gists/public
• docs https://docs.github.com/rest/reference/gists#list-public-gists

List public gists List public gists sorted by most recently updated to least recently updated.

Note: With pagination, you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.

GetGistsStarred()

• tags gists
• get /gists/starred
• docs https://docs.github.com/rest/reference/gists#list-starred-gists

List starred gists List the authenticated user’s starred gists:

GetGistsgistId(String)

• tags gists
• get /gists/{gist_id}
• docs https://docs.github.com/rest/reference/gists#get-a-gist

Get a gist

PatchGistsgistId(String)

• tags gists
• patch /gists/{gist_id}
• docs https://docs.github.com/rest/reference/gists/#update-a-gist

Update a gist Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren’t explicitly changed during an edit are unchanged.

DeleteGistsgistId(String)

• tags gists
• delete /gists/{gist_id}
• docs https://docs.github.com/rest/reference/gists#delete-a-gist

Delete a gist

GetGistsgistIdComments(String)

• tags gists
• get /gists/{gist_id}/comments
• docs https://docs.github.com/rest/reference/gists#list-gist-comments

List gist comments

PostGistsgistIdComments(String)

• tags gists
• post /gists/{gist_id}/comments
• docs https://docs.github.com/rest/reference/gists#create-a-gist-comment

Create a gist comment

GetGistsgistIdCommentscommentId(String, String)

• tags gists
• get /gists/{gist_id}/comments/{comment_id}
• docs https://docs.github.com/rest/reference/gists#get-a-gist-comment

Get a gist comment

PatchGistsgistIdCommentscommentId(String, String)

• tags gists
• patch /gists/{gist_id}/comments/{comment_id}
• docs https://docs.github.com/rest/reference/gists#update-a-gist-comment

Update a gist comment

DeleteGistsgistIdCommentscommentId(String, String)

• tags gists
• delete /gists/{gist_id}/comments/{comment_id}
• docs https://docs.github.com/rest/reference/gists#delete-a-gist-comment

Delete a gist comment

GetGistsgistIdCommits(String)

• tags gists
• get /gists/{gist_id}/commits
• docs https://docs.github.com/rest/reference/gists#list-gist-commits

List gist commits

GetGistsgistIdForks(String)

• tags gists
• get /gists/{gist_id}/forks
• docs https://docs.github.com/rest/reference/gists#list-gist-forks

List gist forks

PostGistsgistIdForks(String)

• tags gists
• post /gists/{gist_id}/forks
• docs https://docs.github.com/rest/reference/gists#fork-a-gist

Fork a gist Note: This was previously /gists/:gist_id/fork.

GetGistsgistIdStar(String)

• tags gists
• get /gists/{gist_id}/star
• docs https://docs.github.com/rest/reference/gists#check-if-a-gist-is-starred

Check if a gist is starred

PutGistsgistIdStar(String)

• tags gists
• put /gists/{gist_id}/star
• docs https://docs.github.com/rest/reference/gists#star-a-gist

Star a gist Note that you’ll need to set Content-Length to zero when calling out to this endpoint. For more information, see “HTTP verbs.”

DeleteGistsgistIdStar(String)

• tags gists
• delete /gists/{gist_id}/star
• docs https://docs.github.com/rest/reference/gists#unstar-a-gist

Unstar a gist

GetGistsgistIdsha(String, String)

• tags gists
• get /gists/{gist_id}/{sha}
• docs https://docs.github.com/rest/reference/gists#get-a-gist-revision

Get a gist revision

GetGitignoreTemplates()

• tags gitignore
• get /gitignore/templates
• docs https://docs.github.com/rest/reference/gitignore#get-all-gitignore-templates

Get all gitignore templates List all templates available to pass as an option when creating a repository.

GetGitignoreTemplatesname(String)

• tags gitignore
• get /gitignore/templates/{name}
• docs https://docs.github.com/rest/reference/gitignore#get-a-gitignore-template

Get a gitignore template The API also allows fetching the source of a single template. Use the raw media type to get the raw contents.

GetInstallationRepositories()

• tags apps
• get /installation/repositories
• docs https://docs.github.com/rest/reference/apps#list-repositories-accessible-to-the-app-installation

List repositories accessible to the app installation List repositories that an app installation can access.

You must use an installation access token to access this endpoint.

DeleteInstallationToken()

• tags apps
• delete /installation/token
• docs https://docs.github.com/rest/reference/apps#revoke-an-installation-access-token

Revoke an installation access token Revokes the installation token you’re using to authenticate as an installation and access this endpoint.

Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the “Create an installation access token for an app” endpoint.

You must use an installation access token to access this endpoint.

GetIssues()

• tags issues
• get /issues
• docs https://docs.github.com/rest/reference/issues#list-issues-assigned-to-the-authenticated-user

List issues assigned to the authenticated user List issues assigned to the authenticated user across all visible repositories including owned repositories, member repositories, and organization repositories. You can use the filter query parameter to fetch issues that are not necessarily assigned to you.

Note: GitHub’s REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, “Issues” endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from “Issues” endpoints will be an issue id. To find out the pull request id, use the “List pull requests” endpoint.

GetLicenses()

• tags licenses
• get /licenses
• docs https://docs.github.com/rest/reference/licenses#get-all-commonly-used-licenses

Get all commonly used licenses

GetLicenseslicense(String)

• tags licenses
• get /licenses/{license}
• docs https://docs.github.com/rest/reference/licenses#get-a-license

Get a license

PostMarkdown()

• tags markdown
• post /markdown
• docs https://docs.github.com/rest/reference/markdown#render-a-markdown-document

Render a Markdown document

PostMarkdownRaw()

• tags markdown
• post /markdown/raw
• docs https://docs.github.com/rest/reference/markdown#render-a-markdown-document-in-raw-mode

Render a Markdown document in raw mode You must send Markdown as plain text (using a Content-Type header of text/plain or text/x-markdown) to this endpoint, rather than using JSON format. In raw mode, GitHub Flavored Markdown is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.

GetMarketplaceListingAccountsaccountId(String)

• tags apps
• get /marketplace_listing/accounts/{account_id}
• docs https://docs.github.com/rest/reference/apps#get-a-subscription-plan-for-an-account

Get a subscription plan for an account Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won’t be processed until the end of their billing cycle, you will also see the upcoming pending change.

GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

GetMarketplaceListingPlans()

• tags apps
• get /marketplace_listing/plans
• docs https://docs.github.com/rest/reference/apps#list-plans

List plans Lists all plans that are part of your GitHub Marketplace listing.

GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

GetMarketplaceListingPlansplanIdAccounts(String)

• tags apps
• get /marketplace_listing/plans/{plan_id}/accounts
• docs https://docs.github.com/rest/reference/apps#list-accounts-for-a-plan

List accounts for a plan Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won’t be processed until the end of their billing cycle, you will also see the upcoming pending change.

GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

GetMarketplaceListingStubbedAccountsaccountId(String)

• tags apps
• get /marketplace_listing/stubbed/accounts/{account_id}
• docs https://docs.github.com/rest/reference/apps#get-a-subscription-plan-for-an-account-stubbed

Get a subscription plan for an account (stubbed) Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won’t be processed until the end of their billing cycle, you will also see the upcoming pending change.

GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

GetMarketplaceListingStubbedPlans()

• tags apps
• get /marketplace_listing/stubbed/plans
• docs https://docs.github.com/rest/reference/apps#list-plans-stubbed

List plans (stubbed) Lists all plans that are part of your GitHub Marketplace listing.

GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

GetMarketplaceListingStubbedPlansplanIdAccounts(String)

• tags apps
• get /marketplace_listing/stubbed/plans/{plan_id}/accounts
• docs https://docs.github.com/rest/reference/apps#list-accounts-for-a-plan-stubbed

List accounts for a plan (stubbed) Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won’t be processed until the end of their billing cycle, you will also see the upcoming pending change.

GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

GetMeta()

• tags meta
• get /meta
• docs https://docs.github.com/rest/reference/meta#get-github-meta-information

Get GitHub meta information Returns meta information about GitHub, including a list of GitHub’s IP addresses. For more information, see “About GitHub’s IP addresses.”

Note: The IP addresses shown in the documentation’s response are only example values. You must always query the API directly to get the latest list of IP addresses.

GetNetworksownerrepoEvents(String, String)

• tags activity
• get /networks/{owner}/{repo}/events
• docs https://docs.github.com/rest/reference/activity#list-public-events-for-a-network-of-repositories

List public events for a network of repositories

GetNotifications()

• tags activity
• get /notifications
• docs https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user

List notifications for the authenticated user List all notifications for the current user, sorted by most recently updated.

PutNotifications()

• tags activity
• put /notifications
• docs https://docs.github.com/rest/reference/activity#mark-notifications-as-read

Mark notifications as read Marks all notifications as “read” removes it from the default view on GitHub. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub will run an asynchronous process to mark notifications as “read.” To check whether any “unread” notifications remain, you can use the List notifications for the authenticated user endpoint and pass the query parameter all=false.

GetNotificationsThreadsthreadId(String)

• tags activity
• get /notifications/threads/{thread_id}
• docs https://docs.github.com/rest/reference/activity#get-a-thread

Get a thread

PatchNotificationsThreadsthreadId(String)

• tags activity
• patch /notifications/threads/{thread_id}
• docs https://docs.github.com/rest/reference/activity#mark-a-thread-as-read

Mark a thread as read

GetNotificationsThreadsthreadIdSubscription(String)

• tags activity
• get /notifications/threads/{thread_id}/subscription
• docs https://docs.github.com/rest/reference/activity#get-a-thread-subscription-for-the-authenticated-user

Get a thread subscription for the authenticated user This checks to see if the current user is subscribed to a thread. You can also get a repository subscription.

Note that subscriptions are only generated if a user is participating in a conversation–for example, they’ve replied to the thread, were @mentioned, or manually subscribe to a thread.

PutNotificationsThreadsthreadIdSubscription(String)

• tags activity
• put /notifications/threads/{thread_id}/subscription
• docs https://docs.github.com/rest/reference/activity#set-a-thread-subscription

Set a thread subscription If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an @mention.

You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.

Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the Delete a thread subscription endpoint.

DeleteNotificationsThreadsthreadIdSubscription(String)

• tags activity
• delete /notifications/threads/{thread_id}/subscription
• docs https://docs.github.com/rest/reference/activity#delete-a-thread-subscription

Delete a thread subscription Mutes all future notifications for a conversation until you comment on the thread or get an @mention. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the Set a thread subscription endpoint and set ignore to true.

GetOctocat()

• tags meta
• get /octocat
• docs https://docs.github.com/rest/reference/meta#get-octocat

Get Octocat Get the octocat as ASCII art

GetOrganizations()

• tags orgs
• get /organizations
• docs https://docs.github.com/rest/reference/orgs#list-organizations

List organizations Lists all organizations, in the order that they were created on GitHub.

Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.

GetOrganizationsorganizationIdCustomRoles(String)

• tags orgs
• get /organizations/{organization_id}/custom_roles
• docs https://docs.github.com/rest/reference/orgs#list-custom-repository-roles-in-an-organization

List custom repository roles in an organization List the custom repository roles available in this organization. In order to see custom repository roles in an organization, the authenticated user must be an organization owner.

For more information on custom repository roles, see “Managing custom repository roles for an organization”.

GetOrganizationsorgTeamteamSlugExternalGroups(String, String)

• tags teams
• get /organizations/{org}/team/{team_slug}/external-groups
• docs https://docs.github.com/rest/reference/teams#list-external-idp-group-team-connection

List a connection between an external group and a team Lists a connection between a team and an external group.

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see “GitHub’s products” in the GitHub Help documentation.

GetOrgsorg(String)

• tags orgs
• get /orgs/{org}
• docs https://docs.github.com/rest/reference/orgs#get-an-organization

Get an organization To see many of the organization response values, you need to be an authenticated organization owner with the admin:org scope. When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.

GitHub Apps with the Organization plan permission can use this endpoint to retrieve information about an organization’s GitHub plan. See “Authenticating with GitHub Apps” for details. For an example response, see ‘Response with GitHub plan information’ below.“

PatchOrgsorg(String)

• tags orgs
• patch /orgs/{org}
• docs https://docs.github.com/rest/reference/orgs/#update-an-organization

Update an organization Parameter Deprecation Notice: GitHub will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.

Enables an authenticated organization owner with the admin:org scope to update the organization’s profile and member privileges.

GetOrgsorgActionsPermissions(String)

• tags actions
• get /orgs/{org}/actions/permissions
• docs https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-an-organization

Get GitHub Actions permissions for an organization Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

PutOrgsorgActionsPermissions(String)

• tags actions
• put /orgs/{org}/actions/permissions
• docs https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-an-organization

Set GitHub Actions permissions for an organization Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.

If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as allowed_actions to selected actions, then you cannot override them for the organization.

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

GetOrgsorgActionsPermissionsRepositories(String)

• tags actions
• get /orgs/{org}/actions/permissions/repositories
• docs https://docs.github.com/rest/reference/actions#list-selected-repositories-enabled-for-github-actions-in-an-organization

List selected repositories enabled for GitHub Actions in an organization Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see “Set GitHub Actions permissions for an organization.”

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

PutOrgsorgActionsPermissionsRepositories(String)

• tags actions
• put /orgs/{org}/actions/permissions/repositories
• docs https://docs.github.com/rest/reference/actions#set-selected-repositories-enabled-for-github-actions-in-an-organization

Set selected repositories enabled for GitHub Actions in an organization Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see “Set GitHub Actions permissions for an organization.”

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

PutOrgsorgActionsPermissionsRepositoriesrepositoryId(String, String)

• tags actions
• put /orgs/{org}/actions/permissions/repositories/{repository_id}
• docs https://docs.github.com/rest/reference/actions#enable-a-selected-repository-for-github-actions-in-an-organization

Enable a selected repository for GitHub Actions in an organization Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be must be configured to selected. For more information, see “Set GitHub Actions permissions for an organization.”

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

DeleteOrgsorgActionsPermissionsRepositoriesrepositoryId(String, String)

• tags actions
• delete /orgs/{org}/actions/permissions/repositories/{repository_id}
• docs https://docs.github.com/rest/reference/actions#disable-a-selected-repository-for-github-actions-in-an-organization

Disable a selected repository for GitHub Actions in an organization Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see “Set GitHub Actions permissions for an organization.”

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

GetOrgsorgActionsPermissionsSelectedActions(String)

• tags actions
• get /orgs/{org}/actions/permissions/selected-actions
• docs https://docs.github.com/rest/reference/actions#get-allowed-actions-for-an-organization

Get allowed actions for an organization Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see “Set GitHub Actions permissions for an organization.”“

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

PutOrgsorgActionsPermissionsSelectedActions(String)

• tags actions
• put /orgs/{org}/actions/permissions/selected-actions
• docs https://docs.github.com/rest/reference/actions#set-allowed-actions-for-an-organization

Set allowed actions for an organization Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see “Set GitHub Actions permissions for an organization.”

If the organization belongs to an enterprise that has selected actions set at the enterprise level, then you cannot override any of the enterprise’s allowed actions settings.

To use the patterns_allowed setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories in the organization.

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

GetOrgsorgActionsPermissionsWorkflow(String)

• tags actions
• get /orgs/{org}/actions/permissions/workflow
• docs https://docs.github.com/rest/reference/actions#get-default-workflow-permissions

Get default workflow permissions Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization, as well if GitHub Actions can submit approving pull request reviews.

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

PutOrgsorgActionsPermissionsWorkflow(String)

• tags actions
• put /orgs/{org}/actions/permissions/workflow
• docs https://docs.github.com/rest/reference/actions#set-default-workflow-permissions

Set default workflow permissions Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization, and sets if GitHub Actions can submit approving pull request reviews.

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

GetOrgsorgActionsRunnerGroups(String)

• tags actions
• get /orgs/{org}/actions/runner-groups
• docs https://docs.github.com/rest/reference/actions#list-self-hosted-runner-groups-for-an-organization

List self-hosted runner groups for an organization The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”

Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.

You must authenticate using an access token with the admin:org scope to use this endpoint.

PostOrgsorgActionsRunnerGroups(String)

• tags actions
• post /orgs/{org}/actions/runner-groups
• docs https://docs.github.com/rest/reference/actions#create-a-self-hosted-runner-group-for-an-organization

Create a self-hosted runner group for an organization The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see “GitHub’s products.”

Creates a new self-hosted runner group for an organization.

You must authenticate using an access token with the admin:org scope to use this endpoint.

GetOrgsorgActionsRunnerGroupsrunnerGroupId(String, String)

• tags actions
• get /orgs/{org}/actions/runner-groups/{runner_group_id}
• docs https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-group-for-an-organization

Get a self-hosted runner group for an organization The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”

Gets a specific self-hosted runner group for an organization.

You must authenticate using an access token with the admin:org scope to use this endpoint.

PatchOrgsorgActionsRunnerGroupsrunnerGroupId(String, String)

• tags actions
• patch /orgs/{org}/actions/runner-groups/{runner_group_id}
• docs https://docs.github.com/rest/reference/actions#update-a-self-hosted-runner-group-for-an-organization

Update a self-hosted runner group for an organization The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”

Updates the name and visibility of a self-hosted runner group in an organization.

You must authenticate using an access token with the admin:org scope to use this endpoint.

DeleteOrgsorgActionsRunnerGroupsrunnerGroupId(String, String)

• tags actions
• delete /orgs/{org}/actions/runner-groups/{runner_group_id}
• docs https://docs.github.com/rest/reference/actions#delete-a-self-hosted-runner-group-from-an-organization

Delete a self-hosted runner group from an organization The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”

Deletes a self-hosted runner group for an organization.

You must authenticate using an access token with the admin:org scope to use this endpoint.

GetOrgsorgActionsRunnerGroupsrunnerGroupIdRepositories(String, String)

• tags actions
• get /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories
• docs https://docs.github.com/rest/reference/actions#list-repository-access-to-a-self-hosted-runner-group-in-an-organization

List repository access to a self-hosted runner group in an organization The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see “GitHub’s products.”

Lists the repositories with access to a self-hosted runner group configured in an organization.

You must authenticate using an access token with the admin:org scope to use this endpoint.

PutOrgsorgActionsRunnerGroupsrunnerGroupIdRepositories(String, String)

• tags actions
• put /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories
• docs https://docs.github.com/rest/reference/actions#set-repository-access-to-a-self-hosted-runner-group-in-an-organization

Set repository access for a self-hosted runner group in an organization The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”

Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.

You must authenticate using an access token with the admin:org scope to use this endpoint.

PutOrgsorgActionsRunnerGroupsrunnerGroupIdRepositoriesrepositoryId(String, String, String)

• tags actions
• put /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}
• docs https://docs.github.com/rest/reference/actions#add-repository-acess-to-a-self-hosted-runner-group-in-an-organization

Add repository access to a self-hosted runner group in an organization The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”

Adds a repository to the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see “Create a self-hosted runner group for an organization.”

You must authenticate using an access token with the admin:org scope to use this endpoint.

DeleteOrgsorgActionsRunnerGroupsrunnerGroupIdRepositoriesrepositoryId(String, String, String)

• tags actions
• delete /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}
• docs https://docs.github.com/rest/reference/actions#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization

Remove repository access to a self-hosted runner group in an organization The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”

Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see “Create a self-hosted runner group for an organization.”

You must authenticate using an access token with the admin:org scope to use this endpoint.

GetOrgsorgActionsRunnerGroupsrunnerGroupIdRunners(String, String)

• tags actions
• get /orgs/{org}/actions/runner-groups/{runner_group_id}/runners
• docs https://docs.github.com/rest/reference/actions#list-self-hosted-runners-in-a-group-for-an-organization

List self-hosted runners in a group for an organization The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”

Lists self-hosted runners that are in a specific organization group.

You must authenticate using an access token with the admin:org scope to use this endpoint.

PutOrgsorgActionsRunnerGroupsrunnerGroupIdRunners(String, String)

• tags actions
• put /orgs/{org}/actions/runner-groups/{runner_group_id}/runners
• docs https://docs.github.com/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization

Set self-hosted runners in a group for an organization The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”

Replaces the list of self-hosted runners that are part of an organization runner group.

You must authenticate using an access token with the admin:org scope to use this endpoint.

PutOrgsorgActionsRunnerGroupsrunnerGroupIdRunnersrunnerId(String, String, String)

• tags actions
• put /orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}
• docs https://docs.github.com/rest/reference/actions#add-a-self-hosted-runner-to-a-group-for-an-organization

Add a self-hosted runner to a group for an organization The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”

Adds a self-hosted runner to a runner group configured in an organization.

You must authenticate using an access token with the admin:org scope to use this endpoint.

DeleteOrgsorgActionsRunnerGroupsrunnerGroupIdRunnersrunnerId(String, String, String)

• tags actions
• delete /orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}
• docs https://docs.github.com/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization

Remove a self-hosted runner from a group for an organization The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”

Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.

You must authenticate using an access token with the admin:org scope to use this endpoint.

GetOrgsorgActionsRunners(String)

• tags actions
• get /orgs/{org}/actions/runners
• docs https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-an-organization

List self-hosted runners for an organization Lists all self-hosted runners configured in an organization.

You must authenticate using an access token with the admin:org scope to use this endpoint.

GetOrgsorgActionsRunnersDownloads(String)

• tags actions
• get /orgs/{org}/actions/runners/downloads
• docs https://docs.github.com/rest/reference/actions#list-runner-applications-for-an-organization

List runner applications for an organization Lists binaries for the runner application that you can download and run.

You must authenticate using an access token with the admin:org scope to use this endpoint.

PostOrgsorgActionsRunnersRegistrationToken(String)

• tags actions
• post /orgs/{org}/actions/runners/registration-token
• docs https://docs.github.com/rest/reference/actions#create-a-registration-token-for-an-organization

Create a registration token for an organization Returns a token that you can pass to the config script. The token expires after one hour.

You must authenticate using an access token with the admin:org scope to use this endpoint.

Example using registration token

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

./config.sh --url https://github.com/octo-org --token TOKEN

PostOrgsorgActionsRunnersRemoveToken(String)

• tags actions
• post /orgs/{org}/actions/runners/remove-token
• docs https://docs.github.com/rest/reference/actions#create-a-remove-token-for-an-organization

Create a remove token for an organization Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

You must authenticate using an access token with the admin:org scope to use this endpoint.

Example using remove token

To remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this endpoint.

./config.sh remove --token TOKEN

GetOrgsorgActionsRunnersrunnerId(String, String)

• tags actions
• get /orgs/{org}/actions/runners/{runner_id}
• docs https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-for-an-organization

Get a self-hosted runner for an organization Gets a specific self-hosted runner configured in an organization.

You must authenticate using an access token with the admin:org scope to use this endpoint.

DeleteOrgsorgActionsRunnersrunnerId(String, String)

• tags actions
• delete /orgs/{org}/actions/runners/{runner_id}
• docs https://docs.github.com/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization

Delete a self-hosted runner from an organization Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

You must authenticate using an access token with the admin:org scope to use this endpoint.

GetOrgsorgActionsRunnersrunnerIdLabels(String, String)

• tags actions
• get /orgs/{org}/actions/runners/{runner_id}/labels
• docs https://docs.github.com/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-an-organization

List labels for a self-hosted runner for an organization Lists all labels for a self-hosted runner configured in an organization.

You must authenticate using an access token with the admin:org scope to use this endpoint.

PostOrgsorgActionsRunnersrunnerIdLabels(String, String)

• tags actions
• post /orgs/{org}/actions/runners/{runner_id}/labels
• docs https://docs.github.com/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-an-organization

Add custom labels to a self-hosted runner for an organization Add custom labels to a self-hosted runner configured in an organization.

You must authenticate using an access token with the admin:org scope to use this endpoint.

PutOrgsorgActionsRunnersrunnerIdLabels(String, String)

• tags actions
• put /orgs/{org}/actions/runners/{runner_id}/labels
• docs https://docs.github.com/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-an-organization

Set custom labels for a self-hosted runner for an organization Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in an organization.

You must authenticate using an access token with the admin:org scope to use this endpoint.

DeleteOrgsorgActionsRunnersrunnerIdLabels(String, String)

• tags actions
• delete /orgs/{org}/actions/runners/{runner_id}/labels
• docs https://docs.github.com/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization

Remove all custom labels from a self-hosted runner for an organization Remove all custom labels from a self-hosted runner configured in an organization. Returns the remaining read-only labels from the runner.

You must authenticate using an access token with the admin:org scope to use this endpoint.

DeleteOrgsorgActionsRunnersrunnerIdLabelsname(String, String, String)

• tags actions
• delete /orgs/{org}/actions/runners/{runner_id}/labels/{name}
• docs https://docs.github.com/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization

Remove a custom label from a self-hosted runner for an organization Remove a custom label from a self-hosted runner configured in an organization. Returns the remaining labels from the runner.

This endpoint returns a 404 Not Found status if the custom label is not present on the runner.

You must authenticate using an access token with the admin:org scope to use this endpoint.

GetOrgsorgActionsSecrets(String)

• tags actions
• get /orgs/{org}/actions/secrets
• docs https://docs.github.com/rest/reference/actions#list-organization-secrets

List organization secrets Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

GetOrgsorgActionsSecretsPublicKey(String)

• tags actions
• get /orgs/{org}/actions/secrets/public-key
• docs https://docs.github.com/rest/reference/actions#get-an-organization-public-key

Get an organization public key Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

GetOrgsorgActionsSecretssecretName(String, String)

• tags actions
• get /orgs/{org}/actions/secrets/{secret_name}
• docs https://docs.github.com/rest/reference/actions#get-an-organization-secret

Get an organization secret Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

PutOrgsorgActionsSecretssecretName(String, String)

• tags actions
• put /orgs/{org}/actions/secrets/{secret_name}
• docs https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret

Create or update an organization secret Creates or updates an organization secret with an encrypted value. Encrypt your secret using LibSodium. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

Example encrypting a secret using Node.js

Encrypt your secret using the tweetsodium library.

const sodium = require('tweetsodium');

const key = "base64-encoded-public-key";
const value = "plain-text-secret";

// Convert the message and key to Uint8Array's (Buffer implements that interface)
const messageBytes = Buffer.from(value);
const keyBytes = Buffer.from(key, 'base64');

// Encrypt using LibSodium.
const encryptedBytes = sodium.seal(messageBytes, keyBytes);

// Base64 the encrypted secret
const encrypted = Buffer.from(encryptedBytes).toString('base64');

console.log(encrypted);

Example encrypting a secret using Python

Encrypt your secret using pynacl with Python 3.

from base64 import b64encode
from nacl import encoding, public

def encrypt(public_key: str, secret_value: str) -> str:
  """Encrypt a Unicode string using the public key."""
  public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
  sealed_box = public.SealedBox(public_key)
  encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
  return b64encode(encrypted).decode("utf-8")

Example encrypting a secret using C#

Encrypt your secret using the Sodium.Core package.

var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");

var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);

Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));

Example encrypting a secret using Ruby

Encrypt your secret using the rbnacl gem.

require "rbnacl"
require "base64"

key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
public_key = RbNaCl::PublicKey.new(key)

box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
encrypted_secret = box.encrypt("my_secret")

# Print the base64 encoded secret
puts Base64.strict_encode64(encrypted_secret)

DeleteOrgsorgActionsSecretssecretName(String, String)

• tags actions
• delete /orgs/{org}/actions/secrets/{secret_name}
• docs https://docs.github.com/rest/reference/actions#delete-an-organization-secret

Delete an organization secret Deletes a secret in an organization using the secret name. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

GetOrgsorgActionsSecretssecretNameRepositories(String, String)

• tags actions
• get /orgs/{org}/actions/secrets/{secret_name}/repositories
• docs https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret

List selected repositories for an organization secret Lists all repositories that have been selected when the visibility for repository access to a secret is set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

PutOrgsorgActionsSecretssecretNameRepositories(String, String)

• tags actions
• put /orgs/{org}/actions/secrets/{secret_name}/repositories
• docs https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret

Set selected repositories for an organization secret Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

PutOrgsorgActionsSecretssecretNameRepositoriesrepositoryId(String, String, String)

• tags actions
• put /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}
• docs https://docs.github.com/rest/reference/actions#add-selected-repository-to-an-organization-secret

Add selected repository to an organization secret Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

DeleteOrgsorgActionsSecretssecretNameRepositoriesrepositoryId(String, String, String)

• tags actions
• delete /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}
• docs https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret

Remove selected repository from an organization secret Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

GetOrgsorgAuditLog(String)

• tags orgs
• get /orgs/{org}/audit-log
• docs https://docs.github.com/rest/reference/orgs#get-audit-log

Get the audit log for an organization Gets the audit log for an organization. For more information, see “Reviewing the audit log for your organization.”

This endpoint is available for organizations on GitHub Enterprise Cloud. To use this endpoint, you must be an organization owner, and you must use an access token with the admin:org scope. GitHub Apps must have the organization_administration read permission to use this endpoint.

GetOrgsorgBlocks(String)

• tags orgs
• get /orgs/{org}/blocks
• docs https://docs.github.com/rest/reference/orgs#list-users-blocked-by-an-organization

List users blocked by an organization List the users blocked by an organization.

GetOrgsorgBlocksusername(String, String)

• tags orgs
• get /orgs/{org}/blocks/{username}
• docs https://docs.github.com/rest/reference/orgs#check-if-a-user-is-blocked-by-an-organization

Check if a user is blocked by an organization

PutOrgsorgBlocksusername(String, String)

• tags orgs
• put /orgs/{org}/blocks/{username}
• docs https://docs.github.com/rest/reference/orgs#block-a-user-from-an-organization

Block a user from an organization

DeleteOrgsorgBlocksusername(String, String)

• tags orgs
• delete /orgs/{org}/blocks/{username}
• docs https://docs.github.com/rest/reference/orgs#unblock-a-user-from-an-organization

Unblock a user from an organization

GetOrgsorgCodeScanningAlerts(String)

• tags code-scanning
• get /orgs/{org}/code-scanning/alerts
• docs https://docs.github.com/rest/reference/code-scanning#list-code-scanning-alerts-by-organization

List code scanning alerts for an organization Lists all code scanning alerts for the default branch (usually main or master) for all eligible repositories in an organization. To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the repo scope or security_events scope.

GitHub Apps must have the security_events read permission to use this endpoint.

GetOrgsorgCredentialAuthorizations(String)

• tags orgs
• get /orgs/{org}/credential-authorizations
• docs https://docs.github.com/rest/reference/orgs#list-saml-sso-authorizations-for-an-organization

List SAML SSO authorizations for an organization Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see GitHub’s products.

An authenticated organization owner with the read:org scope can list all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see About authentication with SAML single sign-on.

DeleteOrgsorgCredentialAuthorizationscredentialId(String, String)

• tags orgs
• delete /orgs/{org}/credential-authorizations/{credential_id}
• docs https://docs.github.com/rest/reference/orgs#remove-a-saml-sso-authorization-for-an-organization

Remove a SAML SSO authorization for an organization Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see GitHub’s products.

An authenticated organization owner with the admin:org scope can remove a credential authorization for an organization that uses SAML SSO. Once you remove someone’s credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access.

GetOrgsorgDependabotSecrets(String)

• tags dependabot
• get /orgs/{org}/dependabot/secrets
• docs https://docs.github.com/rest/reference/dependabot#list-organization-secrets

List organization secrets Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

GetOrgsorgDependabotSecretsPublicKey(String)

• tags dependabot
• get /orgs/{org}/dependabot/secrets/public-key
• docs https://docs.github.com/rest/reference/dependabot#get-an-organization-public-key

Get an organization public key Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

GetOrgsorgDependabotSecretssecretName(String, String)

• tags dependabot
• get /orgs/{org}/dependabot/secrets/{secret_name}
• docs https://docs.github.com/rest/reference/dependabot#get-an-organization-secret

Get an organization secret Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

PutOrgsorgDependabotSecretssecretName(String, String)

• tags dependabot
• put /orgs/{org}/dependabot/secrets/{secret_name}
• docs https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret

Create or update an organization secret Creates or updates an organization secret with an encrypted value. Encrypt your secret using LibSodium. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

Example encrypting a secret using Node.js

Encrypt your secret using the tweetsodium library.

const sodium = require('tweetsodium');

const key = "base64-encoded-public-key";
const value = "plain-text-secret";

// Convert the message and key to Uint8Array's (Buffer implements that interface)
const messageBytes = Buffer.from(value);
const keyBytes = Buffer.from(key, 'base64');

// Encrypt using LibSodium.
const encryptedBytes = sodium.seal(messageBytes, keyBytes);

// Base64 the encrypted secret
const encrypted = Buffer.from(encryptedBytes).toString('base64');

console.log(encrypted);

Example encrypting a secret using Python

Encrypt your secret using pynacl with Python 3.

from base64 import b64encode
from nacl import encoding, public

def encrypt(public_key: str, secret_value: str) -> str:
  """Encrypt a Unicode string using the public key."""
  public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
  sealed_box = public.SealedBox(public_key)
  encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
  return b64encode(encrypted).decode("utf-8")

Example encrypting a secret using C#

Encrypt your secret using the Sodium.Core package.

var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");

var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);

Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));

Example encrypting a secret using Ruby

Encrypt your secret using the rbnacl gem.

require "rbnacl"
require "base64"

key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
public_key = RbNaCl::PublicKey.new(key)

box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
encrypted_secret = box.encrypt("my_secret")

# Print the base64 encoded secret
puts Base64.strict_encode64(encrypted_secret)

DeleteOrgsorgDependabotSecretssecretName(String, String)

• tags dependabot
• delete /orgs/{org}/dependabot/secrets/{secret_name}
• docs https://docs.github.com/rest/reference/dependabot#delete-an-organization-secret

Delete an organization secret Deletes a secret in an organization using the secret name. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

GetOrgsorgDependabotSecretssecretNameRepositories(String, String)

• tags dependabot
• get /orgs/{org}/dependabot/secrets/{secret_name}/repositories
• docs https://docs.github.com/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret

List selected repositories for an organization secret Lists all repositories that have been selected when the visibility for repository access to a secret is set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

PutOrgsorgDependabotSecretssecretNameRepositories(String, String)

• tags dependabot
• put /orgs/{org}/dependabot/secrets/{secret_name}/repositories
• docs https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret

Set selected repositories for an organization secret Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

PutOrgsorgDependabotSecretssecretNameRepositoriesrepositoryId(String, String, String)

• tags dependabot
• put /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}
• docs https://docs.github.com/rest/reference/dependabot#add-selected-repository-to-an-organization-secret

Add selected repository to an organization secret Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

DeleteOrgsorgDependabotSecretssecretNameRepositoriesrepositoryId(String, String, String)

• tags dependabot
• delete /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}
• docs https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret

Remove selected repository from an organization secret Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

GetOrgsorgEvents(String)

• tags activity
• get /orgs/{org}/events
• docs https://docs.github.com/rest/reference/activity#list-public-organization-events

List public organization events

GetOrgsorgExternalGroupgroupId(String, String)

• tags teams
• get /orgs/{org}/external-group/{group_id}
• docs https://docs.github.com/rest/reference/teams#external-idp-group-info-for-an-organization

Get an external group Displays information about the specific group’s usage. Provides a list of the group’s external members as well as a list of teams that this group is connected to.

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see “GitHub’s products” in the GitHub Help documentation.

GetOrgsorgExternalGroups(String)

• tags teams
• get /orgs/{org}/external-groups
• docs https://docs.github.com/rest/reference/teams#list-external-idp-groups-for-an-organization

List external groups in an organization Lists external groups available in an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see “Offset and Cursor Pagination explained.”

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see “GitHub’s products” in the GitHub Help documentation.

GetOrgsorgFailedInvitations(String)

• tags orgs
• get /orgs/{org}/failed_invitations
• docs https://docs.github.com/rest/reference/orgs#list-failed-organization-invitations

List failed organization invitations The return hash contains failed_at and failed_reason fields which represent the time at which the invitation failed and the reason for the failure.

GetOrgsorgHooks(String)

• tags orgs
• get /orgs/{org}/hooks
• docs https://docs.github.com/rest/reference/orgs#list-organization-webhooks

List organization webhooks

PostOrgsorgHooks(String)

• tags orgs
• post /orgs/{org}/hooks
• docs https://docs.github.com/rest/reference/orgs#create-an-organization-webhook

Create an organization webhook Here’s how you can create a hook that posts payloads in JSON format:

GetOrgsorgHookshookId(String, String)

• tags orgs
• get /orgs/{org}/hooks/{hook_id}
• docs https://docs.github.com/rest/reference/orgs#get-an-organization-webhook

Get an organization webhook Returns a webhook configured in an organization. To get only the webhook config properties, see “Get a webhook configuration for an organization.”

PatchOrgsorgHookshookId(String, String)

• tags orgs
• patch /orgs/{org}/hooks/{hook_id}
• docs https://docs.github.com/rest/reference/orgs#update-an-organization-webhook

Update an organization webhook Updates a webhook configured in an organization. When you update a webhook, the secret will be overwritten. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use “Update a webhook configuration for an organization.”

DeleteOrgsorgHookshookId(String, String)

• tags orgs
• delete /orgs/{org}/hooks/{hook_id}
• docs https://docs.github.com/rest/reference/orgs#delete-an-organization-webhook

Delete an organization webhook

GetOrgsorgHookshookIdConfig(String, String)

• tags orgs
• get /orgs/{org}/hooks/{hook_id}/config
• docs https://docs.github.com/rest/reference/orgs#get-a-webhook-configuration-for-an-organization

Get a webhook configuration for an organization Returns the webhook configuration for an organization. To get more information about the webhook, including the active state and events, use “Get an organization webhook .”

Access tokens must have the admin:org_hook scope, and GitHub Apps must have the organization_hooks:read permission.

PatchOrgsorgHookshookIdConfig(String, String)

• tags orgs
• patch /orgs/{org}/hooks/{hook_id}/config
• docs https://docs.github.com/rest/reference/orgs#update-a-webhook-configuration-for-an-organization

Update a webhook configuration for an organization Updates the webhook configuration for an organization. To update more information about the webhook, including the active state and events, use “Update an organization webhook .”

Access tokens must have the admin:org_hook scope, and GitHub Apps must have the organization_hooks:write permission.

GetOrgsorgHookshookIdDeliveries(String, String)

• tags orgs
• get /orgs/{org}/hooks/{hook_id}/deliveries
• docs https://docs.github.com/rest/reference/orgs#list-deliveries-for-an-organization-webhook

List deliveries for an organization webhook Returns a list of webhook deliveries for a webhook configured in an organization.

GetOrgsorgHookshookIdDeliveriesdeliveryId(String, String, String)

• tags orgs
• get /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}
• docs https://docs.github.com/rest/reference/orgs#get-a-webhook-delivery-for-an-organization-webhook

Get a webhook delivery for an organization webhook Returns a delivery for a webhook configured in an organization.

PostOrgsorgHookshookIdDeliveriesdeliveryIdAttempts(String, String, String)

• tags orgs
• post /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts
• docs https://docs.github.com/rest/reference/orgs#redeliver-a-delivery-for-an-organization-webhook

Redeliver a delivery for an organization webhook Redeliver a delivery for a webhook configured in an organization.

PostOrgsorgHookshookIdPings(String, String)

• tags orgs
• post /orgs/{org}/hooks/{hook_id}/pings
• docs https://docs.github.com/rest/reference/orgs#ping-an-organization-webhook

Ping an organization webhook This will trigger a ping event to be sent to the hook.

GetOrgsorgInstallation(String)

• tags apps
• get /orgs/{org}/installation
• docs https://docs.github.com/rest/reference/apps#get-an-organization-installation-for-the-authenticated-app

Get an organization installation for the authenticated app Enables an authenticated GitHub App to find the organization’s installation information.

You must use a JWT to access this endpoint.

GetOrgsorgInstallations(String)

• tags orgs
• get /orgs/{org}/installations
• docs https://docs.github.com/rest/reference/orgs#list-app-installations-for-an-organization

List app installations for an organization Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with admin:read scope to use this endpoint.

GetOrgsorgInteractionLimits(String)

• tags interactions
• get /orgs/{org}/interaction-limits
• docs https://docs.github.com/rest/reference/interactions#get-interaction-restrictions-for-an-organization

Get interaction restrictions for an organization Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.

PutOrgsorgInteractionLimits(String)

• tags interactions
• put /orgs/{org}/interaction-limits
• docs https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-an-organization

Set interaction restrictions for an organization Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.

DeleteOrgsorgInteractionLimits(String)

• tags interactions
• delete /orgs/{org}/interaction-limits
• docs https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-for-an-organization

Remove interaction restrictions for an organization Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.

GetOrgsorgInvitations(String)

• tags orgs
• get /orgs/{org}/invitations
• docs https://docs.github.com/rest/reference/orgs#list-pending-organization-invitations

List pending organization invitations The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.

PostOrgsorgInvitations(String)

• tags orgs
• post /orgs/{org}/invitations
• docs https://docs.github.com/rest/reference/orgs#create-an-organization-invitation

Create an organization invitation Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.

DeleteOrgsorgInvitationsinvitationId(String, String)

• tags orgs
• delete /orgs/{org}/invitations/{invitation_id}
• docs https://docs.github.com/rest/reference/orgs#cancel-an-organization-invitation

Cancel an organization invitation Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.

This endpoint triggers notifications.

GetOrgsorgInvitationsinvitationIdTeams(String, String)

• tags orgs
• get /orgs/{org}/invitations/{invitation_id}/teams
• docs https://docs.github.com/rest/reference/orgs#list-organization-invitation-teams

List organization invitation teams List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.

GetOrgsorgIssues(String)

• tags issues
• get /orgs/{org}/issues
• docs https://docs.github.com/rest/reference/issues#list-organization-issues-assigned-to-the-authenticated-user

List organization issues assigned to the authenticated user List issues in an organization assigned to the authenticated user.

Note: GitHub’s REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, “Issues” endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from “Issues” endpoints will be an issue id. To find out the pull request id, use the “List pull requests” endpoint.

GetOrgsorgMembers(String)

• tags orgs
• get /orgs/{org}/members
• docs https://docs.github.com/rest/reference/orgs#list-organization-members

List organization members List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.

GetOrgsorgMembersusername(String, String)

• tags orgs
• get /orgs/{org}/members/{username}
• docs https://docs.github.com/rest/reference/orgs#check-organization-membership-for-a-user

Check organization membership for a user Check if a user is, publicly or privately, a member of the organization.

DeleteOrgsorgMembersusername(String, String)

• tags orgs
• delete /orgs/{org}/members/{username}
• docs https://docs.github.com/rest/reference/orgs#remove-an-organization-member

Remove an organization member Removing a user from this list will remove them from all teams and they will no longer have any access to the organization’s repositories.

GetOrgsorgMembershipsusername(String, String)

• tags orgs
• get /orgs/{org}/memberships/{username}
• docs https://docs.github.com/rest/reference/orgs#get-organization-membership-for-a-user

Get organization membership for a user In order to get a user’s membership with an organization, the authenticated user must be an organization member. The state parameter in the response can be used to identify the user’s membership status.

PutOrgsorgMembershipsusername(String, String)

• tags orgs
• put /orgs/{org}/memberships/{username}
• docs https://docs.github.com/rest/reference/orgs#set-organization-membership-for-a-user

Set organization membership for a user Only authenticated organization owners can add a member to the organization or update the member’s role.

• If the authenticated user is adding a member to the organization, the invited user will receive an email inviting them to the organization. The user’s membership status will be pending until they accept the invitation.

• Authenticated users can update a user’s membership by passing the role parameter. If the authenticated user changes a member’s role to admin, the affected user will receive an email notifying them that they’ve been made an organization owner. If the authenticated user changes an owner’s role to member, no email will be sent.

Rate limits

To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.

DeleteOrgsorgMembershipsusername(String, String)

• tags orgs
• delete /orgs/{org}/memberships/{username}
• docs https://docs.github.com/rest/reference/orgs#remove-organization-membership-for-a-user

Remove organization membership for a user In order to remove a user’s membership with an organization, the authenticated user must be an organization owner.

If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.

GetOrgsorgMigrations(String)

• tags migrations
• get /orgs/{org}/migrations
• docs https://docs.github.com/rest/reference/migrations#list-organization-migrations

List organization migrations Lists the most recent migrations.

PostOrgsorgMigrations(String)

• tags migrations
• post /orgs/{org}/migrations
• docs https://docs.github.com/rest/reference/migrations#start-an-organization-migration

Start an organization migration Initiates the generation of a migration archive.

GetOrgsorgMigrationsmigrationId(String, String)

• tags migrations
• get /orgs/{org}/migrations/{migration_id}
• docs https://docs.github.com/rest/reference/migrations#get-an-organization-migration-status

Get an organization migration status Fetches the status of a migration.

The state of a migration can be one of the following values:

• pending, which means the migration hasn’t started yet.
• exporting, which means the migration is in progress.
• exported, which means the migration finished successfully.
• failed, which means the migration failed.

GetOrgsorgMigrationsmigrationIdArchive(String, String)

• tags migrations
• get /orgs/{org}/migrations/{migration_id}/archive
• docs https://docs.github.com/rest/reference/migrations#download-an-organization-migration-archive

Download an organization migration archive Fetches the URL to a migration archive.

DeleteOrgsorgMigrationsmigrationIdArchive(String, String)

• tags migrations
• delete /orgs/{org}/migrations/{migration_id}/archive
• docs https://docs.github.com/rest/reference/migrations#delete-an-organization-migration-archive

Delete an organization migration archive Deletes a previous migration archive. Migration archives are automatically deleted after seven days.

DeleteOrgsorgMigrationsmigrationIdReposrepoNameLock(String, String, String)

• tags migrations
• delete /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock
• docs https://docs.github.com/rest/reference/migrations#unlock-an-organization-repository

Unlock an organization repository Unlocks a repository that was locked for migration. You should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.

GetOrgsorgMigrationsmigrationIdRepositories(String, String)

• tags migrations
• get /orgs/{org}/migrations/{migration_id}/repositories
• docs https://docs.github.com/rest/reference/migrations#list-repositories-in-an-organization-migration

List repositories in an organization migration List all the repositories for this organization migration.

GetOrgsorgOutsideCollaborators(String)

• tags orgs
• get /orgs/{org}/outside_collaborators
• docs https://docs.github.com/rest/reference/orgs#list-outside-collaborators-for-an-organization

List outside collaborators for an organization List all users who are outside collaborators of an organization.

PutOrgsorgOutsideCollaboratorsusername(String, String)

• tags orgs
• put /orgs/{org}/outside_collaborators/{username}
• docs https://docs.github.com/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator

Convert an organization member to outside collaborator When an organization member is converted to an outside collaborator, they’ll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see “Converting an organization member to an outside collaborator”.

DeleteOrgsorgOutsideCollaboratorsusername(String, String)

• tags orgs
• delete /orgs/{org}/outside_collaborators/{username}
• docs https://docs.github.com/rest/reference/orgs#remove-outside-collaborator-from-an-organization

Remove outside collaborator from an organization Removing a user from this list will remove them from all the organization’s repositories.

GetOrgsorgPackages(String)

• tags packages
• get /orgs/{org}/packages
• docs https://docs.github.com/rest/reference/packages#list-packages-for-an-organization

List packages for an organization Lists all packages in an organization readable by the user.

To use this endpoint, you must authenticate using an access token with the packages:read scope. If package_type is not container, your token must also include the repo scope.

GetOrgsorgPackagespackageTypepackageName(String, String, String)

• tags packages
• get /orgs/{org}/packages/{package_type}/{package_name}
• docs https://docs.github.com/rest/reference/packages#get-a-package-for-an-organization

Get a package for an organization Gets a specific package in an organization.

To use this endpoint, you must authenticate using an access token with the packages:read scope. If package_type is not container, your token must also include the repo scope.

DeleteOrgsorgPackagespackageTypepackageName(String, String, String)

• tags packages
• delete /orgs/{org}/packages/{package_type}/{package_name}
• docs https://docs.github.com/rest/reference/packages#delete-a-package-for-an-organization

Delete a package for an organization Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the packages:read and packages:delete scopes. In addition:

• If package_type is not container, your token must also include the repo scope.
• If package_type is container, you must also have admin permissions to the container you want to delete.

PostOrgsorgPackagespackageTypepackageNameRestore(String, String, String)

• tags packages
• post /orgs/{org}/packages/{package_type}/{package_name}/restore
• docs https://docs.github.com/rest/reference/packages#restore-a-package-for-an-organization

Restore a package for an organization Restores an entire package in an organization.

You can restore a deleted package under the following conditions:

• The package was deleted within the last 30 days.
• The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package’s namespace first.

To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the packages:read and packages:write scopes. In addition:

• If package_type is not container, your token must also include the repo scope.
• If package_type is container, you must also have admin permissions to the container that you want to restore.

GetOrgsorgPackagespackageTypepackageNameVersions(String, String, String)

• tags packages
• get /orgs/{org}/packages/{package_type}/{package_name}/versions
• docs https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-an-organization

Get all package versions for a package owned by an organization Returns all package versions for a package owned by an organization.

To use this endpoint, you must authenticate using an access token with the packages:read scope. If package_type is not container, your token must also include the repo scope.

GetOrgsorgPackagespackageTypepackageNameVersionspackageVersionId(String, String, String, String)

• tags packages
• get /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}
• docs https://docs.github.com/rest/reference/packages#get-a-package-version-for-an-organization

Get a package version for an organization Gets a specific package version in an organization.

You must authenticate using an access token with the packages:read scope. If package_type is not container, your token must also include the repo scope.

DeleteOrgsorgPackagespackageTypepackageNameVersionspackageVersionId(String, String, String, String)

• tags packages
• delete /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}
• docs https://docs.github.com/rest/reference/packages#delete-a-package-version-for-an-organization

Delete package version for an organization Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the packages:read and packages:delete scopes. In addition:

• If package_type is not container, your token must also include the repo scope.
• If package_type is container, you must also have admin permissions to the container you want to delete.

PostOrgsorgPackagespackageTypepackageNameVersionspackageVersionIdRestore(String, String, String, String)

• tags packages
• post /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore
• docs https://docs.github.com/rest/reference/packages#restore-a-package-version-for-an-organization

Restore package version for an organization Restores a specific package version in an organization.

You can restore a deleted package under the following conditions:

• The package was deleted within the last 30 days.
• The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package’s namespace first.

To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the packages:read and packages:write scopes. In addition:

• If package_type is not container, your token must also include the repo scope.
• If package_type is container, you must also have admin permissions to the container that you want to restore.

GetOrgsorgProjects(String)

• tags projects
• get /orgs/{org}/projects
• docs https://docs.github.com/rest/reference/projects#list-organization-projects

List organization projects Lists the projects in an organization. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

PostOrgsorgProjects(String)

• tags projects
• post /orgs/{org}/projects
• docs https://docs.github.com/rest/reference/projects#create-an-organization-project

Create an organization project Creates an organization project board. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

GetOrgsorgPublicMembers(String)

• tags orgs
• get /orgs/{org}/public_members
• docs https://docs.github.com/rest/reference/orgs#list-public-organization-members

List public organization members Members of an organization can choose to have their membership publicized or not.

GetOrgsorgPublicMembersusername(String, String)

• tags orgs
• get /orgs/{org}/public_members/{username}
• docs https://docs.github.com/rest/reference/orgs#check-public-organization-membership-for-a-user

Check public organization membership for a user

PutOrgsorgPublicMembersusername(String, String)

• tags orgs
• put /orgs/{org}/public_members/{username}
• docs https://docs.github.com/rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user

Set public organization membership for the authenticated user The user can publicize their own membership. (A user cannot publicize the membership for another user.)

Note that you’ll need to set Content-Length to zero when calling out to this endpoint. For more information, see “HTTP verbs.”

DeleteOrgsorgPublicMembersusername(String, String)

• tags orgs
• delete /orgs/{org}/public_members/{username}
• docs https://docs.github.com/rest/reference/orgs#remove-public-organization-membership-for-the-authenticated-user

Remove public organization membership for the authenticated user

GetOrgsorgRepos(String)

• tags repos
• get /orgs/{org}/repos
• docs https://docs.github.com/rest/reference/repos#list-organization-repositories

List organization repositories Lists repositories for the specified organization.

PostOrgsorgRepos(String)

• tags repos
• post /orgs/{org}/repos
• docs https://docs.github.com/rest/reference/repos#create-an-organization-repository

Create an organization repository Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

OAuth scope requirements

When using OAuth, authorizations must include:

• public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
• repo scope to create a private repository

GetOrgsorgSecretScanningAlerts(String)

• tags secret-scanning
• get /orgs/{org}/secret-scanning/alerts
• docs https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-an-organization

List secret scanning alerts for an organization Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the repo scope or security_events scope.

GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.

GetOrgsorgSettingsBillingActions(String)

• tags billing
• get /orgs/{org}/settings/billing/actions
• docs https://docs.github.com/rest/reference/billing#get-github-actions-billing-for-an-organization

Get GitHub Actions billing for an organization Gets the summary of the free and paid GitHub Actions minutes used.

Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see “Managing billing for GitHub Actions”.

Access tokens must have the repo or admin:org scope.

GetOrgsorgSettingsBillingAdvancedSecurity(String)

• tags billing
• get /orgs/{org}/settings/billing/advanced-security
• docs https://docs.github.com/rest/reference/billing#get-github-advanced-security-active-committers-for-an-organization

Get GitHub Advanced Security active committers for an organization Gets the GitHub Advanced Security active committers for an organization per repository. Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository. If this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.

GetOrgsorgSettingsBillingPackages(String)

• tags billing
• get /orgs/{org}/settings/billing/packages
• docs https://docs.github.com/rest/reference/billing#get-github-packages-billing-for-an-organization

Get GitHub Packages billing for an organization Gets the free and paid storage used for GitHub Packages in gigabytes.

Paid minutes only apply to packages stored for private repositories. For more information, see “Managing billing for GitHub Packages.”

Access tokens must have the repo or admin:org scope.

GetOrgsorgSettingsBillingSharedStorage(String)

• tags billing
• get /orgs/{org}/settings/billing/shared-storage
• docs https://docs.github.com/rest/reference/billing#get-shared-storage-billing-for-an-organization

Get shared storage billing for an organization Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages.

Paid minutes only apply to packages stored for private repositories. For more information, see “Managing billing for GitHub Packages.”

Access tokens must have the repo or admin:org scope.

GetOrgsorgTeamSyncGroups(String)

• tags teams
• get /orgs/{org}/team-sync/groups
• docs https://docs.github.com/rest/reference/teams#list-idp-groups-for-an-organization

List IdP groups for an organization Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.

List IdP groups available in an organization. You can limit your page results using the per_page parameter. GitHub generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see “Offset and Cursor Pagination explained.”

GetOrgsorgTeams(String)

• tags teams
• get /orgs/{org}/teams
• docs https://docs.github.com/rest/reference/teams#list-teams

List teams Lists all teams in an organization that are visible to the authenticated user.

PostOrgsorgTeams(String)

• tags teams
• post /orgs/{org}/teams
• docs https://docs.github.com/rest/reference/teams#create-a-team

Create a team To create a team, the authenticated user must be a member or owner of {org}. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see “Setting team creation permissions.”

When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers. For more information, see “About teams”.

GetOrgsorgTeamsteamSlug(String, String)

• tags teams
• get /orgs/{org}/teams/{team_slug}
• docs https://docs.github.com/rest/reference/teams#get-a-team-by-name

Get a team by name Gets a team using the team’s slug. GitHub generates the slug from the team name.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.

PatchOrgsorgTeamsteamSlug(String, String)

• tags teams
• patch /orgs/{org}/teams/{team_slug}
• docs https://docs.github.com/rest/reference/teams#update-a-team

Update a team To edit a team, the authenticated user must either be an organization owner or a team maintainer.

Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.

DeleteOrgsorgTeamsteamSlug(String, String)

• tags teams
• delete /orgs/{org}/teams/{team_slug}
• docs https://docs.github.com/rest/reference/teams#delete-a-team

Delete a team To delete a team, the authenticated user must be an organization owner or team maintainer.

If you are an organization owner, deleting a parent team will delete all of its child teams as well.

Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.

GetOrgsorgTeamsteamSlugDiscussions(String, String)

• tags teams
• get /orgs/{org}/teams/{team_slug}/discussions
• docs https://docs.github.com/rest/reference/teams#list-discussions

List discussions List all discussions on a team’s page. OAuth access tokens require the read:discussion scope.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.

PostOrgsorgTeamsteamSlugDiscussions(String, String)

• tags teams
• post /orgs/{org}/teams/{team_slug}/discussions
• docs https://docs.github.com/rest/reference/teams#create-a-discussion

Create a discussion Creates a new discussion post on a team’s page. OAuth access tokens require the write:discussion scope.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.

GetOrgsorgTeamsteamSlugDiscussionsdiscussionNumber(String, String, String)

• tags teams
• get /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}
• docs https://docs.github.com/rest/reference/teams#get-a-discussion

Get a discussion Get a specific discussion on a team’s page. OAuth access tokens require the read:discussion scope.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.

PatchOrgsorgTeamsteamSlugDiscussionsdiscussionNumber(String, String, String)

• tags teams
• patch /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}
• docs https://docs.github.com/rest/reference/teams#update-a-discussion

Update a discussion Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.

Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.

DeleteOrgsorgTeamsteamSlugDiscussionsdiscussionNumber(String, String, String)

• tags teams
• delete /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}
• docs https://docs.github.com/rest/reference/teams#delete-a-discussion

Delete a discussion Delete a discussion from a team’s page. OAuth access tokens require the write:discussion scope.

Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.

GetOrgsorgTeamsteamSlugDiscussionsdiscussionNumberComments(String, String, String)

• tags teams
• get /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments
• docs https://docs.github.com/rest/reference/teams#list-discussion-comments

List discussion comments List all comments on a team discussion. OAuth access tokens require the read:discussion scope.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.

PostOrgsorgTeamsteamSlugDiscussionsdiscussionNumberComments(String, String, String)

• tags teams
• post /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments
• docs https://docs.github.com/rest/reference/teams#create-a-discussion-comment

Create a discussion comment Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.

GetOrgsorgTeamsteamSlugDiscussionsdiscussionNumberCommentscommentNumber(String, String, String, String)

• tags teams
• get /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}
• docs https://docs.github.com/rest/reference/teams#get-a-discussion-comment

Get a discussion comment Get a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.

PatchOrgsorgTeamsteamSlugDiscussionsdiscussionNumberCommentscommentNumber(String, String, String, String)

• tags teams
• patch /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}
• docs https://docs.github.com/rest/reference/teams#update-a-discussion-comment

Update a discussion comment Edits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.

Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.

DeleteOrgsorgTeamsteamSlugDiscussionsdiscussionNumberCommentscommentNumber(String, String, String, String)

• tags teams
• delete /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}
• docs https://docs.github.com/rest/reference/teams#delete-a-discussion-comment

Delete a discussion comment Deletes a comment on a team discussion. OAuth access tokens require the write:discussion scope.

Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.

GetOrgsorgTeamsteamSlugDiscussionsdiscussionNumberCommentscommentNumberReactions(String, String, String, String)

• tags reactions
• get /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions
• docs https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion-comment

List reactions for a team discussion comment List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.

PostOrgsorgTeamsteamSlugDiscussionsdiscussionNumberCommentscommentNumberReactions(String, String, String, String)

• tags reactions
• post /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions
• docs https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion-comment

Create reaction for a team discussion comment Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.

Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.

DeleteOrgsorgTeamsteamSlugDiscussionsdiscussionNumberCommentscommentNumberReactionsreactionId(String, String, String, String, String)

• tags reactions
• delete /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}
• docs https://docs.github.com/rest/reference/reactions#delete-team-discussion-comment-reaction

Delete team discussion comment reaction Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.

Delete a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope.

GetOrgsorgTeamsteamSlugDiscussionsdiscussionNumberReactions(String, String, String)

• tags reactions
• get /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions
• docs https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion

List reactions for a team discussion List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.

PostOrgsorgTeamsteamSlugDiscussionsdiscussionNumberReactions(String, String, String)

• tags reactions
• post /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions
• docs https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion

Create reaction for a team discussion Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.

Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.

DeleteOrgsorgTeamsteamSlugDiscussionsdiscussionNumberReactionsreactionId(String, String, String, String)

• tags reactions
• delete /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}
• docs https://docs.github.com/rest/reference/reactions#delete-team-discussion-reaction

Delete team discussion reaction Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.

Delete a reaction to a team discussion. OAuth access tokens require the write:discussion scope.

PatchOrgsorgTeamsteamSlugExternalGroups(String, String)

• tags teams
• patch /orgs/{org}/teams/{team_slug}/external-groups
• docs https://docs.github.com/rest/reference/teams#link-external-idp-group-team-connection

Update the connection between an external group and a team Creates a connection between a team and an external group. Only one external group can be linked to a team.

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see “GitHub’s products” in the GitHub Help documentation.

DeleteOrgsorgTeamsteamSlugExternalGroups(String, String)

• tags teams
• delete /orgs/{org}/teams/{team_slug}/external-groups
• docs https://docs.github.com/rest/reference/teams#unlink-external-idp-group-team-connection

Remove the connection between an external group and a team Deletes a connection between a team and an external group.

You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.

GetOrgsorgTeamsteamSlugInvitations(String, String)

• tags teams
• get /orgs/{org}/teams/{team_slug}/invitations
• docs https://docs.github.com/rest/reference/teams#list-pending-team-invitations

List pending team invitations The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/invitations.

GetOrgsorgTeamsteamSlugMembers(String, String)

• tags teams
• get /orgs/{org}/teams/{team_slug}/members
• docs https://docs.github.com/rest/reference/teams#list-team-members

List team members Team members will include the members of child teams.

To list members in a team, the team must be visible to the authenticated user.

GetOrgsorgTeamsteamSlugMembershipsusername(String, String, String)

• tags teams
• get /orgs/{org}/teams/{team_slug}/memberships/{username}
• docs https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user

Get team membership for a user Team members will include the members of child teams.

To get a user’s membership with a team, the team must be visible to the authenticated user.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.

Note: The response contains the state of the membership and the member’s role.

The role for organization owners is set to maintainer. For more information about maintainer roles, see see Create a team.

PutOrgsorgTeamsteamSlugMembershipsusername(String, String, String)

• tags teams
• put /orgs/{org}/teams/{team_slug}/memberships/{username}
• docs https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user

Add or update team membership for a user Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.

Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.

Note: When you have team synchronization set up for a team with your organization’s identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team’s membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see “Synchronizing teams between your identity provider and GitHub.”

An organization owner can add someone who is not part of the team’s organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the “pending” state until the person accepts the invitation, at which point the membership will transition to the “active” state and the user will be added as a member of the team.

If the user is already a member of the team, this endpoint will update the role of the team member’s role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.

Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.

DeleteOrgsorgTeamsteamSlugMembershipsusername(String, String, String)

• tags teams
• delete /orgs/{org}/teams/{team_slug}/memberships/{username}
• docs https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user

Remove team membership for a user Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.

To remove a membership between a user and a team, the authenticated user must have ‘admin’ permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

Note: When you have team synchronization set up for a team with your organization’s identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team’s membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see “Synchronizing teams between your identity provider and GitHub.”

Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.

GetOrgsorgTeamsteamSlugProjects(String, String)

• tags teams
• get /orgs/{org}/teams/{team_slug}/projects
• docs https://docs.github.com/rest/reference/teams#list-team-projects

List team projects Lists the organization projects for a team.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects.

GetOrgsorgTeamsteamSlugProjectsprojectId(String, String, String)

• tags teams
• get /orgs/{org}/teams/{team_slug}/projects/{project_id}
• docs https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-project

Check team permissions for a project Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects/{project_id}.

PutOrgsorgTeamsteamSlugProjectsprojectId(String, String, String)

• tags teams
• put /orgs/{org}/teams/{team_slug}/projects/{project_id}
• docs https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions

Add or update team project permissions Adds an organization project to a team. To add a project to a team or update the team’s permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.

Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}.

DeleteOrgsorgTeamsteamSlugProjectsprojectId(String, String, String)

• tags teams
• delete /orgs/{org}/teams/{team_slug}/projects/{project_id}
• docs https://docs.github.com/rest/reference/teams#remove-a-project-from-a-team

Remove a project from a team Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. This endpoint removes the project from the team, but does not delete the project.

Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}.

GetOrgsorgTeamsteamSlugRepos(String, String)

• tags teams
• get /orgs/{org}/teams/{team_slug}/repos
• docs https://docs.github.com/rest/reference/teams#list-team-repositories

List team repositories Lists a team’s repositories visible to the authenticated user.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.

GetOrgsorgTeamsteamSlugReposownerrepo(String, String, String, String)

• tags teams
• get /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}
• docs https://docs.github.com/rest/reference/teams/#check-team-permissions-for-a-repository

Check team permissions for a repository Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.

If a team doesn’t have permission for the repository, you will receive a 404 Not Found response status.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.

PutOrgsorgTeamsteamSlugReposownerrepo(String, String, String, String)

• tags teams
• put /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}
• docs https://docs.github.com/rest/reference/teams/#add-or-update-team-repository-permissions

Add or update team repository permissions To add a repository to a team or update the team’s permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you’ll need to set Content-Length to zero when calling out to this endpoint. For more information, see “HTTP verbs.”

Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.

For more information about the permission levels, see “Repository permission levels for an organization”.

DeleteOrgsorgTeamsteamSlugReposownerrepo(String, String, String, String)

• tags teams
• delete /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}
• docs https://docs.github.com/rest/reference/teams/#remove-a-repository-from-a-team

Remove a repository from a team If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.

Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.

GetOrgsorgTeamsteamSlugTeamSyncGroupMappings(String, String)

• tags teams
• get /orgs/{org}/teams/{team_slug}/team-sync/group-mappings
• docs https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team

List IdP groups for a team Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.

List IdP groups connected to a team on GitHub.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings.

PatchOrgsorgTeamsteamSlugTeamSyncGroupMappings(String, String)

• tags teams
• patch /orgs/{org}/teams/{team_slug}/team-sync/group-mappings
• docs https://docs.github.com/rest/reference/teams#create-or-update-idp-group-connections

Create or update IdP group connections Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.

Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty groups array will remove all connections for a team.

Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings.

GetOrgsorgTeamsteamSlugTeams(String, String)

• tags teams
• get /orgs/{org}/teams/{team_slug}/teams
• docs https://docs.github.com/rest/reference/teams#list-child-teams

List child teams Lists the child teams of the team specified by {team_slug}.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.

GetProjectsColumnsCardscardId(String)

• tags projects
• get /projects/columns/cards/{card_id}
• docs https://docs.github.com/rest/reference/projects#get-a-project-card

Get a project card

PatchProjectsColumnsCardscardId(String)

• tags projects
• patch /projects/columns/cards/{card_id}
• docs https://docs.github.com/rest/reference/projects#update-a-project-card

Update an existing project card

DeleteProjectsColumnsCardscardId(String)

• tags projects
• delete /projects/columns/cards/{card_id}
• docs https://docs.github.com/rest/reference/projects#delete-a-project-card

Delete a project card

PostProjectsColumnsCardscardIdMoves(String)

• tags projects
• post /projects/columns/cards/{card_id}/moves
• docs https://docs.github.com/rest/reference/projects#move-a-project-card

Move a project card

GetProjectsColumnscolumnId(String)

• tags projects
• get /projects/columns/{column_id}
• docs https://docs.github.com/rest/reference/projects#get-a-project-column

Get a project column

PatchProjectsColumnscolumnId(String)

• tags projects
• patch /projects/columns/{column_id}
• docs https://docs.github.com/rest/reference/projects#update-a-project-column

Update an existing project column

DeleteProjectsColumnscolumnId(String)

• tags projects
• delete /projects/columns/{column_id}
• docs https://docs.github.com/rest/reference/projects#delete-a-project-column

Delete a project column

GetProjectsColumnscolumnIdCards(String)

• tags projects
• get /projects/columns/{column_id}/cards
• docs https://docs.github.com/rest/reference/projects#list-project-cards

List project cards

PostProjectsColumnscolumnIdCards(String)

• tags projects
• post /projects/columns/{column_id}/cards
• docs https://docs.github.com/rest/reference/projects#create-a-project-card

Create a project card

PostProjectsColumnscolumnIdMoves(String)

• tags projects
• post /projects/columns/{column_id}/moves
• docs https://docs.github.com/rest/reference/projects#move-a-project-column

Move a project column

GetProjectsprojectId(String)

• tags projects
• get /projects/{project_id}
• docs https://docs.github.com/rest/reference/projects#get-a-project

Get a project Gets a project by its id. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

PatchProjectsprojectId(String)

• tags projects
• patch /projects/{project_id}
• docs https://docs.github.com/rest/reference/projects#update-a-project

Update a project Updates a project board’s information. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

DeleteProjectsprojectId(String)

• tags projects
• delete /projects/{project_id}
• docs https://docs.github.com/rest/reference/projects#delete-a-project

Delete a project Deletes a project board. Returns a 404 Not Found status if projects are disabled.

GetProjectsprojectIdCollaborators(String)

• tags projects
• get /projects/{project_id}/collaborators
• docs https://docs.github.com/rest/reference/projects#list-project-collaborators

List project collaborators Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project admin to list collaborators.

PutProjectsprojectIdCollaboratorsusername(String, String)

• tags projects
• put /projects/{project_id}/collaborators/{username}
• docs https://docs.github.com/rest/reference/projects#add-project-collaborator

Add project collaborator Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project admin to add a collaborator.

DeleteProjectsprojectIdCollaboratorsusername(String, String)

• tags projects
• delete /projects/{project_id}/collaborators/{username}
• docs https://docs.github.com/rest/reference/projects#remove-project-collaborator

Remove user as a collaborator Removes a collaborator from an organization project. You must be an organization owner or a project admin to remove a collaborator.

GetProjectsprojectIdCollaboratorsusernamePermission(String, String)

• tags projects
• get /projects/{project_id}/collaborators/{username}/permission
• docs https://docs.github.com/rest/reference/projects#get-project-permission-for-a-user

Get project permission for a user Returns the collaborator’s permission level for an organization project. Possible values for the permission key: admin, write, read, none. You must be an organization owner or a project admin to review a user’s permission level.

GetProjectsprojectIdColumns(String)

• tags projects
• get /projects/{project_id}/columns
• docs https://docs.github.com/rest/reference/projects#list-project-columns

List project columns

PostProjectsprojectIdColumns(String)

• tags projects
• post /projects/{project_id}/columns
• docs https://docs.github.com/rest/reference/projects#create-a-project-column

Create a project column

GetRateLimit()

• tags rate-limit
• get /rate_limit
• docs https://docs.github.com/rest/reference/rate-limit#get-rate-limit-status-for-the-authenticated-user

Get rate limit status for the authenticated user Note: Accessing this endpoint does not count against your REST API rate limit.

Note: The rate object is deprecated. If you’re writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.

DeleteReactionsreactionId(String)

• tags reactions
• delete /reactions/{reaction_id}
• docs https://docs.github.com/rest/reference/reactions/#delete-a-reaction-legacy

Delete a reaction (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this blog post.

OAuth access tokens require the write:discussion scope, when deleting a team discussion or team discussion comment.

GetReposownerrepo(String, String)

• tags repos
• get /repos/{owner}/{repo}
• docs https://docs.github.com/rest/reference/repos#get-a-repository

Get a repository The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.

PatchReposownerrepo(String, String)

• tags repos
• patch /repos/{owner}/{repo}
• docs https://docs.github.com/rest/reference/repos/#update-a-repository

Update a repository Note: To edit a repository’s topics, use the Replace all repository topics endpoint.

DeleteReposownerrepo(String, String)

• tags repos
• delete /repos/{owner}/{repo}
• docs https://docs.github.com/rest/reference/repos#delete-a-repository

Delete a repository Deleting a repository requires admin access. If OAuth is used, the delete_repo scope is required.

If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, you will get a 403 Forbidden response.

GetReposownerrepoActionsArtifacts(String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/artifacts
• docs https://docs.github.com/rest/reference/actions#list-artifacts-for-a-repository

List artifacts for a repository Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

GetReposownerrepoActionsArtifactsartifactId(String, String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/artifacts/{artifact_id}
• docs https://docs.github.com/rest/reference/actions#get-an-artifact

Get an artifact Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

DeleteReposownerrepoActionsArtifactsartifactId(String, String, String)

• tags actions
• delete /repos/{owner}/{repo}/actions/artifacts/{artifact_id}
• docs https://docs.github.com/rest/reference/actions#delete-an-artifact

Delete an artifact Deletes an artifact for a workflow run. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.

GetReposownerrepoActionsArtifactsartifactIdarchiveFormat(String, String, String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}
• docs https://docs.github.com/rest/reference/actions#download-an-artifact

Download an artifact Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for Location: in the response header to find the URL for the download. The :archive_format must be zip. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

GetReposownerrepoActionsJobsjobId(String, String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/jobs/{job_id}
• docs https://docs.github.com/rest/reference/actions#get-a-job-for-a-workflow-run

Get a job for a workflow run Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

GetReposownerrepoActionsJobsjobIdLogs(String, String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/jobs/{job_id}/logs
• docs https://docs.github.com/rest/reference/actions#download-job-logs-for-a-workflow-run

Download job logs for a workflow run Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look for Location: in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

GetReposownerrepoActionsPermissions(String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/permissions
• docs https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-a-repository

Get GitHub Actions permissions for a repository Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.

PutReposownerrepoActionsPermissions(String, String)

• tags actions
• put /repos/{owner}/{repo}/actions/permissions
• docs https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-a-repository

Set GitHub Actions permissions for a repository Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.

If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions to selected actions, then you cannot override them for the repository.

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.

GetReposownerrepoActionsPermissionsSelectedActions(String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/permissions/selected-actions
• docs https://docs.github.com/rest/reference/actions#get-allowed-actions-for-a-repository

Get allowed actions for a repository Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for allowed_actions must be configured to selected. For more information, see “Set GitHub Actions permissions for a repository.”

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.

PutReposownerrepoActionsPermissionsSelectedActions(String, String)

• tags actions
• put /repos/{owner}/{repo}/actions/permissions/selected-actions
• docs https://docs.github.com/rest/reference/actions#set-allowed-actions-for-a-repository

Set allowed actions for a repository Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions must be configured to selected. For more information, see “Set GitHub Actions permissions for a repository.”

If the repository belongs to an organization or enterprise that has selected actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.

To use the patterns_allowed setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories.

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.

GetReposownerrepoActionsRunners(String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/runners
• docs https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-a-repository

List self-hosted runners for a repository Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the repo scope to use this endpoint.

GetReposownerrepoActionsRunnersDownloads(String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/runners/downloads
• docs https://docs.github.com/rest/reference/actions#list-runner-applications-for-a-repository

List runner applications for a repository Lists binaries for the runner application that you can download and run.

You must authenticate using an access token with the repo scope to use this endpoint.

PostReposownerrepoActionsRunnersRegistrationToken(String, String)

• tags actions
• post /repos/{owner}/{repo}/actions/runners/registration-token
• docs https://docs.github.com/rest/reference/actions#create-a-registration-token-for-a-repository

Create a registration token for a repository Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate using an access token with the repo scope to use this endpoint.

Example using registration token

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN

PostReposownerrepoActionsRunnersRemoveToken(String, String)

• tags actions
• post /repos/{owner}/{repo}/actions/runners/remove-token
• docs https://docs.github.com/rest/reference/actions#create-a-remove-token-for-a-repository

Create a remove token for a repository Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. You must authenticate using an access token with the repo scope to use this endpoint.

Example using remove token

To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.

./config.sh remove --token TOKEN

GetReposownerrepoActionsRunnersrunnerId(String, String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/runners/{runner_id}
• docs https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-for-a-repository

Get a self-hosted runner for a repository Gets a specific self-hosted runner configured in a repository.

You must authenticate using an access token with the repo scope to use this endpoint.

DeleteReposownerrepoActionsRunnersrunnerId(String, String, String)

• tags actions
• delete /repos/{owner}/{repo}/actions/runners/{runner_id}
• docs https://docs.github.com/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository

Delete a self-hosted runner from a repository Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

You must authenticate using an access token with the repo scope to use this endpoint.

GetReposownerrepoActionsRunnersrunnerIdLabels(String, String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/runners/{runner_id}/labels
• docs https://docs.github.com/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-a-repository

List labels for a self-hosted runner for a repository Lists all labels for a self-hosted runner configured in a repository.

You must authenticate using an access token with the repo scope to use this endpoint.

PostReposownerrepoActionsRunnersrunnerIdLabels(String, String, String)

• tags actions
• post /repos/{owner}/{repo}/actions/runners/{runner_id}/labels
• docs https://docs.github.com/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-a-repository

Add custom labels to a self-hosted runner for a repository Add custom labels to a self-hosted runner configured in a repository.

You must authenticate using an access token with the repo scope to use this endpoint.

PutReposownerrepoActionsRunnersrunnerIdLabels(String, String, String)

• tags actions
• put /repos/{owner}/{repo}/actions/runners/{runner_id}/labels
• docs https://docs.github.com/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-a-repository

Set custom labels for a self-hosted runner for a repository Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in a repository.

You must authenticate using an access token with the repo scope to use this endpoint.

DeleteReposownerrepoActionsRunnersrunnerIdLabels(String, String, String)

• tags actions
• delete /repos/{owner}/{repo}/actions/runners/{runner_id}/labels
• docs https://docs.github.com/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository

Remove all custom labels from a self-hosted runner for a repository Remove all custom labels from a self-hosted runner configured in a repository. Returns the remaining read-only labels from the runner.

You must authenticate using an access token with the repo scope to use this endpoint.

DeleteReposownerrepoActionsRunnersrunnerIdLabelsname(String, String, String, String)

• tags actions
• delete /repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}
• docs https://docs.github.com/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository

Remove a custom label from a self-hosted runner for a repository Remove a custom label from a self-hosted runner configured in a repository. Returns the remaining labels from the runner.

This endpoint returns a 404 Not Found status if the custom label is not present on the runner.

You must authenticate using an access token with the repo scope to use this endpoint.

GetReposownerrepoActionsRuns(String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/runs
• docs https://docs.github.com/rest/reference/actions#list-workflow-runs-for-a-repository

List workflow runs for a repository Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

GetReposownerrepoActionsRunsrunId(String, String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/runs/{run_id}
• docs https://docs.github.com/rest/reference/actions#get-a-workflow-run

Get a workflow run Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

DeleteReposownerrepoActionsRunsrunId(String, String, String)

• tags actions
• delete /repos/{owner}/{repo}/actions/runs/{run_id}
• docs https://docs.github.com/rest/reference/actions#delete-a-workflow-run

Delete a workflow run Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:write permission to use this endpoint.

GetReposownerrepoActionsRunsrunIdApprovals(String, String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/runs/{run_id}/approvals
• docs https://docs.github.com/rest/reference/actions#get-the-review-history-for-a-workflow-run

Get the review history for a workflow run Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

PostReposownerrepoActionsRunsrunIdApprove(String, String, String)

• tags actions
• post /repos/{owner}/{repo}/actions/runs/{run_id}/approve
• docs https://docs.github.com/rest/reference/actions#approve-a-workflow-run-for-a-fork-pull-request

Approve a workflow run for a fork pull request Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see “Approving workflow runs from public forks.“

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.

GetReposownerrepoActionsRunsrunIdArtifacts(String, String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts
• docs https://docs.github.com/rest/reference/actions#list-workflow-run-artifacts

List workflow run artifacts Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

GetReposownerrepoActionsRunsrunIdAttemptsattemptNumber(String, String, String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}
• docs https://docs.github.com/rest/reference/actions#get-a-workflow-run-attempt

Get a workflow run attempt Gets a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

GetReposownerrepoActionsRunsrunIdAttemptsattemptNumberJobs(String, String, String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs
• docs https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run-attempt

List jobs for a workflow run attempt Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

GetReposownerrepoActionsRunsrunIdAttemptsattemptNumberLogs(String, String, String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs
• docs https://docs.github.com/rest/reference/actions#download-workflow-run-attempt-logs

Download workflow run attempt logs Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after 1 minute. Look for Location: in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

PostReposownerrepoActionsRunsrunIdCancel(String, String, String)

• tags actions
• post /repos/{owner}/{repo}/actions/runs/{run_id}/cancel
• docs https://docs.github.com/rest/reference/actions#cancel-a-workflow-run

Cancel a workflow run Cancels a workflow run using its id. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.

GetReposownerrepoActionsRunsrunIdJobs(String, String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/runs/{run_id}/jobs
• docs https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run

List jobs for a workflow run Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

GetReposownerrepoActionsRunsrunIdLogs(String, String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/runs/{run_id}/logs
• docs https://docs.github.com/rest/reference/actions#download-workflow-run-logs

Download workflow run logs Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for Location: in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

DeleteReposownerrepoActionsRunsrunIdLogs(String, String, String)

• tags actions
• delete /repos/{owner}/{repo}/actions/runs/{run_id}/logs
• docs https://docs.github.com/rest/reference/actions#delete-workflow-run-logs

Delete workflow run logs Deletes all logs for a workflow run. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.

GetReposownerrepoActionsRunsrunIdPendingDeployments(String, String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments
• docs https://docs.github.com/rest/reference/actions#get-pending-deployments-for-a-workflow-run

Get pending deployments for a workflow run Get all deployment environments for a workflow run that are waiting for protection rules to pass.

Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

PostReposownerrepoActionsRunsrunIdPendingDeployments(String, String, String)

• tags actions
• post /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments
• docs https://docs.github.com/rest/reference/actions#review-pending-deployments-for-a-workflow-run

Review pending deployments for a workflow run Approve or reject pending deployments that are waiting on approval by a required reviewer.

Anyone with read access to the repository contents and deployments can use this endpoint.

PostReposownerrepoActionsRunsrunIdRerun(String, String, String)

• tags actions
• post /repos/{owner}/{repo}/actions/runs/{run_id}/rerun
• docs https://docs.github.com/rest/reference/actions#re-run-a-workflow

Re-run a workflow Re-runs your workflow run using its id. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.

GetReposownerrepoActionsRunsrunIdTiming(String, String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/runs/{run_id}/timing
• docs https://docs.github.com/rest/reference/actions#get-workflow-run-usage

Get workflow run usage Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see “Managing billing for GitHub Actions”.

Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

GetReposownerrepoActionsSecrets(String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/secrets
• docs https://docs.github.com/rest/reference/actions#list-repository-secrets

List repository secrets Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.

GetReposownerrepoActionsSecretsPublicKey(String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/secrets/public-key
• docs https://docs.github.com/rest/reference/actions#get-a-repository-public-key

Get a repository public key Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint.

GetReposownerrepoActionsSecretssecretName(String, String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/secrets/{secret_name}
• docs https://docs.github.com/rest/reference/actions#get-a-repository-secret

Get a repository secret Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.

PutReposownerrepoActionsSecretssecretName(String, String, String)

• tags actions
• put /repos/{owner}/{repo}/actions/secrets/{secret_name}
• docs https://docs.github.com/rest/reference/actions#create-or-update-a-repository-secret

Create or update a repository secret Creates or updates a repository secret with an encrypted value. Encrypt your secret using LibSodium. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.

Example encrypting a secret using Node.js

Encrypt your secret using the tweetsodium library.

const sodium = require('tweetsodium');

const key = "base64-encoded-public-key";
const value = "plain-text-secret";

// Convert the message and key to Uint8Array's (Buffer implements that interface)
const messageBytes = Buffer.from(value);
const keyBytes = Buffer.from(key, 'base64');

// Encrypt using LibSodium.
const encryptedBytes = sodium.seal(messageBytes, keyBytes);

// Base64 the encrypted secret
const encrypted = Buffer.from(encryptedBytes).toString('base64');

console.log(encrypted);

Example encrypting a secret using Python

Encrypt your secret using pynacl with Python 3.

from base64 import b64encode
from nacl import encoding, public

def encrypt(public_key: str, secret_value: str) -> str:
  """Encrypt a Unicode string using the public key."""
  public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
  sealed_box = public.SealedBox(public_key)
  encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
  return b64encode(encrypted).decode("utf-8")

Example encrypting a secret using C#

Encrypt your secret using the Sodium.Core package.

var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");

var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);

Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));

Example encrypting a secret using Ruby

Encrypt your secret using the rbnacl gem.

require "rbnacl"
require "base64"

key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
public_key = RbNaCl::PublicKey.new(key)

box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
encrypted_secret = box.encrypt("my_secret")

# Print the base64 encoded secret
puts Base64.strict_encode64(encrypted_secret)

DeleteReposownerrepoActionsSecretssecretName(String, String, String)

• tags actions
• delete /repos/{owner}/{repo}/actions/secrets/{secret_name}
• docs https://docs.github.com/rest/reference/actions#delete-a-repository-secret

Delete a repository secret Deletes a secret in a repository using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.

GetReposownerrepoActionsWorkflows(String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/workflows
• docs https://docs.github.com/rest/reference/actions#list-repository-workflows

List repository workflows Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

GetReposownerrepoActionsWorkflowsworkflowId(String, String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/workflows/{workflow_id}
• docs https://docs.github.com/rest/reference/actions#get-a-workflow

Get a workflow Gets a specific workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

PutReposownerrepoActionsWorkflowsworkflowIdDisable(String, String, String)

• tags actions
• put /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable
• docs https://docs.github.com/rest/reference/actions#disable-a-workflow

Disable a workflow Disables a workflow and sets the state of the workflow to disabled_manually. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.

PostReposownerrepoActionsWorkflowsworkflowIdDispatches(String, String, String)

• tags actions
• post /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches
• docs https://docs.github.com/rest/reference/actions#create-a-workflow-dispatch-event

Create a workflow dispatch event You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

You must configure your GitHub Actions workflow to run when the workflow_dispatch webhook event occurs. The inputs are configured in the workflow file. For more information about how to configure the workflow_dispatch event in the workflow file, see “Events that trigger workflows.”

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint. For more information, see “Creating a personal access token for the command line.”

PutReposownerrepoActionsWorkflowsworkflowIdEnable(String, String, String)

• tags actions
• put /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable
• docs https://docs.github.com/rest/reference/actions#enable-a-workflow

Enable a workflow Enables a workflow and sets the state of the workflow to active. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.

GetReposownerrepoActionsWorkflowsworkflowIdRuns(String, String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs
• docs https://docs.github.com/rest/reference/actions#list-workflow-runs

List workflow runs List all workflow runs for a workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope.

GetReposownerrepoActionsWorkflowsworkflowIdTiming(String, String, String)

• tags actions
• get /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing
• docs https://docs.github.com/rest/reference/actions#get-workflow-usage

Get workflow usage Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see “Managing billing for GitHub Actions”.

You can replace workflow_id with the workflow file name. For example, you could use main.yaml. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

GetReposownerrepoAssignees(String, String)

• tags issues
• get /repos/{owner}/{repo}/assignees
• docs https://docs.github.com/rest/reference/issues#list-assignees

List assignees Lists the available assignees for issues in a repository.

GetReposownerrepoAssigneesassignee(String, String, String)

• tags issues
• get /repos/{owner}/{repo}/assignees/{assignee}
• docs https://docs.github.com/rest/reference/issues#check-if-a-user-can-be-assigned

Check if a user can be assigned Checks if a user has permission to be assigned to an issue in this repository.

If the assignee can be assigned to issues in the repository, a 204 header with no content is returned.

Otherwise a 404 status code is returned.

GetReposownerrepoAutolinks(String, String)

• tags repos
• get /repos/{owner}/{repo}/autolinks
• docs https://docs.github.com/v3/repos#list-autolinks

List all autolinks of a repository This returns a list of autolinks configured for the given repository.

Information about autolinks are only available to repository administrators.

PostReposownerrepoAutolinks(String, String)

• tags repos
• post /repos/{owner}/{repo}/autolinks
• docs https://docs.github.com/v3/repos#create-an-autolink

Create an autolink reference for a repository Users with admin access to the repository can create an autolink.

GetReposownerrepoAutolinksautolinkId(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/autolinks/{autolink_id}
• docs https://docs.github.com/v3/repos#get-autolink

Get an autolink reference of a repository This returns a single autolink reference by ID that was configured for the given repository.

Information about autolinks are only available to repository administrators.

DeleteReposownerrepoAutolinksautolinkId(String, String, String)

• tags repos
• delete /repos/{owner}/{repo}/autolinks/{autolink_id}
• docs https://docs.github.com/v3/repos#delete-autolink

Delete an autolink reference from a repository This deletes a single autolink reference by ID that was configured for the given repository.

Information about autolinks are only available to repository administrators.

PutReposownerrepoAutomatedSecurityFixes(String, String)

• tags repos
• put /repos/{owner}/{repo}/automated-security-fixes
• docs https://docs.github.com/rest/reference/repos#enable-automated-security-fixes

Enable automated security fixes Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see “Configuring automated security fixes”.

DeleteReposownerrepoAutomatedSecurityFixes(String, String)

• tags repos
• delete /repos/{owner}/{repo}/automated-security-fixes
• docs https://docs.github.com/rest/reference/repos#disable-automated-security-fixes

Disable automated security fixes Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see “Configuring automated security fixes”.

GetReposownerrepoBranches(String, String)

• tags repos
• get /repos/{owner}/{repo}/branches
• docs https://docs.github.com/rest/reference/repos#list-branches

List branches

GetReposownerrepoBranchesbranch(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/branches/{branch}
• docs https://docs.github.com/rest/reference/repos#get-a-branch

Get a branch

GetReposownerrepoBranchesbranchProtection(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/branches/{branch}/protection
• docs https://docs.github.com/rest/reference/repos#get-branch-protection

Get branch protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

PutReposownerrepoBranchesbranchProtection(String, String, String)

• tags repos
• put /repos/{owner}/{repo}/branches/{branch}/protection
• docs https://docs.github.com/rest/reference/repos#update-branch-protection

Update branch protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

Protecting a branch requires admin or owner permissions to the repository.

Note: Passing new arrays of users and teams replaces their previous values.

Note: The list of users, apps, and teams in total is limited to 100 items.

DeleteReposownerrepoBranchesbranchProtection(String, String, String)

• tags repos
• delete /repos/{owner}/{repo}/branches/{branch}/protection
• docs https://docs.github.com/rest/reference/repos#delete-branch-protection

Delete branch protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

GetReposownerrepoBranchesbranchProtectionEnforceAdmins(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins
• docs https://docs.github.com/rest/reference/repos#get-admin-branch-protection

Get admin branch protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

PostReposownerrepoBranchesbranchProtectionEnforceAdmins(String, String, String)

• tags repos
• post /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins
• docs https://docs.github.com/rest/reference/repos#set-admin-branch-protection

Set admin branch protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

DeleteReposownerrepoBranchesbranchProtectionEnforceAdmins(String, String, String)

• tags repos
• delete /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins
• docs https://docs.github.com/rest/reference/repos#delete-admin-branch-protection

Delete admin branch protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

GetReposownerrepoBranchesbranchProtectionRequiredPullRequestReviews(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews
• docs https://docs.github.com/rest/reference/repos#get-pull-request-review-protection

Get pull request review protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

PatchReposownerrepoBranchesbranchProtectionRequiredPullRequestReviews(String, String, String)

• tags repos
• patch /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews
• docs https://docs.github.com/rest/reference/repos#update-pull-request-review-protection

Update pull request review protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

Note: Passing new arrays of users and teams replaces their previous values.

DeleteReposownerrepoBranchesbranchProtectionRequiredPullRequestReviews(String, String, String)

• tags repos
• delete /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews
• docs https://docs.github.com/rest/reference/repos#delete-pull-request-review-protection

Delete pull request review protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

GetReposownerrepoBranchesbranchProtectionRequiredSignatures(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures
• docs https://docs.github.com/rest/reference/repos#get-commit-signature-protection

Get commit signature protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.

Note: You must enable branch protection to require signed commits.

PostReposownerrepoBranchesbranchProtectionRequiredSignatures(String, String, String)

• tags repos
• post /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures
• docs https://docs.github.com/rest/reference/repos#create-commit-signature-protection

Create commit signature protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.

DeleteReposownerrepoBranchesbranchProtectionRequiredSignatures(String, String, String)

• tags repos
• delete /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures
• docs https://docs.github.com/rest/reference/repos#delete-commit-signature-protection

Delete commit signature protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.

GetReposownerrepoBranchesbranchProtectionRequiredStatusChecks(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks
• docs https://docs.github.com/rest/reference/repos#get-status-checks-protection

Get status checks protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

PatchReposownerrepoBranchesbranchProtectionRequiredStatusChecks(String, String, String)

• tags repos
• patch /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks
• docs https://docs.github.com/rest/reference/repos#update-status-check-protection

Update status check protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.

DeleteReposownerrepoBranchesbranchProtectionRequiredStatusChecks(String, String, String)

• tags repos
• delete /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks
• docs https://docs.github.com/rest/reference/repos#remove-status-check-protection

Remove status check protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

GetReposownerrepoBranchesbranchProtectionRequiredStatusChecksContexts(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts
• docs https://docs.github.com/rest/reference/repos#get-all-status-check-contexts

Get all status check contexts Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

PostReposownerrepoBranchesbranchProtectionRequiredStatusChecksContexts(String, String, String)

• tags repos
• post /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts
• docs https://docs.github.com/rest/reference/repos#add-status-check-contexts

Add status check contexts Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

PutReposownerrepoBranchesbranchProtectionRequiredStatusChecksContexts(String, String, String)

• tags repos
• put /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts
• docs https://docs.github.com/rest/reference/repos#set-status-check-contexts

Set status check contexts Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

DeleteReposownerrepoBranchesbranchProtectionRequiredStatusChecksContexts(String, String, String)

• tags repos
• delete /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts
• docs https://docs.github.com/rest/reference/repos#remove-status-check-contexts

Remove status check contexts Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

GetReposownerrepoBranchesbranchProtectionRestrictions(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/branches/{branch}/protection/restrictions
• docs https://docs.github.com/rest/reference/repos#get-access-restrictions

Get access restrictions Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

Lists who has access to this protected branch.

Note: Users, apps, and teams restrictions are only available for organization-owned repositories.

DeleteReposownerrepoBranchesbranchProtectionRestrictions(String, String, String)

• tags repos
• delete /repos/{owner}/{repo}/branches/{branch}/protection/restrictions
• docs https://docs.github.com/rest/reference/repos#delete-access-restrictions

Delete access restrictions Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

Disables the ability to restrict who can push to this branch.

GetReposownerrepoBranchesbranchProtectionRestrictionsApps(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps
• docs https://docs.github.com/rest/reference/repos#list-apps-with-access-to-the-protected-branch

Get apps with access to the protected branch Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

PostReposownerrepoBranchesbranchProtectionRestrictionsApps(String, String, String)

• tags repos
• post /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps
• docs https://docs.github.com/rest/reference/repos#add-app-access-restrictions

Add app access restrictions Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

Grants the specified apps push access for this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

Type	Description
array	The GitHub Apps that have push access to this branch. Use the app’s slug. Note: The list of users, apps, and teams in total is limited to 100 items.

PutReposownerrepoBranchesbranchProtectionRestrictionsApps(String, String, String)

• tags repos
• put /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps
• docs https://docs.github.com/rest/reference/repos#set-app-access-restrictions

Set app access restrictions Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

Type	Description
array	The GitHub Apps that have push access to this branch. Use the app’s slug. Note: The list of users, apps, and teams in total is limited to 100 items.

DeleteReposownerrepoBranchesbranchProtectionRestrictionsApps(String, String, String)

• tags repos
• delete /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps
• docs https://docs.github.com/rest/reference/repos#remove-app-access-restrictions

Remove app access restrictions Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

Removes the ability of an app to push to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

Type	Description
array	The GitHub Apps that have push access to this branch. Use the app’s slug. Note: The list of users, apps, and teams in total is limited to 100 items.

GetReposownerrepoBranchesbranchProtectionRestrictionsTeams(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams
• docs https://docs.github.com/rest/reference/repos#list-teams-with-access-to-the-protected-branch

Get teams with access to the protected branch Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

Lists the teams who have push access to this branch. The list includes child teams.

PostReposownerrepoBranchesbranchProtectionRestrictionsTeams(String, String, String)

• tags repos
• post /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams
• docs https://docs.github.com/rest/reference/repos#add-team-access-restrictions

Add team access restrictions Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

Grants the specified teams push access for this branch. You can also give push access to child teams.

Type	Description
array	The teams that can have push access. Use the team’s slug. Note: The list of users, apps, and teams in total is limited to 100 items.

PutReposownerrepoBranchesbranchProtectionRestrictionsTeams(String, String, String)

• tags repos
• put /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams
• docs https://docs.github.com/rest/reference/repos#set-team-access-restrictions

Set team access restrictions Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.

Type	Description
array	The teams that can have push access. Use the team’s slug. Note: The list of users, apps, and teams in total is limited to 100 items.

DeleteReposownerrepoBranchesbranchProtectionRestrictionsTeams(String, String, String)

• tags repos
• delete /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams
• docs https://docs.github.com/rest/reference/repos#remove-team-access-restrictions

Remove team access restrictions Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

Removes the ability of a team to push to this branch. You can also remove push access for child teams.

Type	Description
array	Teams that should no longer have push access. Use the team’s slug. Note: The list of users, apps, and teams in total is limited to 100 items.

GetReposownerrepoBranchesbranchProtectionRestrictionsUsers(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users
• docs https://docs.github.com/rest/reference/repos#list-users-with-access-to-the-protected-branch

Get users with access to the protected branch Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

Lists the people who have push access to this branch.

PostReposownerrepoBranchesbranchProtectionRestrictionsUsers(String, String, String)

• tags repos
• post /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users
• docs https://docs.github.com/rest/reference/repos#add-user-access-restrictions

Add user access restrictions Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

Grants the specified people push access for this branch.

Type	Description
array	Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.

PutReposownerrepoBranchesbranchProtectionRestrictionsUsers(String, String, String)

• tags repos
• put /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users
• docs https://docs.github.com/rest/reference/repos#set-user-access-restrictions

Set user access restrictions Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.

Type	Description
array	Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.

DeleteReposownerrepoBranchesbranchProtectionRestrictionsUsers(String, String, String)

• tags repos
• delete /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users
• docs https://docs.github.com/rest/reference/repos#remove-user-access-restrictions

Remove user access restrictions Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

Removes the ability of a user to push to this branch.

Type	Description
array	Usernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items.

PostReposownerrepoBranchesbranchRename(String, String, String)

• tags repos
• post /repos/{owner}/{repo}/branches/{branch}/rename
• docs https://docs.github.com/rest/reference/repos#rename-a-branch

Rename a branch Renames a branch in a repository.

Note: Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won’t be able to push to the old branch name while the rename process is in progress. For more information, see “Renaming a branch”.

The permissions required to use this endpoint depends on whether you are renaming the default branch.

To rename a non-default branch:

• Users must have push access.
• GitHub Apps must have the contents:write repository permission.

To rename the default branch:

• Users must have admin or owner permissions.
• GitHub Apps must have the administration:write repository permission.

PostReposownerrepoCheckRuns(String, String)

• tags checks
• post /repos/{owner}/{repo}/check-runs
• docs https://docs.github.com/rest/reference/checks#create-a-check-run

Create a check run Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.

In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.

GetReposownerrepoCheckRunscheckRunId(String, String, String)

• tags checks
• get /repos/{owner}/{repo}/check-runs/{check_run_id}
• docs https://docs.github.com/rest/reference/checks#get-a-check-run

Get a check run Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

PatchReposownerrepoCheckRunscheckRunId(String, String, String)

• tags checks
• patch /repos/{owner}/{repo}/check-runs/{check_run_id}
• docs https://docs.github.com/rest/reference/checks#update-a-check-run

Update a check run Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

Updates a check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to edit check runs.

GetReposownerrepoCheckRunscheckRunIdAnnotations(String, String, String)

• tags checks
• get /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations
• docs https://docs.github.com/rest/reference/checks#list-check-run-annotations

List check run annotations Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.

PostReposownerrepoCheckRunscheckRunIdRerequest(String, String, String)

• tags checks
• post /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest
• docs https://docs.github.com/rest/reference/checks#rerequest-a-check-run

Rerequest a check run Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run webhook event with the action rerequested. When a check run is rerequested, its status is reset to queued and the conclusion is cleared.

To rerequest a check run, your GitHub App must have the checks:read permission on a private repository or pull access to a public repository.

PostReposownerrepoCheckSuites(String, String)

• tags checks
• post /repos/{owner}/{repo}/check-suites
• docs https://docs.github.com/rest/reference/checks#create-a-check-suite

Create a check suite Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you’ve disabled automatic creation using “Update repository preferences for check suites”. Your GitHub App must have the checks:write permission to create check suites.

PatchReposownerrepoCheckSuitesPreferences(String, String)

• tags checks
• patch /repos/{owner}/{repo}/check-suites/preferences
• docs https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites

Update repository preferences for check suites 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. You must have admin permissions in the repository to set preferences for check suites.

GetReposownerrepoCheckSuitescheckSuiteId(String, String, String)

• tags checks
• get /repos/{owner}/{repo}/check-suites/{check_suite_id}
• docs https://docs.github.com/rest/reference/checks#get-a-check-suite

Get a check suite Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

GetReposownerrepoCheckSuitescheckSuiteIdCheckRuns(String, String, String)

• tags checks
• get /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs
• docs https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite

List check runs in a check suite Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

PostReposownerrepoCheckSuitescheckSuiteIdRerequest(String, String, String)

• tags checks
• post /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest
• docs https://docs.github.com/rest/reference/checks#rerequest-a-check-suite

Rerequest a check suite Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared.

To rerequest a check suite, your GitHub App must have the checks:read permission on a private repository or pull access to a public repository.

GetReposownerrepoCodeScanningAlerts(String, String)

• tags code-scanning
• get /repos/{owner}/{repo}/code-scanning/alerts
• docs https://docs.github.com/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository

List code scanning alerts for a repository Lists all open code scanning alerts for the default branch (usually main or master). You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.

The response includes a most_recent_instance object. This provides details of the most recent instance of this alert for the default branch or for the specified Git reference (if you used ref in the request).

GetReposownerrepoCodeScanningAlertsalertNumber(String, String, String)

• tags code-scanning
• get /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}
• docs https://docs.github.com/rest/reference/code-scanning#get-a-code-scanning-alert

Get a code scanning alert Gets a single code scanning alert. You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.

Deprecation notice: The instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by instances_url.

PatchReposownerrepoCodeScanningAlertsalertNumber(String, String, String)

• tags code-scanning
• patch /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}
• docs https://docs.github.com/rest/reference/code-scanning#update-a-code-scanning-alert

Update a code scanning alert Updates the status of a single code scanning alert. You must use an access token with the security_events scope to use this endpoint with private repositories. You can also use tokens with the public_repo scope for public repositories only. GitHub Apps must have the security_events write permission to use this endpoint.

GetReposownerrepoCodeScanningAlertsalertNumberInstances(String, String, String)

• tags code-scanning
• get /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances
• docs https://docs.github.com/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert

List instances of a code scanning alert Lists all instances of the specified code scanning alert. You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.

GetReposownerrepoCodeScanningAnalyses(String, String)

• tags code-scanning
• get /repos/{owner}/{repo}/code-scanning/analyses
• docs https://docs.github.com/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository

List code scanning analyses for a repository Lists the details of all code scanning analyses for a repository, starting with the most recent. The response is paginated and you can use the page and per_page parameters to list the analyses you’re interested in. By default 30 analyses are listed per page.

The rules_count field in the response give the number of rules that were run in the analysis. For very old analyses this data is not available, and 0 is returned in this field.

You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.

Deprecation notice: The tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

GetReposownerrepoCodeScanningAnalysesanalysisId(String, String, String)

• tags code-scanning
• get /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}
• docs https://docs.github.com/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository

Get a code scanning analysis for a repository Gets a specified code scanning analysis for a repository. You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.

The default JSON response contains fields that describe the analysis. This includes the Git reference and commit SHA to which the analysis relates, the datetime of the analysis, the name of the code scanning tool, and the number of alerts.

The rules_count field in the default response give the number of rules that were run in the analysis. For very old analyses this data is not available, and 0 is returned in this field.

If you use the Accept header application/sarif+json, the response contains the analysis data that was uploaded. This is formatted as SARIF version 2.1.0.

DeleteReposownerrepoCodeScanningAnalysesanalysisId(String, String, String)

• tags code-scanning
• delete /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}
• docs https://docs.github.com/rest/reference/code-scanning#delete-a-code-scanning-analysis-from-a-repository

Delete a code scanning analysis from a repository Deletes a specified code scanning analysis from a repository. For private repositories, you must use an access token with the repo scope. For public repositories, you must use an access token with public_repo scope. GitHub Apps must have the security_events write permission to use this endpoint.

You can delete one analysis at a time. To delete a series of analyses, start with the most recent analysis and work backwards. Conceptually, the process is similar to the undo function in a text editor.

When you list the analyses for a repository, one or more will be identified as deletable in the response:

"deletable": true

An analysis is deletable when it’s the most recent in a set of analyses. Typically, a repository will have multiple sets of analyses for each enabled code scanning tool, where a set is determined by a unique combination of analysis values:

• ref
• tool
• analysis_key
• environment

If you attempt to delete an analysis that is not the most recent in a set, you’ll get a 400 response with the message:

Analysis specified is not deletable.

The response from a successful DELETE operation provides you with two alternative URLs for deleting the next analysis in the set: next_analysis_url and confirm_delete_url. Use the next_analysis_url URL if you want to avoid accidentally deleting the final analysis in a set. This is a useful option if you want to preserve at least one analysis for the specified tool in your repository. Use the confirm_delete_url URL if you are content to remove all analyses for a tool. When you delete the last analysis in a set, the value of next_analysis_url and confirm_delete_url in the 200 response is null.

As an example of the deletion process, let’s imagine that you added a workflow that configured a particular code scanning tool to analyze the code in a repository. This tool has added 15 analyses: 10 on the default branch, and another 5 on a topic branch. You therefore have two separate sets of analyses for this tool. You’ve now decided that you want to remove all of the analyses for the tool. To do this you must make 15 separate deletion requests. To start, you must find an analysis that’s identified as deletable. Each set of analyses always has one that’s identified as deletable. Having found the deletable analysis for one of the two sets, delete this analysis and then continue deleting the next analysis in the set until they’re all deleted. Then repeat the process for the second set. The procedure therefore consists of a nested loop:

Outer loop:

• List the analyses for the repository, filtered by tool.

• Parse this list to find a deletable analysis. If found:

  Inner loop:

  • Delete the identified analysis.
  • Parse the response for the value of confirm_delete_url and, if found, use this in the next iteration.

The above process assumes that you want to remove all trace of the tool’s analyses from the GitHub user interface, for the specified repository, and it therefore uses the confirm_delete_url value. Alternatively, you could use the next_analysis_url value, which would leave the last analysis in each set undeleted to avoid removing a tool’s analysis entirely.

PostReposownerrepoCodeScanningSarifs(String, String)

• tags code-scanning
• post /repos/{owner}/{repo}/code-scanning/sarifs
• docs https://docs.github.com/rest/reference/code-scanning#upload-a-sarif-file

Upload an analysis as SARIF data Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint for private repositories. You can also use tokens with the public_repo scope for public repositories only. GitHub Apps must have the security_events write permission to use this endpoint.

There are two places where you can upload code scanning results.

• If you upload to a pull request, for example --ref refs/pull/42/merge or --ref refs/pull/42/head, then the results appear as alerts in a pull request check. For more information, see “Triaging code scanning alerts in pull requests.”
• If you upload to a branch, for example --ref refs/heads/my-branch, then the results appear in the Security tab for your repository. For more information, see “Managing code scanning alerts for your repository.”

You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

gzip -c analysis-data.sarif | base64 -w0

SARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.

The 202 Accepted, response includes an id value. You can use this ID to check the status of the upload by using this for the /sarifs/{sarif_id} endpoint. For more information, see “Get information about a SARIF upload.”

GetReposownerrepoCodeScanningSarifssarifId(String, String, String)

• tags code-scanning
• get /repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}
• docs https://docs.github.com/rest/reference/code-scanning#list-recent-code-scanning-analyses-for-a-repository

Get information about a SARIF upload Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see “Get a code scanning analysis for a repository.” You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.

GetReposownerrepoCodespaces(String, String)

• tags codespaces
• get /repos/{owner}/{repo}/codespaces
• docs https://docs.github.com/rest/reference/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user

List codespaces in a repository for the authenticated user Lists the codespaces associated to a specified repository and the authenticated user.

You must authenticate using an access token with the codespace scope to use this endpoint.

PostReposownerrepoCodespaces(String, String)

• tags codespaces
• post /repos/{owner}/{repo}/codespaces
• docs https://docs.github.com/rest/reference/codespaces#create-a-codespace-in-a-repository

Create a codespace in a repository Creates a codespace owned by the authenticated user in the specified repository.

You must authenticate using an access token with the codespace scope to use this endpoint.

GetReposownerrepoCodespacesMachines(String, String)

• tags codespaces
• get /repos/{owner}/{repo}/codespaces/machines
• docs https://docs.github.com/rest/reference/codespaces#list-available-machine-types-for-a-repository

List available machine types for a repository List the machine types available for a given repository based on its configuration.

Location is required.

You must authenticate using an access token with the codespace scope to use this endpoint.

GetReposownerrepoCollaborators(String, String)

• tags repos
• get /repos/{owner}/{repo}/collaborators
• docs https://docs.github.com/rest/reference/repos#list-repository-collaborators

List repository collaborators For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.

Team members will include the members of child teams.

You must authenticate using an access token with the read:org and repo scopes with push access to use this endpoint. GitHub Apps must have the members organization permission and metadata repository permission to use this endpoint.

GetReposownerrepoCollaboratorsusername(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/collaborators/{username}
• docs https://docs.github.com/rest/reference/repos#check-if-a-user-is-a-repository-collaborator

Check if a user is a repository collaborator For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.

Team members will include the members of child teams.

You must authenticate using an access token with the read:org and repo scopes with push access to use this endpoint. GitHub Apps must have the members organization permission and metadata repository permission to use this endpoint.

PutReposownerrepoCollaboratorsusername(String, String, String)

• tags repos
• put /repos/{owner}/{repo}/collaborators/{username}
• docs https://docs.github.com/rest/reference/repos#add-a-repository-collaborator

Add a repository collaborator This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.

For more information on permission levels, see “Repository permission levels for an organization”. There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:

Cannot assign {member} permission of {role name}

Note that, if you choose not to pass any parameters, you’ll need to set Content-Length to zero when calling out to this endpoint. For more information, see “HTTP verbs.”

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

Rate limits

You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

DeleteReposownerrepoCollaboratorsusername(String, String, String)

• tags repos
• delete /repos/{owner}/{repo}/collaborators/{username}
• docs https://docs.github.com/rest/reference/repos#remove-a-repository-collaborator

Remove a repository collaborator

GetReposownerrepoCollaboratorsusernamePermission(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/collaborators/{username}/permission
• docs https://docs.github.com/rest/reference/repos#get-repository-permissions-for-a-user

Get repository permissions for a user Checks the repository permission of a collaborator. The possible repository permissions are admin, write, read, and none.

GetReposownerrepoComments(String, String)

• tags repos
• get /repos/{owner}/{repo}/comments
• docs https://docs.github.com/rest/reference/repos#list-commit-comments-for-a-repository

List commit comments for a repository Commit Comments use these custom media types. You can read more about the use of media types in the API here.

Comments are ordered by ascending ID.

GetReposownerrepoCommentscommentId(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/comments/{comment_id}
• docs https://docs.github.com/rest/reference/repos#get-a-commit-comment

Get a commit comment

PatchReposownerrepoCommentscommentId(String, String, String)

• tags repos
• patch /repos/{owner}/{repo}/comments/{comment_id}
• docs https://docs.github.com/rest/reference/repos#update-a-commit-comment

Update a commit comment

DeleteReposownerrepoCommentscommentId(String, String, String)

• tags repos
• delete /repos/{owner}/{repo}/comments/{comment_id}
• docs https://docs.github.com/rest/reference/repos#delete-a-commit-comment

Delete a commit comment

GetReposownerrepoCommentscommentIdReactions(String, String, String)

• tags reactions
• get /repos/{owner}/{repo}/comments/{comment_id}/reactions
• docs https://docs.github.com/rest/reference/reactions#list-reactions-for-a-commit-comment

List reactions for a commit comment List the reactions to a commit comment.

PostReposownerrepoCommentscommentIdReactions(String, String, String)

• tags reactions
• post /repos/{owner}/{repo}/comments/{comment_id}/reactions
• docs https://docs.github.com/rest/reference/reactions#create-reaction-for-a-commit-comment

Create reaction for a commit comment Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.

DeleteReposownerrepoCommentscommentIdReactionsreactionId(String, String, String, String)

• tags reactions
• delete /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}
• docs https://docs.github.com/rest/reference/reactions#delete-a-commit-comment-reaction

Delete a commit comment reaction Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.

Delete a reaction to a commit comment.

GetReposownerrepoCommits(String, String)

• tags repos
• get /repos/{owner}/{repo}/commits
• docs https://docs.github.com/rest/reference/repos#list-commits

List commits Signature verification object

The response will include a verification object that describes the result of verifying the commit’s signature. The following fields are included in the verification object:

Name	Type	Description
verified	boolean	Indicates whether GitHub considers the signature in this commit to be verified.
reason	string	The reason for verified value. Possible values and their meanings are enumerated in table below.
signature	string	The signature that was extracted from the commit.
payload	string	The value that was signed.

These are the possible values for reason in the verification object:

Value	Description
expired_key	The key that made the signature is expired.
not_signing_key	The “signing” flag is not among the usage flags in the GPG key that made the signature.
gpgverify_error	There was an error communicating with the signature verification service.
gpgverify_unavailable	The signature verification service is currently unavailable.
unsigned	The object does not include a signature.
unknown_signature_type	A non-PGP signature was found in the commit.
no_user	No user was associated with the committer email address in the commit.
unverified_email	The committer email address in the commit was associated with a user, but the email address is not verified on her/his account.
bad_email	The committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_key	The key that made the signature has not been registered with any user’s account.
malformed_signature	There was an error parsing the signature.
invalid	The signature could not be cryptographically verified using the key whose key-id was found in the signature.
valid	None of the above errors applied, so the signature is considered to be verified.

GetReposownerrepoCommitscommitShaBranchesWhereHead(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head
• docs https://docs.github.com/rest/reference/repos#list-branches-for-head-commit

List branches for HEAD commit Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s products in the GitHub Help documentation.

Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch.

GetReposownerrepoCommitscommitShaComments(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/commits/{commit_sha}/comments
• docs https://docs.github.com/rest/reference/repos#list-commit-comments

List commit comments Use the :commit_sha to specify the commit that will have its comments listed.

PostReposownerrepoCommitscommitShaComments(String, String, String)

• tags repos
• post /repos/{owner}/{repo}/commits/{commit_sha}/comments
• docs https://docs.github.com/rest/reference/repos#create-a-commit-comment

Create a commit comment Create a comment for a commit using its :commit_sha.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.

GetReposownerrepoCommitscommitShaPulls(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/commits/{commit_sha}/pulls
• docs https://docs.github.com/rest/reference/repos#list-pull-requests-associated-with-a-commit

List pull requests associated with a commit Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the List pull requests endpoint.

GetReposownerrepoCommitsref(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/commits/{ref}
• docs https://docs.github.com/rest/reference/repos#get-a-commit

Get a commit Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.

Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.

You can pass the appropriate media type to fetch diff and patch formats. Diffs with binary data will have no patch property.

To return only the SHA-1 hash of the commit reference, you can provide the sha custom media type in the Accept header. You can use this endpoint to check if a remote reference’s SHA-1 hash is the same as your local reference’s SHA-1 hash by providing the local SHA-1 reference as the ETag.

Signature verification object

The response will include a verification object that describes the result of verifying the commit’s signature. The following fields are included in the verification object:

Name	Type	Description
verified	boolean	Indicates whether GitHub considers the signature in this commit to be verified.
reason	string	The reason for verified value. Possible values and their meanings are enumerated in table below.
signature	string	The signature that was extracted from the commit.
payload	string	The value that was signed.

These are the possible values for reason in the verification object:

Value	Description
expired_key	The key that made the signature is expired.
not_signing_key	The “signing” flag is not among the usage flags in the GPG key that made the signature.
gpgverify_error	There was an error communicating with the signature verification service.
gpgverify_unavailable	The signature verification service is currently unavailable.
unsigned	The object does not include a signature.
unknown_signature_type	A non-PGP signature was found in the commit.
no_user	No user was associated with the committer email address in the commit.
unverified_email	The committer email address in the commit was associated with a user, but the email address is not verified on her/his account.
bad_email	The committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_key	The key that made the signature has not been registered with any user’s account.
malformed_signature	There was an error parsing the signature.
invalid	The signature could not be cryptographically verified using the key whose key-id was found in the signature.
valid	None of the above errors applied, so the signature is considered to be verified.

GetReposownerrepoCommitsrefCheckRuns(String, String, String)

• tags checks
• get /repos/{owner}/{repo}/commits/{ref}/check-runs
• docs https://docs.github.com/rest/reference/checks#list-check-runs-for-a-git-reference

List check runs for a Git reference Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

GetReposownerrepoCommitsrefCheckSuites(String, String, String)

• tags checks
• get /repos/{owner}/{repo}/commits/{ref}/check-suites
• docs https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference

List check suites for a Git reference Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

GetReposownerrepoCommitsrefStatus(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/commits/{ref}/status
• docs https://docs.github.com/rest/reference/repos#get-the-combined-status-for-a-specific-reference

Get the combined status for a specific reference Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.

Additionally, a combined state is returned. The state is one of:

• failure if any of the contexts report as error or failure
• pending if there are no statuses or a context is pending
• success if the latest status for all contexts is success

GetReposownerrepoCommitsrefStatuses(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/commits/{ref}/statuses
• docs https://docs.github.com/rest/reference/repos#list-commit-statuses-for-a-reference

List commit statuses for a reference Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.

This resource is also available via a legacy route: GET /repos/:owner/:repo/statuses/:ref.

GetReposownerrepoCommunityProfile(String, String)

• tags repos
• get /repos/{owner}/{repo}/community/profile
• docs https://docs.github.com/rest/reference/repos#get-community-profile-metrics

Get community profile metrics This endpoint will return all community profile metrics, including an overall health score, repository description, the presence of documentation, detected code of conduct, detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE, README, and CONTRIBUTING files.

The health_percentage score is defined as a percentage of how many of these four documents are present: README, CONTRIBUTING, LICENSE, and CODE_OF_CONDUCT. For example, if all four documents are present, then the health_percentage is 100. If only one is present, then the health_percentage is 25.

content_reports_enabled is only returned for organization-owned repositories.

GetReposownerrepoComparebasehead(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/compare/{basehead}
• docs https://docs.github.com/rest/reference/repos#compare-two-commits

Compare two commits The basehead param is comprised of two parts: base and head. Both must be branch names in repo. To compare branches across other repositories in the same network as repo, use the format <USERNAME>:branch.

The response from the API is equivalent to running the git log base..head command; however, commits are returned in chronological order. Pass the appropriate media type to fetch diff and patch formats.

The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.

Working with large comparisons

To process a response with a large number of commits, you can use (per_page or page) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see “Traversing with pagination.”

When calling this API without any paging parameters (per_page or page), the returned list is limited to 250 commits and the last commit in the list is the most recent of the entire comparison. When a paging parameter is specified, the first commit in the returned list of each page is the earliest.

Signature verification object

The response will include a verification object that describes the result of verifying the commit’s signature. The following fields are included in the verification object:

Name	Type	Description
verified	boolean	Indicates whether GitHub considers the signature in this commit to be verified.
reason	string	The reason for verified value. Possible values and their meanings are enumerated in table below.
signature	string	The signature that was extracted from the commit.
payload	string	The value that was signed.

These are the possible values for reason in the verification object:

Value	Description
expired_key	The key that made the signature is expired.
not_signing_key	The “signing” flag is not among the usage flags in the GPG key that made the signature.
gpgverify_error	There was an error communicating with the signature verification service.
gpgverify_unavailable	The signature verification service is currently unavailable.
unsigned	The object does not include a signature.
unknown_signature_type	A non-PGP signature was found in the commit.
no_user	No user was associated with the committer email address in the commit.
unverified_email	The committer email address in the commit was associated with a user, but the email address is not verified on her/his account.
bad_email	The committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_key	The key that made the signature has not been registered with any user’s account.
malformed_signature	There was an error parsing the signature.
invalid	The signature could not be cryptographically verified using the key whose key-id was found in the signature.
valid	None of the above errors applied, so the signature is considered to be verified.

GetReposownerrepoContentspath(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/contents/{path}
• docs https://docs.github.com/rest/reference/repos#get-repository-content

Get repository content Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit :path, you will receive the contents of the repository’s root directory. See the description below regarding what the API response includes for directories.

Files and symlinks support a custom media type for retrieving the raw content or rendered HTML (when supported). All content types support a custom media type to ensure the content is returned in a consistent object format.

Note:

• To get a repository’s contents recursively, you can recursively get the tree.
• This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees API.
• This API supports files up to 1 megabyte in size.

If the content is a directory

The response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their “type” specified as “file”. Logically, the value should be “submodule”. This behavior exists in API v3 for backwards compatibility purposes. In the next major version of the API, the type will be returned as “submodule”.

If the content is a symlink

If the requested :path points to a symlink, and the symlink’s target is a normal file in the repository, then the API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object describing the symlink itself.

If the content is a submodule

The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit.

If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links["git"]) and the github.com URLs (html_url and _links["html"]) will have null values.

PutReposownerrepoContentspath(String, String, String)

• tags repos
• put /repos/{owner}/{repo}/contents/{path}
• docs https://docs.github.com/rest/reference/repos#create-or-update-file-contents

Create or update file contents Creates a new file or replaces an existing file in a repository.

DeleteReposownerrepoContentspath(String, String, String)

• tags repos
• delete /repos/{owner}/{repo}/contents/{path}
• docs https://docs.github.com/rest/reference/repos#delete-a-file

Delete a file Deletes a file in a repository.

You can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.

The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user’s information is used.

You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you’ll receive a 422 status code.

GetReposownerrepoContributors(String, String)

• tags repos
• get /repos/{owner}/{repo}/contributors
• docs https://docs.github.com/rest/reference/repos#list-repository-contributors

List repository contributors Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.

GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.

GetReposownerrepoDependabotSecrets(String, String)

• tags dependabot
• get /repos/{owner}/{repo}/dependabot/secrets
• docs https://docs.github.com/rest/reference/dependabot#list-repository-secrets

List repository secrets Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository permission to use this endpoint.

GetReposownerrepoDependabotSecretsPublicKey(String, String)

• tags dependabot
• get /repos/{owner}/{repo}/dependabot/secrets/public-key
• docs https://docs.github.com/rest/reference/dependabot#get-a-repository-public-key

Get a repository public key Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the dependabot_secrets repository permission to use this endpoint.

GetReposownerrepoDependabotSecretssecretName(String, String, String)

• tags dependabot
• get /repos/{owner}/{repo}/dependabot/secrets/{secret_name}
• docs https://docs.github.com/rest/reference/dependabot#get-a-repository-secret

Get a repository secret Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository permission to use this endpoint.

PutReposownerrepoDependabotSecretssecretName(String, String, String)

• tags dependabot
• put /repos/{owner}/{repo}/dependabot/secrets/{secret_name}
• docs https://docs.github.com/rest/reference/dependabot#create-or-update-a-repository-secret

Create or update a repository secret Creates or updates a repository secret with an encrypted value. Encrypt your secret using LibSodium. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository permission to use this endpoint.

Example encrypting a secret using Node.js

Encrypt your secret using the tweetsodium library.

const sodium = require('tweetsodium');

const key = "base64-encoded-public-key";
const value = "plain-text-secret";

// Convert the message and key to Uint8Array's (Buffer implements that interface)
const messageBytes = Buffer.from(value);
const keyBytes = Buffer.from(key, 'base64');

// Encrypt using LibSodium.
const encryptedBytes = sodium.seal(messageBytes, keyBytes);

// Base64 the encrypted secret
const encrypted = Buffer.from(encryptedBytes).toString('base64');

console.log(encrypted);

Example encrypting a secret using Python

Encrypt your secret using pynacl with Python 3.

from base64 import b64encode
from nacl import encoding, public

def encrypt(public_key: str, secret_value: str) -> str:
  """Encrypt a Unicode string using the public key."""
  public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
  sealed_box = public.SealedBox(public_key)
  encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
  return b64encode(encrypted).decode("utf-8")

Example encrypting a secret using C#

Encrypt your secret using the Sodium.Core package.

var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");

var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);

Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));

Example encrypting a secret using Ruby

Encrypt your secret using the rbnacl gem.

require "rbnacl"
require "base64"

key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
public_key = RbNaCl::PublicKey.new(key)

box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
encrypted_secret = box.encrypt("my_secret")

# Print the base64 encoded secret
puts Base64.strict_encode64(encrypted_secret)

DeleteReposownerrepoDependabotSecretssecretName(String, String, String)

• tags dependabot
• delete /repos/{owner}/{repo}/dependabot/secrets/{secret_name}
• docs https://docs.github.com/rest/reference/dependabot#delete-a-repository-secret

Delete a repository secret Deletes a secret in a repository using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository permission to use this endpoint.

GetReposownerrepoDeployments(String, String)

• tags repos
• get /repos/{owner}/{repo}/deployments
• docs https://docs.github.com/rest/reference/repos#list-deployments

List deployments Simple filtering of deployments is available via query parameters:

PostReposownerrepoDeployments(String, String)

• tags repos
• post /repos/{owner}/{repo}/deployments
• docs https://docs.github.com/rest/reference/repos#create-a-deployment

Create a deployment Deployments offer a few configurable parameters with certain defaults.

The ref parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them before we merge a pull request.

The environment parameter allows deployments to be issued to different runtime environments. Teams often have multiple environments for verifying their applications, such as production, staging, and qa. This parameter makes it easier to track which environments have requested deployments. The default environment is production.

The auto_merge parameter is used to ensure that the requested ref is not behind the repository’s default branch. If the ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will return a failure response.

By default, commit statuses for every submitted context must be in a success state. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do not require any contexts or create any commit statuses, the deployment will always succeed.

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text field that will be passed on when a deployment event is dispatched.

The task parameter is used by the deployment system to allow different execution paths. In the web world this might be deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an application with debugging enabled.

Users with repo or repo_deployment scopes can create a deployment for a given ref.

Merged branch response

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating a deployment. This auto-merge happens when:

• Auto-merge option is enabled in the repository
• Topic branch does not include the latest changes on the base branch, which is master in the response example
• There are no merge conflicts

If there are no new commits in the base branch, a new request to create a deployment should give a successful response.

Merge conflict response

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can’t be merged into the branch that’s being deployed (in this case topic-branch), due to merge conflicts.

Failed commit status checks

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success status for the commit to be deployed, but one or more of the required contexts do not have a state of success.

GetReposownerrepoDeploymentsdeploymentId(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/deployments/{deployment_id}
• docs https://docs.github.com/rest/reference/repos#get-a-deployment

Get a deployment

DeleteReposownerrepoDeploymentsdeploymentId(String, String, String)

• tags repos
• delete /repos/{owner}/{repo}/deployments/{deployment_id}
• docs https://docs.github.com/rest/reference/repos#delete-a-deployment

Delete a deployment If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with repo or repo_deployment scopes can delete a deployment.

To set a deployment as inactive, you must:

• Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.
• Mark the active deployment as inactive by adding any non-successful deployment status.

For more information, see “Create a deployment” and “Create a deployment status.”

GetReposownerrepoDeploymentsdeploymentIdStatuses(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/deployments/{deployment_id}/statuses
• docs https://docs.github.com/rest/reference/repos#list-deployment-statuses

List deployment statuses Users with pull access can view deployment statuses for a deployment:

PostReposownerrepoDeploymentsdeploymentIdStatuses(String, String, String)

• tags repos
• post /repos/{owner}/{repo}/deployments/{deployment_id}/statuses
• docs https://docs.github.com/rest/reference/repos#create-a-deployment-status

Create a deployment status Users with push access can create deployment statuses for a given deployment.

GitHub Apps require read & write access to “Deployments” and read-only access to “Repo contents” (for private repos). OAuth Apps require the repo_deployment scope.

GetReposownerrepoDeploymentsdeploymentIdStatusesstatusId(String, String, String, String)

• tags repos
• get /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}
• docs https://docs.github.com/rest/reference/repos#get-a-deployment-status

Get a deployment status Users with pull access can view a deployment status for a deployment:

PostReposownerrepoDispatches(String, String)

• tags repos
• post /repos/{owner}/{repo}/dispatches
• docs https://docs.github.com/rest/reference/repos#create-a-repository-dispatch-event

Create a repository dispatch event You can use this endpoint to trigger a webhook event called repository_dispatch when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the repository_dispatch event occurs. For an example repository_dispatch webhook payload, see “RepositoryDispatchEvent.”

The client_payload parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the client_payload can include a message that a user would like to send using a GitHub Actions workflow. Or the client_payload can be used as a test to debug your workflow.

This endpoint requires write access to the repository by providing either:

• Personal access tokens with repo scope. For more information, see “Creating a personal access token for the command line” in the GitHub Help documentation.
• GitHub Apps with both metadata:read and contents:read&write permissions.

This input example shows how you can use the client_payload as a test to debug your workflow.

GetReposownerrepoEnvironments(String, String)

• tags repos
• get /repos/{owner}/{repo}/environments
• docs https://docs.github.com/rest/reference/repos#get-all-environments

Get all environments Get all environments for a repository.

Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

GetReposownerrepoEnvironmentsenvironmentName(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/environments/{environment_name}
• docs https://docs.github.com/rest/reference/repos#get-an-environment

Get an environment Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

PutReposownerrepoEnvironmentsenvironmentName(String, String, String)

• tags repos
• put /repos/{owner}/{repo}/environments/{environment_name}
• docs https://docs.github.com/rest/reference/repos#create-or-update-an-environment

Create or update an environment Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see “Environments.”

Note: Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see “Environments.”

Note: To create or update secrets for an environment, see “Secrets.”

You must authenticate using an access token with the repo scope to use this endpoint.

DeleteReposownerrepoEnvironmentsenvironmentName(String, String, String)

• tags repos
• delete /repos/{owner}/{repo}/environments/{environment_name}
• docs https://docs.github.com/rest/reference/repos#delete-an-environment

Delete an environment You must authenticate using an access token with the repo scope to use this endpoint.

GetReposownerrepoEvents(String, String)

• tags activity
• get /repos/{owner}/{repo}/events
• docs https://docs.github.com/rest/reference/activity#list-repository-events

List repository events

GetReposownerrepoForks(String, String)

• tags repos
• get /repos/{owner}/{repo}/forks
• docs https://docs.github.com/rest/reference/repos#list-forks

List forks

PostReposownerrepoForks(String, String)

• tags repos
• post /repos/{owner}/{repo}/forks
• docs https://docs.github.com/rest/reference/repos#create-a-fork

Create a fork Create a fork for the authenticated user.

Note: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Support.

PostReposownerrepoGitBlobs(String, String)

• tags git
• post /repos/{owner}/{repo}/git/blobs
• docs https://docs.github.com/rest/reference/git#create-a-blob

Create a blob

GetReposownerrepoGitBlobsfileSha(String, String, String)

• tags git
• get /repos/{owner}/{repo}/git/blobs/{file_sha}
• docs https://docs.github.com/rest/reference/git#get-a-blob

Get a blob The content in the response will always be Base64 encoded.

Note: This API supports blobs up to 100 megabytes in size.

PostReposownerrepoGitCommits(String, String)

• tags git
• post /repos/{owner}/{repo}/git/commits
• docs https://docs.github.com/rest/reference/git#create-a-commit

Create a commit Creates a new Git commit object.

Signature verification object

The response will include a verification object that describes the result of verifying the commit’s signature. The following fields are included in the verification object:

Name	Type	Description
verified	boolean	Indicates whether GitHub considers the signature in this commit to be verified.
reason	string	The reason for verified value. Possible values and their meanings are enumerated in table below.
signature	string	The signature that was extracted from the commit.
payload	string	The value that was signed.

These are the possible values for reason in the verification object:

Value	Description
expired_key	The key that made the signature is expired.
not_signing_key	The “signing” flag is not among the usage flags in the GPG key that made the signature.
gpgverify_error	There was an error communicating with the signature verification service.
gpgverify_unavailable	The signature verification service is currently unavailable.
unsigned	The object does not include a signature.
unknown_signature_type	A non-PGP signature was found in the commit.
no_user	No user was associated with the committer email address in the commit.
unverified_email	The committer email address in the commit was associated with a user, but the email address is not verified on her/his account.
bad_email	The committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_key	The key that made the signature has not been registered with any user’s account.
malformed_signature	There was an error parsing the signature.
invalid	The signature could not be cryptographically verified using the key whose key-id was found in the signature.
valid	None of the above errors applied, so the signature is considered to be verified.

GetReposownerrepoGitCommitscommitSha(String, String, String)

• tags git
• get /repos/{owner}/{repo}/git/commits/{commit_sha}
• docs https://docs.github.com/rest/reference/git#get-a-commit

Get a commit Gets a Git commit object.

Signature verification object

The response will include a verification object that describes the result of verifying the commit’s signature. The following fields are included in the verification object:

Name	Type	Description
verified	boolean	Indicates whether GitHub considers the signature in this commit to be verified.
reason	string	The reason for verified value. Possible values and their meanings are enumerated in table below.
signature	string	The signature that was extracted from the commit.
payload	string	The value that was signed.

These are the possible values for reason in the verification object:

Value	Description
expired_key	The key that made the signature is expired.
not_signing_key	The “signing” flag is not among the usage flags in the GPG key that made the signature.
gpgverify_error	There was an error communicating with the signature verification service.
gpgverify_unavailable	The signature verification service is currently unavailable.
unsigned	The object does not include a signature.
unknown_signature_type	A non-PGP signature was found in the commit.
no_user	No user was associated with the committer email address in the commit.
unverified_email	The committer email address in the commit was associated with a user, but the email address is not verified on her/his account.
bad_email	The committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_key	The key that made the signature has not been registered with any user’s account.
malformed_signature	There was an error parsing the signature.
invalid	The signature could not be cryptographically verified using the key whose key-id was found in the signature.
valid	None of the above errors applied, so the signature is considered to be verified.

GetReposownerrepoGitMatchingRefsref(String, String, String)

• tags git
• get /repos/{owner}/{repo}/git/matching-refs/{ref}
• docs https://docs.github.com/rest/reference/git#list-matching-references

List matching references Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn’t exist in the repository, but existing refs start with :ref, they will be returned as an array.

When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see “Checking mergeability of pull requests”.

If you request matching references for a branch named feature but the branch feature doesn’t exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.

GetReposownerrepoGitRefref(String, String, String)

• tags git
• get /repos/{owner}/{repo}/git/ref/{ref}
• docs https://docs.github.com/rest/reference/git#get-a-reference

Get a reference Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn’t match an existing ref, a 404 is returned.

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see “Checking mergeability of pull requests”.

PostReposownerrepoGitRefs(String, String)

• tags git
• post /repos/{owner}/{repo}/git/refs
• docs https://docs.github.com/rest/reference/git#create-a-reference

Create a reference Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.

PatchReposownerrepoGitRefsref(String, String, String)

• tags git
• patch /repos/{owner}/{repo}/git/refs/{ref}
• docs https://docs.github.com/rest/reference/git#update-a-reference

Update a reference

DeleteReposownerrepoGitRefsref(String, String, String)

• tags git
• delete /repos/{owner}/{repo}/git/refs/{ref}
• docs https://docs.github.com/rest/reference/git#delete-a-reference

Delete a reference

PostReposownerrepoGitTags(String, String)

• tags git
• post /repos/{owner}/{repo}/git/tags
• docs https://docs.github.com/rest/reference/git#create-a-tag-object

Create a tag object Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.

Signature verification object

The response will include a verification object that describes the result of verifying the commit’s signature. The following fields are included in the verification object:

Name	Type	Description
verified	boolean	Indicates whether GitHub considers the signature in this commit to be verified.
reason	string	The reason for verified value. Possible values and their meanings are enumerated in table below.
signature	string	The signature that was extracted from the commit.
payload	string	The value that was signed.

These are the possible values for reason in the verification object:

Value	Description
expired_key	The key that made the signature is expired.
not_signing_key	The “signing” flag is not among the usage flags in the GPG key that made the signature.
gpgverify_error	There was an error communicating with the signature verification service.
gpgverify_unavailable	The signature verification service is currently unavailable.
unsigned	The object does not include a signature.
unknown_signature_type	A non-PGP signature was found in the commit.
no_user	No user was associated with the committer email address in the commit.
unverified_email	The committer email address in the commit was associated with a user, but the email address is not verified on her/his account.
bad_email	The committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_key	The key that made the signature has not been registered with any user’s account.
malformed_signature	There was an error parsing the signature.
invalid	The signature could not be cryptographically verified using the key whose key-id was found in the signature.
valid	None of the above errors applied, so the signature is considered to be verified.

GetReposownerrepoGitTagstagSha(String, String, String)

• tags git
• get /repos/{owner}/{repo}/git/tags/{tag_sha}
• docs https://docs.github.com/rest/reference/git#get-a-tag

Get a tag Signature verification object

The response will include a verification object that describes the result of verifying the commit’s signature. The following fields are included in the verification object:

Name	Type	Description
verified	boolean	Indicates whether GitHub considers the signature in this commit to be verified.
reason	string	The reason for verified value. Possible values and their meanings are enumerated in table below.
signature	string	The signature that was extracted from the commit.
payload	string	The value that was signed.

These are the possible values for reason in the verification object:

Value	Description
expired_key	The key that made the signature is expired.
not_signing_key	The “signing” flag is not among the usage flags in the GPG key that made the signature.
gpgverify_error	There was an error communicating with the signature verification service.
gpgverify_unavailable	The signature verification service is currently unavailable.
unsigned	The object does not include a signature.
unknown_signature_type	A non-PGP signature was found in the commit.
no_user	No user was associated with the committer email address in the commit.
unverified_email	The committer email address in the commit was associated with a user, but the email address is not verified on her/his account.
bad_email	The committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_key	The key that made the signature has not been registered with any user’s account.
malformed_signature	There was an error parsing the signature.
invalid	The signature could not be cryptographically verified using the key whose key-id was found in the signature.
valid	None of the above errors applied, so the signature is considered to be verified.

PostReposownerrepoGitTrees(String, String)

• tags git
• post /repos/{owner}/{repo}/git/trees
• docs https://docs.github.com/rest/reference/git#create-a-tree

Create a tree The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.

If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see “Create a commit” and “Update a reference.”

GetReposownerrepoGitTreestreeSha(String, String, String)

• tags git
• get /repos/{owner}/{repo}/git/trees/{tree_sha}
• docs https://docs.github.com/rest/reference/git#get-a-tree

Get a tree Returns a single tree using the SHA1 value for that tree.

If truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.

GetReposownerrepoHooks(String, String)

• tags repos
• get /repos/{owner}/{repo}/hooks
• docs https://docs.github.com/rest/reference/repos#list-repository-webhooks

List repository webhooks

PostReposownerrepoHooks(String, String)

• tags repos
• post /repos/{owner}/{repo}/hooks
• docs https://docs.github.com/rest/reference/repos#create-a-repository-webhook

Create a repository webhook Repositories can have multiple webhooks installed. Each webhook should have a unique config. Multiple webhooks can share the same config as long as those webhooks do not have any events that overlap.

GetReposownerrepoHookshookId(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/hooks/{hook_id}
• docs https://docs.github.com/rest/reference/repos#get-a-repository-webhook

Get a repository webhook Returns a webhook configured in a repository. To get only the webhook config properties, see “Get a webhook configuration for a repository.”

PatchReposownerrepoHookshookId(String, String, String)

• tags repos
• patch /repos/{owner}/{repo}/hooks/{hook_id}
• docs https://docs.github.com/rest/reference/repos#update-a-repository-webhook

Update a repository webhook Updates a webhook configured in a repository. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use “Update a webhook configuration for a repository.”

DeleteReposownerrepoHookshookId(String, String, String)

• tags repos
• delete /repos/{owner}/{repo}/hooks/{hook_id}
• docs https://docs.github.com/rest/reference/repos#delete-a-repository-webhook

Delete a repository webhook

GetReposownerrepoHookshookIdConfig(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/hooks/{hook_id}/config
• docs https://docs.github.com/rest/reference/repos#get-a-webhook-configuration-for-a-repository

Get a webhook configuration for a repository Returns the webhook configuration for a repository. To get more information about the webhook, including the active state and events, use “Get a repository webhook.”

Access tokens must have the read:repo_hook or repo scope, and GitHub Apps must have the repository_hooks:read permission.

PatchReposownerrepoHookshookIdConfig(String, String, String)

• tags repos
• patch /repos/{owner}/{repo}/hooks/{hook_id}/config
• docs https://docs.github.com/rest/reference/repos#update-a-webhook-configuration-for-a-repository

Update a webhook configuration for a repository Updates the webhook configuration for a repository. To update more information about the webhook, including the active state and events, use “Update a repository webhook.”

Access tokens must have the write:repo_hook or repo scope, and GitHub Apps must have the repository_hooks:write permission.

GetReposownerrepoHookshookIdDeliveries(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/hooks/{hook_id}/deliveries
• docs https://docs.github.com/rest/reference/repos#list-deliveries-for-a-repository-webhook

List deliveries for a repository webhook Returns a list of webhook deliveries for a webhook configured in a repository.

GetReposownerrepoHookshookIdDeliveriesdeliveryId(String, String, String, String)

• tags repos
• get /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}
• docs https://docs.github.com/rest/reference/repos#get-a-delivery-for-a-repository-webhook

Get a delivery for a repository webhook Returns a delivery for a webhook configured in a repository.

PostReposownerrepoHookshookIdDeliveriesdeliveryIdAttempts(String, String, String, String)

• tags repos
• post /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts
• docs https://docs.github.com/rest/reference/repos#redeliver-a-delivery-for-a-repository-webhook

Redeliver a delivery for a repository webhook Redeliver a webhook delivery for a webhook configured in a repository.

PostReposownerrepoHookshookIdPings(String, String, String)

• tags repos
• post /repos/{owner}/{repo}/hooks/{hook_id}/pings
• docs https://docs.github.com/rest/reference/repos#ping-a-repository-webhook

Ping a repository webhook This will trigger a ping event to be sent to the hook.

PostReposownerrepoHookshookIdTests(String, String, String)

• tags repos
• post /repos/{owner}/{repo}/hooks/{hook_id}/tests
• docs https://docs.github.com/rest/reference/repos#test-the-push-repository-webhook

Test the push repository webhook This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook is not subscribed to push events, the server will respond with 204 but no test POST will be generated.

Note: Previously /repos/:owner/:repo/hooks/:hook_id/test

GetReposownerrepoImport(String, String)

• tags migrations
• get /repos/{owner}/{repo}/import
• docs https://docs.github.com/rest/reference/migrations#get-an-import-status

Get an import status View the progress of an import.

Import status

This section includes details about the possible values of the status field of the Import Progress response.

An import that does not have errors will progress through these steps:

• detecting - the “detection” step of the import is in progress because the request did not include a vcs parameter. The import is identifying the type of source control present at the URL.
• importing - the “raw” step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include commit_count (the total number of raw commits that will be imported) and percent (0 - 100, the current progress through the import).
• mapping - the “rewrite” step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.
• pushing - the “push” step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include push_percent, which is the percent value reported by git push when it is “Writing objects”.
• complete - the import is complete, and the repository is ready on GitHub.

If there are problems, you will see one of these in the status field:

• auth_failed - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the Update an import section.
• error - the import encountered an error. The import progress response will include the failed_step and an error message. Contact GitHub Support for more information.
• detection_needs_auth - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the Update an import section.
• detection_found_nothing - the importer didn’t recognize any source control at the URL. To resolve, Cancel the import and retry with the correct URL.
• detection_found_multiple - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a project_choices field with the possible project choices as values. To update project choice, please see the Update an import section.

The project_choices field

When multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.

Git LFS related fields

This section includes details about Git LFS related fields that may be present in the Import Progress response.

• use_lfs - describes whether the import has been opted in or out of using Git LFS. The value can be opt_in, opt_out, or undecided if no action has been taken.
• has_large_files - the boolean value describing whether files larger than 100MB were found during the importing step.
• large_files_size - the total size in gigabytes of files larger than 100MB found in the originating repository.
• large_files_count - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a “Get Large Files” request.

PutReposownerrepoImport(String, String)

• tags migrations
• put /repos/{owner}/{repo}/import
• docs https://docs.github.com/rest/reference/migrations#start-an-import

Start an import Start a source import to a GitHub repository using GitHub Importer.

PatchReposownerrepoImport(String, String)

• tags migrations
• patch /repos/{owner}/{repo}/import
• docs https://docs.github.com/rest/reference/migrations#update-an-import

Update an import An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API request. If no parameters are provided, the import will be restarted.

DeleteReposownerrepoImport(String, String)

• tags migrations
• delete /repos/{owner}/{repo}/import
• docs https://docs.github.com/rest/reference/migrations#cancel-an-import

Cancel an import Stop an import for a repository.

GetReposownerrepoImportAuthors(String, String)

• tags migrations
• get /repos/{owner}/{repo}/import/authors
• docs https://docs.github.com/rest/reference/migrations#get-commit-authors

Get commit authors Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot <hubot@12341234-abab-fefe-8787-fedcba987654>.

This endpoint and the Map a commit author endpoint allow you to provide correct Git author information.

PatchReposownerrepoImportAuthorsauthorId(String, String, String)

• tags migrations
• patch /repos/{owner}/{repo}/import/authors/{author_id}
• docs https://docs.github.com/rest/reference/migrations#map-a-commit-author

Map a commit author Update an author’s identity for the import. Your application can continue updating authors any time before you push new commits to the repository.

GetReposownerrepoImportLargeFiles(String, String)

• tags migrations
• get /repos/{owner}/{repo}/import/large_files
• docs https://docs.github.com/rest/reference/migrations#get-large-files

Get large files List files larger than 100MB found during the import

PatchReposownerrepoImportLfs(String, String)

• tags migrations
• patch /repos/{owner}/{repo}/import/lfs
• docs https://docs.github.com/rest/reference/migrations#update-git-lfs-preference

Update Git LFS preference You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by Git LFS. You can learn more about our LFS feature and working with large files on our help site.

GetReposownerrepoInstallation(String, String)

• tags apps
• get /repos/{owner}/{repo}/installation
• docs https://docs.github.com/rest/reference/apps#get-a-repository-installation-for-the-authenticated-app

Get a repository installation for the authenticated app Enables an authenticated GitHub App to find the repository’s installation information. The installation’s account type will be either an organization or a user account, depending which account the repository belongs to.

You must use a JWT to access this endpoint.

GetReposownerrepoInteractionLimits(String, String)

• tags interactions
• get /repos/{owner}/{repo}/interaction-limits
• docs https://docs.github.com/rest/reference/interactions#get-interaction-restrictions-for-a-repository

Get interaction restrictions for a repository Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.

PutReposownerrepoInteractionLimits(String, String)

• tags interactions
• put /repos/{owner}/{repo}/interaction-limits
• docs https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-a-repository

Set interaction restrictions for a repository Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a 409 Conflict response and will not be able to use this endpoint to change the interaction limit for a single repository.

DeleteReposownerrepoInteractionLimits(String, String)

• tags interactions
• delete /repos/{owner}/{repo}/interaction-limits
• docs https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-for-a-repository

Remove interaction restrictions for a repository Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a 409 Conflict response and will not be able to use this endpoint to change the interaction limit for a single repository.

GetReposownerrepoInvitations(String, String)

• tags repos
• get /repos/{owner}/{repo}/invitations
• docs https://docs.github.com/rest/reference/repos#list-repository-invitations

List repository invitations When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.

PatchReposownerrepoInvitationsinvitationId(String, String, String)

• tags repos
• patch /repos/{owner}/{repo}/invitations/{invitation_id}
• docs https://docs.github.com/rest/reference/repos#update-a-repository-invitation

Update a repository invitation

DeleteReposownerrepoInvitationsinvitationId(String, String, String)

• tags repos
• delete /repos/{owner}/{repo}/invitations/{invitation_id}
• docs https://docs.github.com/rest/reference/repos#delete-a-repository-invitation

Delete a repository invitation

GetReposownerrepoIssues(String, String)

• tags issues
• get /repos/{owner}/{repo}/issues
• docs https://docs.github.com/rest/reference/issues#list-repository-issues

List repository issues List issues in a repository.

Note: GitHub’s REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, “Issues” endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from “Issues” endpoints will be an issue id. To find out the pull request id, use the “List pull requests” endpoint.

PostReposownerrepoIssues(String, String)

• tags issues
• post /repos/{owner}/{repo}/issues
• docs https://docs.github.com/rest/reference/issues#create-an-issue

Create an issue Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.

GetReposownerrepoIssuesComments(String, String)

• tags issues
• get /repos/{owner}/{repo}/issues/comments
• docs https://docs.github.com/rest/reference/issues#list-issue-comments-for-a-repository

List issue comments for a repository By default, Issue Comments are ordered by ascending ID.

GetReposownerrepoIssuesCommentscommentId(String, String, String)

• tags issues
• get /repos/{owner}/{repo}/issues/comments/{comment_id}
• docs https://docs.github.com/rest/reference/issues#get-an-issue-comment

Get an issue comment

PatchReposownerrepoIssuesCommentscommentId(String, String, String)

• tags issues
• patch /repos/{owner}/{repo}/issues/comments/{comment_id}
• docs https://docs.github.com/rest/reference/issues#update-an-issue-comment

Update an issue comment

DeleteReposownerrepoIssuesCommentscommentId(String, String, String)

• tags issues
• delete /repos/{owner}/{repo}/issues/comments/{comment_id}
• docs https://docs.github.com/rest/reference/issues#delete-an-issue-comment

Delete an issue comment

GetReposownerrepoIssuesCommentscommentIdReactions(String, String, String)

• tags reactions
• get /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions
• docs https://docs.github.com/rest/reference/reactions#list-reactions-for-an-issue-comment

List reactions for an issue comment List the reactions to an issue comment.

PostReposownerrepoIssuesCommentscommentIdReactions(String, String, String)

• tags reactions
• post /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions
• docs https://docs.github.com/rest/reference/reactions#create-reaction-for-an-issue-comment

Create reaction for an issue comment Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.

DeleteReposownerrepoIssuesCommentscommentIdReactionsreactionId(String, String, String, String)

• tags reactions
• delete /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}
• docs https://docs.github.com/rest/reference/reactions#delete-an-issue-comment-reaction

Delete an issue comment reaction Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.

Delete a reaction to an issue comment.

GetReposownerrepoIssuesEvents(String, String)

• tags issues
• get /repos/{owner}/{repo}/issues/events
• docs https://docs.github.com/rest/reference/issues#list-issue-events-for-a-repository

List issue events for a repository

GetReposownerrepoIssuesEventseventId(String, String, String)

• tags issues
• get /repos/{owner}/{repo}/issues/events/{event_id}
• docs https://docs.github.com/rest/reference/issues#get-an-issue-event

Get an issue event

GetReposownerrepoIssuesissueNumber(String, String, String)

• tags issues
• get /repos/{owner}/{repo}/issues/{issue_number}
• docs https://docs.github.com/rest/reference/issues#get-an-issue

Get an issue The API returns a 301 Moved Permanently status if the issue was transferred to another repository. If the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API returns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read access, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe to the issues webhook.

Note: GitHub’s REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, “Issues” endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from “Issues” endpoints will be an issue id. To find out the pull request id, use the “List pull requests” endpoint.

PatchReposownerrepoIssuesissueNumber(String, String, String)

• tags issues
• patch /repos/{owner}/{repo}/issues/{issue_number}
• docs https://docs.github.com/rest/reference/issues/#update-an-issue

Update an issue Issue owners and users with push access can edit an issue.

PostReposownerrepoIssuesissueNumberAssignees(String, String, String)

• tags issues
• post /repos/{owner}/{repo}/issues/{issue_number}/assignees
• docs https://docs.github.com/rest/reference/issues#add-assignees-to-an-issue

Add assignees to an issue Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.

DeleteReposownerrepoIssuesissueNumberAssignees(String, String, String)

• tags issues
• delete /repos/{owner}/{repo}/issues/{issue_number}/assignees
• docs https://docs.github.com/rest/reference/issues#remove-assignees-from-an-issue

Remove assignees from an issue Removes one or more assignees from an issue.

GetReposownerrepoIssuesissueNumberComments(String, String, String)

• tags issues
• get /repos/{owner}/{repo}/issues/{issue_number}/comments
• docs https://docs.github.com/rest/reference/issues#list-issue-comments

List issue comments Issue Comments are ordered by ascending ID.

PostReposownerrepoIssuesissueNumberComments(String, String, String)

• tags issues
• post /repos/{owner}/{repo}/issues/{issue_number}/comments
• docs https://docs.github.com/rest/reference/issues#create-an-issue-comment

Create an issue comment This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.

GetReposownerrepoIssuesissueNumberEvents(String, String, String)

• tags issues
• get /repos/{owner}/{repo}/issues/{issue_number}/events
• docs https://docs.github.com/rest/reference/issues#list-issue-events

List issue events

GetReposownerrepoIssuesissueNumberLabels(String, String, String)

• tags issues
• get /repos/{owner}/{repo}/issues/{issue_number}/labels
• docs https://docs.github.com/rest/reference/issues#list-labels-for-an-issue

List labels for an issue

PostReposownerrepoIssuesissueNumberLabels(String, String, String)

• tags issues
• post /repos/{owner}/{repo}/issues/{issue_number}/labels
• docs https://docs.github.com/rest/reference/issues#add-labels-to-an-issue

Add labels to an issue

PutReposownerrepoIssuesissueNumberLabels(String, String, String)

• tags issues
• put /repos/{owner}/{repo}/issues/{issue_number}/labels
• docs https://docs.github.com/rest/reference/issues#set-labels-for-an-issue

Set labels for an issue Removes any previous labels and sets the new labels for an issue.

DeleteReposownerrepoIssuesissueNumberLabels(String, String, String)

• tags issues
• delete /repos/{owner}/{repo}/issues/{issue_number}/labels
• docs https://docs.github.com/rest/reference/issues#remove-all-labels-from-an-issue

Remove all labels from an issue

DeleteReposownerrepoIssuesissueNumberLabelsname(String, String, String, String)

• tags issues
• delete /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}
• docs https://docs.github.com/rest/reference/issues#remove-a-label-from-an-issue

Remove a label from an issue Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a 404 Not Found status if the label does not exist.

PutReposownerrepoIssuesissueNumberLock(String, String, String)

• tags issues
• put /repos/{owner}/{repo}/issues/{issue_number}/lock
• docs https://docs.github.com/rest/reference/issues#lock-an-issue

Lock an issue Users with push access can lock an issue or pull request’s conversation.

Note that, if you choose not to pass any parameters, you’ll need to set Content-Length to zero when calling out to this endpoint. For more information, see “HTTP verbs.”

DeleteReposownerrepoIssuesissueNumberLock(String, String, String)

• tags issues
• delete /repos/{owner}/{repo}/issues/{issue_number}/lock
• docs https://docs.github.com/rest/reference/issues#unlock-an-issue

Unlock an issue Users with push access can unlock an issue’s conversation.

GetReposownerrepoIssuesissueNumberReactions(String, String, String)

• tags reactions
• get /repos/{owner}/{repo}/issues/{issue_number}/reactions
• docs https://docs.github.com/rest/reference/reactions#list-reactions-for-an-issue

List reactions for an issue List the reactions to an issue.

PostReposownerrepoIssuesissueNumberReactions(String, String, String)

• tags reactions
• post /repos/{owner}/{repo}/issues/{issue_number}/reactions
• docs https://docs.github.com/rest/reference/reactions#create-reaction-for-an-issue

Create reaction for an issue Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.

DeleteReposownerrepoIssuesissueNumberReactionsreactionId(String, String, String, String)

• tags reactions
• delete /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}
• docs https://docs.github.com/rest/reference/reactions#delete-an-issue-reaction

Delete an issue reaction Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.

Delete a reaction to an issue.

GetReposownerrepoIssuesissueNumberTimeline(String, String, String)

• tags issues
• get /repos/{owner}/{repo}/issues/{issue_number}/timeline
• docs https://docs.github.com/rest/reference/issues#list-timeline-events-for-an-issue

List timeline events for an issue

GetReposownerrepoKeys(String, String)

• tags repos
• get /repos/{owner}/{repo}/keys
• docs https://docs.github.com/rest/reference/repos#list-deploy-keys

List deploy keys

PostReposownerrepoKeys(String, String)

• tags repos
• post /repos/{owner}/{repo}/keys
• docs https://docs.github.com/rest/reference/repos#create-a-deploy-key

Create a deploy key You can create a read-only deploy key.

GetReposownerrepoKeyskeyId(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/keys/{key_id}
• docs https://docs.github.com/rest/reference/repos#get-a-deploy-key

Get a deploy key

DeleteReposownerrepoKeyskeyId(String, String, String)

• tags repos
• delete /repos/{owner}/{repo}/keys/{key_id}
• docs https://docs.github.com/rest/reference/repos#delete-a-deploy-key

Delete a deploy key Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.

GetReposownerrepoLabels(String, String)

• tags issues
• get /repos/{owner}/{repo}/labels
• docs https://docs.github.com/rest/reference/issues#list-labels-for-a-repository

List labels for a repository

PostReposownerrepoLabels(String, String)

• tags issues
• post /repos/{owner}/{repo}/labels
• docs https://docs.github.com/rest/reference/issues#create-a-label

Create a label

GetReposownerrepoLabelsname(String, String, String)

• tags issues
• get /repos/{owner}/{repo}/labels/{name}
• docs https://docs.github.com/rest/reference/issues#get-a-label

Get a label

PatchReposownerrepoLabelsname(String, String, String)

• tags issues
• patch /repos/{owner}/{repo}/labels/{name}
• docs https://docs.github.com/rest/reference/issues#update-a-label

Update a label

DeleteReposownerrepoLabelsname(String, String, String)

• tags issues
• delete /repos/{owner}/{repo}/labels/{name}
• docs https://docs.github.com/rest/reference/issues#delete-a-label

Delete a label

GetReposownerrepoLanguages(String, String)

• tags repos
• get /repos/{owner}/{repo}/languages
• docs https://docs.github.com/rest/reference/repos#list-repository-languages

List repository languages Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.

PutReposownerrepoLfs(String, String)

• tags repos
• put /repos/{owner}/{repo}/lfs
• docs https://docs.github.com/rest/reference/repos#enable-git-lfs-for-a-repository

Enable Git LFS for a repository

DeleteReposownerrepoLfs(String, String)

• tags repos
• delete /repos/{owner}/{repo}/lfs
• docs https://docs.github.com/rest/reference/repos#disable-git-lfs-for-a-repository

Disable Git LFS for a repository

GetReposownerrepoLicense(String, String)

• tags licenses
• get /repos/{owner}/{repo}/license
• docs https://docs.github.com/rest/reference/licenses/#get-the-license-for-a-repository

Get the license for a repository This method returns the contents of the repository’s license file, if one is detected.

Similar to Get repository content, this method also supports custom media types for retrieving the raw license content or rendered license HTML.

PostReposownerrepoMergeUpstream(String, String)

• tags repos
• post /repos/{owner}/{repo}/merge-upstream
• docs https://docs.github.com/rest/reference/repos#sync-a-fork-branch-with-the-upstream-repository

Sync a fork branch with the upstream repository Sync a branch of a forked repository to keep it up-to-date with the upstream repository.

PostReposownerrepoMerges(String, String)

• tags repos
• post /repos/{owner}/{repo}/merges
• docs https://docs.github.com/rest/reference/repos#merge-a-branch

Merge a branch

GetReposownerrepoMilestones(String, String)

• tags issues
• get /repos/{owner}/{repo}/milestones
• docs https://docs.github.com/rest/reference/issues#list-milestones

List milestones

PostReposownerrepoMilestones(String, String)

• tags issues
• post /repos/{owner}/{repo}/milestones
• docs https://docs.github.com/rest/reference/issues#create-a-milestone

Create a milestone

GetReposownerrepoMilestonesmilestoneNumber(String, String, String)

• tags issues
• get /repos/{owner}/{repo}/milestones/{milestone_number}
• docs https://docs.github.com/rest/reference/issues#get-a-milestone

Get a milestone

PatchReposownerrepoMilestonesmilestoneNumber(String, String, String)

• tags issues
• patch /repos/{owner}/{repo}/milestones/{milestone_number}
• docs https://docs.github.com/rest/reference/issues#update-a-milestone

Update a milestone

DeleteReposownerrepoMilestonesmilestoneNumber(String, String, String)

• tags issues
• delete /repos/{owner}/{repo}/milestones/{milestone_number}
• docs https://docs.github.com/rest/reference/issues#delete-a-milestone

Delete a milestone

GetReposownerrepoMilestonesmilestoneNumberLabels(String, String, String)

• tags issues
• get /repos/{owner}/{repo}/milestones/{milestone_number}/labels
• docs https://docs.github.com/rest/reference/issues#list-labels-for-issues-in-a-milestone

List labels for issues in a milestone

GetReposownerrepoNotifications(String, String)

• tags activity
• get /repos/{owner}/{repo}/notifications
• docs https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user

List repository notifications for the authenticated user List all notifications for the current user.

PutReposownerrepoNotifications(String, String)

• tags activity
• put /repos/{owner}/{repo}/notifications
• docs https://docs.github.com/rest/reference/activity#mark-repository-notifications-as-read

Mark repository notifications as read Marks all notifications in a repository as “read” removes them from the default view on GitHub. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub will run an asynchronous process to mark notifications as “read.” To check whether any “unread” notifications remain, you can use the List repository notifications for the authenticated user endpoint and pass the query parameter all=false.

GetReposownerrepoPages(String, String)

• tags repos
• get /repos/{owner}/{repo}/pages
• docs https://docs.github.com/rest/reference/repos#get-a-github-pages-site

Get a GitHub Pages site

PostReposownerrepoPages(String, String)

• tags repos
• post /repos/{owner}/{repo}/pages
• docs https://docs.github.com/rest/reference/repos#create-a-github-pages-site

Create a GitHub Pages site Configures a GitHub Pages site. For more information, see “About GitHub Pages.”

PutReposownerrepoPages(String, String)

• tags repos
• put /repos/{owner}/{repo}/pages
• docs https://docs.github.com/rest/reference/repos#update-information-about-a-github-pages-site

Update information about a GitHub Pages site Updates information for a GitHub Pages site. For more information, see “About GitHub Pages.

DeleteReposownerrepoPages(String, String)

• tags repos
• delete /repos/{owner}/{repo}/pages
• docs https://docs.github.com/rest/reference/repos#delete-a-github-pages-site

Delete a GitHub Pages site

GetReposownerrepoPagesBuilds(String, String)

• tags repos
• get /repos/{owner}/{repo}/pages/builds
• docs https://docs.github.com/rest/reference/repos#list-github-pages-builds

List GitHub Pages builds

PostReposownerrepoPagesBuilds(String, String)

• tags repos
• post /repos/{owner}/{repo}/pages/builds
• docs https://docs.github.com/rest/reference/repos#request-a-github-pages-build

Request a GitHub Pages build You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.

Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.

GetReposownerrepoPagesBuildsLatest(String, String)

• tags repos
• get /repos/{owner}/{repo}/pages/builds/latest
• docs https://docs.github.com/rest/reference/repos#get-latest-pages-build

Get latest Pages build

GetReposownerrepoPagesBuildsbuildId(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/pages/builds/{build_id}
• docs https://docs.github.com/rest/reference/repos#get-github-pages-build

Get GitHub Pages build

GetReposownerrepoPagesHealth(String, String)

• tags repos
• get /repos/{owner}/{repo}/pages/health
• docs https://docs.github.com/rest/reference/repos#get-a-dns-health-check-for-github-pages

Get a DNS health check for GitHub Pages Gets a health check of the DNS settings for the CNAME record configured for a repository’s GitHub Pages.

The first request to this endpoint returns a 202 Accepted status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a 200 OK status with the health check results in the response.

Users must have admin or owner permissions. GitHub Apps must have the pages:write and administration:write permission to use this endpoint.

GetReposownerrepoProjects(String, String)

• tags projects
• get /repos/{owner}/{repo}/projects
• docs https://docs.github.com/rest/reference/projects#list-repository-projects

List repository projects Lists the projects in a repository. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

PostReposownerrepoProjects(String, String)

• tags projects
• post /repos/{owner}/{repo}/projects
• docs https://docs.github.com/rest/reference/projects#create-a-repository-project

Create a repository project Creates a repository project board. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

GetReposownerrepoPulls(String, String)

• tags pulls
• get /repos/{owner}/{repo}/pulls
• docs https://docs.github.com/rest/reference/pulls#list-pull-requests

List pull requests Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.

PostReposownerrepoPulls(String, String)

• tags pulls
• post /repos/{owner}/{repo}/pulls
• docs https://docs.github.com/rest/reference/pulls#create-a-pull-request

Create a pull request Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

You can create a new pull request.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.

GetReposownerrepoPullsComments(String, String)

• tags pulls
• get /repos/{owner}/{repo}/pulls/comments
• docs https://docs.github.com/rest/reference/pulls#list-review-comments-in-a-repository

List review comments in a repository Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.

GetReposownerrepoPullsCommentscommentId(String, String, String)

• tags pulls
• get /repos/{owner}/{repo}/pulls/comments/{comment_id}
• docs https://docs.github.com/rest/reference/pulls#get-a-review-comment-for-a-pull-request

Get a review comment for a pull request Provides details for a review comment.

PatchReposownerrepoPullsCommentscommentId(String, String, String)

• tags pulls
• patch /repos/{owner}/{repo}/pulls/comments/{comment_id}
• docs https://docs.github.com/rest/reference/pulls#update-a-review-comment-for-a-pull-request

Update a review comment for a pull request Enables you to edit a review comment.

DeleteReposownerrepoPullsCommentscommentId(String, String, String)

• tags pulls
• delete /repos/{owner}/{repo}/pulls/comments/{comment_id}
• docs https://docs.github.com/rest/reference/pulls#delete-a-review-comment-for-a-pull-request

Delete a review comment for a pull request Deletes a review comment.

GetReposownerrepoPullsCommentscommentIdReactions(String, String, String)

• tags reactions
• get /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions
• docs https://docs.github.com/rest/reference/reactions#list-reactions-for-a-pull-request-review-comment

List reactions for a pull request review comment List the reactions to a pull request review comment.

PostReposownerrepoPullsCommentscommentIdReactions(String, String, String)

• tags reactions
• post /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions
• docs https://docs.github.com/rest/reference/reactions#create-reaction-for-a-pull-request-review-comment

Create reaction for a pull request review comment Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.

DeleteReposownerrepoPullsCommentscommentIdReactionsreactionId(String, String, String, String)

• tags reactions
• delete /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}
• docs https://docs.github.com/rest/reference/reactions#delete-a-pull-request-comment-reaction

Delete a pull request comment reaction Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.

Delete a reaction to a pull request review comment.

GetReposownerrepoPullspullNumber(String, String, String)

• tags pulls
• get /repos/{owner}/{repo}/pulls/{pull_number}
• docs https://docs.github.com/rest/reference/pulls#get-a-pull-request

Get a pull request Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.

Lists details of a pull request by providing its number.

When you get, create, or edit a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see “Checking mergeability of pull requests”.

The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.

The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:

• If merged as a merge commit, merge_commit_sha represents the SHA of the merge commit.
• If merged via a squash, merge_commit_sha represents the SHA of the squashed commit on the base branch.
• If rebased, merge_commit_sha represents the commit that the base branch was updated to.

Pass the appropriate media type to fetch diff and patch formats.

PatchReposownerrepoPullspullNumber(String, String, String)

• tags pulls
• patch /repos/{owner}/{repo}/pulls/{pull_number}
• docs https://docs.github.com/rest/reference/pulls/#update-a-pull-request

Update a pull request Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

PostReposownerrepoPullspullNumberCodespaces(String, String, String)

• tags codespaces
• post /repos/{owner}/{repo}/pulls/{pull_number}/codespaces
• docs https://docs.github.com/rest/reference/codespaces#create-a-codespace-from-a-pull-request

Create a codespace from a pull request Creates a codespace owned by the authenticated user for the specified pull request.

You must authenticate using an access token with the codespace scope to use this endpoint.

GetReposownerrepoPullspullNumberComments(String, String, String)

• tags pulls
• get /repos/{owner}/{repo}/pulls/{pull_number}/comments
• docs https://docs.github.com/rest/reference/pulls#list-review-comments-on-a-pull-request

List review comments on a pull request Lists all review comments for a pull request. By default, review comments are in ascending order by ID.

PostReposownerrepoPullspullNumberComments(String, String, String)

• tags pulls
• post /repos/{owner}/{repo}/pulls/{pull_number}/comments
• docs https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request

Create a review comment for a pull request

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see “Create an issue comment.” We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.

You can still create a review comment using the position parameter. When you use position, the line, side, start_line, and start_side parameters are not required.

Note: The position value equals the number of lines down from the first “@@” hunk header in the file you want to add a comment. The line just below the “@@” line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.

PostReposownerrepoPullspullNumberCommentscommentIdReplies(String, String, String, String)

• tags pulls
• post /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies
• docs https://docs.github.com/rest/reference/pulls#create-a-reply-for-a-review-comment

Create a reply for a review comment Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.

GetReposownerrepoPullspullNumberCommits(String, String, String)

• tags pulls
• get /repos/{owner}/{repo}/pulls/{pull_number}/commits
• docs https://docs.github.com/rest/reference/pulls#list-commits-on-a-pull-request

List commits on a pull request Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the List commits endpoint.

GetReposownerrepoPullspullNumberFiles(String, String, String)

• tags pulls
• get /repos/{owner}/{repo}/pulls/{pull_number}/files
• docs https://docs.github.com/rest/reference/pulls#list-pull-requests-files

List pull requests files Note: Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.

GetReposownerrepoPullspullNumberMerge(String, String, String)

• tags pulls
• get /repos/{owner}/{repo}/pulls/{pull_number}/merge
• docs https://docs.github.com/rest/reference/pulls#check-if-a-pull-request-has-been-merged

Check if a pull request has been merged

PutReposownerrepoPullspullNumberMerge(String, String, String)

• tags pulls
• put /repos/{owner}/{repo}/pulls/{pull_number}/merge
• docs https://docs.github.com/rest/reference/pulls#merge-a-pull-request

Merge a pull request This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.

GetReposownerrepoPullspullNumberRequestedReviewers(String, String, String)

• tags pulls
• get /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers
• docs https://docs.github.com/rest/reference/pulls#list-requested-reviewers-for-a-pull-request

List requested reviewers for a pull request

PostReposownerrepoPullspullNumberRequestedReviewers(String, String, String)

• tags pulls
• post /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers
• docs https://docs.github.com/rest/reference/pulls#request-reviewers-for-a-pull-request

Request reviewers for a pull request This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.

DeleteReposownerrepoPullspullNumberRequestedReviewers(String, String, String)

• tags pulls
• delete /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers
• docs https://docs.github.com/rest/reference/pulls#remove-requested-reviewers-from-a-pull-request

Remove requested reviewers from a pull request

GetReposownerrepoPullspullNumberReviews(String, String, String)

• tags pulls
• get /repos/{owner}/{repo}/pulls/{pull_number}/reviews
• docs https://docs.github.com/rest/reference/pulls#list-reviews-for-a-pull-request

List reviews for a pull request The list of reviews returns in chronological order.

PostReposownerrepoPullspullNumberReviews(String, String, String)

• tags pulls
• post /repos/{owner}/{repo}/pulls/{pull_number}/reviews
• docs https://docs.github.com/rest/reference/pulls#create-a-review-for-a-pull-request

Create a review for a pull request This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.

Pull request reviews created in the PENDING state do not include the submitted_at property in the response.

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

The position value equals the number of lines down from the first “@@” hunk header in the file you want to add a comment. The line just below the “@@” line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

GetReposownerrepoPullspullNumberReviewsreviewId(String, String, String, String)

• tags pulls
• get /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}
• docs https://docs.github.com/rest/reference/pulls#get-a-review-for-a-pull-request

Get a review for a pull request

PutReposownerrepoPullspullNumberReviewsreviewId(String, String, String, String)

• tags pulls
• put /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}
• docs https://docs.github.com/rest/reference/pulls#update-a-review-for-a-pull-request

Update a review for a pull request Update the review summary comment with new text.

DeleteReposownerrepoPullspullNumberReviewsreviewId(String, String, String, String)

• tags pulls
• delete /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}
• docs https://docs.github.com/rest/reference/pulls#delete-a-pending-review-for-a-pull-request

Delete a pending review for a pull request

GetReposownerrepoPullspullNumberReviewsreviewIdComments(String, String, String, String)

• tags pulls
• get /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments
• docs https://docs.github.com/rest/reference/pulls#list-comments-for-a-pull-request-review

List comments for a pull request review List comments for a specific pull request review.

PutReposownerrepoPullspullNumberReviewsreviewIdDismissals(String, String, String, String)

• tags pulls
• put /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals
• docs https://docs.github.com/rest/reference/pulls#dismiss-a-review-for-a-pull-request

Dismiss a review for a pull request Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.

PostReposownerrepoPullspullNumberReviewsreviewIdEvents(String, String, String, String)

• tags pulls
• post /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events
• docs https://docs.github.com/rest/reference/pulls#submit-a-review-for-a-pull-request

Submit a review for a pull request

PutReposownerrepoPullspullNumberUpdateBranch(String, String, String)

• tags pulls
• put /repos/{owner}/{repo}/pulls/{pull_number}/update-branch
• docs https://docs.github.com/rest/reference/pulls#update-a-pull-request-branch

Update a pull request branch Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.

GetReposownerrepoReadme(String, String)

• tags repos
• get /repos/{owner}/{repo}/readme
• docs https://docs.github.com/rest/reference/repos#get-a-repository-readme

Get a repository README Gets the preferred README for a repository.

READMEs support custom media types for retrieving the raw content or rendered HTML.

GetReposownerrepoReadmedir(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/readme/{dir}
• docs https://docs.github.com/rest/reference/repos#get-a-repository-directory-readme

Get a repository README for a directory Gets the README from a repository directory.

READMEs support custom media types for retrieving the raw content or rendered HTML.

GetReposownerrepoReleases(String, String)

• tags repos
• get /repos/{owner}/{repo}/releases
• docs https://docs.github.com/rest/reference/repos#list-releases

List releases This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the Repository Tags API.

Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.

PostReposownerrepoReleases(String, String)

• tags repos
• post /repos/{owner}/{repo}/releases
• docs https://docs.github.com/rest/reference/repos#create-a-release

Create a release Users with push access to the repository can create a release.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.

GetReposownerrepoReleasesAssetsassetId(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/releases/assets/{asset_id}
• docs https://docs.github.com/rest/reference/repos#get-a-release-asset

Get a release asset To download the asset’s binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.

PatchReposownerrepoReleasesAssetsassetId(String, String, String)

• tags repos
• patch /repos/{owner}/{repo}/releases/assets/{asset_id}
• docs https://docs.github.com/rest/reference/repos#update-a-release-asset

Update a release asset Users with push access to the repository can edit a release asset.

DeleteReposownerrepoReleasesAssetsassetId(String, String, String)

• tags repos
• delete /repos/{owner}/{repo}/releases/assets/{asset_id}
• docs https://docs.github.com/rest/reference/repos#delete-a-release-asset

Delete a release asset

PostReposownerrepoReleasesGenerateNotes(String, String)

• tags repos
• post /repos/{owner}/{repo}/releases/generate-notes
• docs https://docs.github.com/rest/reference/repos#generate-release-notes

Generate release notes content for a release Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.

GetReposownerrepoReleasesLatest(String, String)

• tags repos
• get /repos/{owner}/{repo}/releases/latest
• docs https://docs.github.com/rest/reference/repos#get-the-latest-release

Get the latest release View the latest published full release for the repository.

The latest release is the most recent non-prerelease, non-draft release, sorted by the created_at attribute. The created_at attribute is the date of the commit used for the release, and not the date when the release was drafted or published.

GetReposownerrepoReleasesTagstag(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/releases/tags/{tag}
• docs https://docs.github.com/rest/reference/repos#get-a-release-by-tag-name

Get a release by tag name Get a published release with the specified tag.

GetReposownerrepoReleasesreleaseId(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/releases/{release_id}
• docs https://docs.github.com/rest/reference/repos#get-a-release

Get a release Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.

PatchReposownerrepoReleasesreleaseId(String, String, String)

• tags repos
• patch /repos/{owner}/{repo}/releases/{release_id}
• docs https://docs.github.com/rest/reference/repos#update-a-release

Update a release Users with push access to the repository can edit a release.

DeleteReposownerrepoReleasesreleaseId(String, String, String)

• tags repos
• delete /repos/{owner}/{repo}/releases/{release_id}
• docs https://docs.github.com/rest/reference/repos#delete-a-release

Delete a release Users with push access to the repository can delete a release.

GetReposownerrepoReleasesreleaseIdAssets(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/releases/{release_id}/assets
• docs https://docs.github.com/rest/reference/repos#list-release-assets

List release assets

PostReposownerrepoReleasesreleaseIdAssets(String, String, String)

• tags repos
• post /repos/{owner}/{repo}/releases/{release_id}/assets
• docs https://docs.github.com/rest/reference/repos#upload-a-release-asset

Upload a release asset This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in the response of the Create a release endpoint to upload a release asset.

You need to use an HTTP client which supports SNI to make calls to this endpoint.

Most libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:

application/zip

GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, you’ll still need to pass your authentication to be able to upload an asset.

When an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.

Notes:

• GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The “List assets for a release” endpoint lists the renamed filenames. For more information and help, contact GitHub Support.
• If you upload an asset with the same filename as another uploaded asset, you’ll receive an error and must delete the old file before you can re-upload the new asset.

PostReposownerrepoReleasesreleaseIdReactions(String, String, String)

• tags reactions
• post /repos/{owner}/{repo}/releases/{release_id}/reactions
• docs https://docs.github.com/rest/reference/reactions/#create-reaction-for-a-release

Create reaction for a release Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.

GetReposownerrepoSecretScanningAlerts(String, String)

• tags secret-scanning
• get /repos/{owner}/{repo}/secret-scanning/alerts
• docs https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository

List secret scanning alerts for a repository Lists secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.

GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.

GetReposownerrepoSecretScanningAlertsalertNumber(String, String, String)

• tags secret-scanning
• get /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}
• docs https://docs.github.com/rest/reference/secret-scanning#get-a-secret-scanning-alert

Get a secret scanning alert Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.

GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.

PatchReposownerrepoSecretScanningAlertsalertNumber(String, String, String)

• tags secret-scanning
• patch /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}
• docs https://docs.github.com/rest/reference/secret-scanning#update-a-secret-scanning-alert

Update a secret scanning alert Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.

GitHub Apps must have the secret_scanning_alerts write permission to use this endpoint.

GetReposownerrepoSecretScanningAlertsalertNumberLocations(String, String, String)

• tags secret-scanning
• get /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations
• docs https://docs.github.com/rest/reference/secret-scanning#list-locations-for-a-secret-scanning-alert

List locations for a secret scanning alert Lists all locations for a given secret scanning alert for a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.

GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.

GetReposownerrepoStargazers(String, String)

• tags activity
• get /repos/{owner}/{repo}/stargazers
• docs https://docs.github.com/rest/reference/activity#list-stargazers

List stargazers Lists the people that have starred the repository.

You can also find out when stars were created by passing the following custom media type via the Accept header:

GetReposownerrepoStatsCodeFrequency(String, String)

• tags repos
• get /repos/{owner}/{repo}/stats/code_frequency
• docs https://docs.github.com/rest/reference/repos#get-the-weekly-commit-activity

Get the weekly commit activity Returns a weekly aggregate of the number of additions and deletions pushed to a repository.

GetReposownerrepoStatsCommitActivity(String, String)

• tags repos
• get /repos/{owner}/{repo}/stats/commit_activity
• docs https://docs.github.com/rest/reference/repos#get-the-last-year-of-commit-activity

Get the last year of commit activity Returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.

GetReposownerrepoStatsContributors(String, String)

• tags repos
• get /repos/{owner}/{repo}/stats/contributors
• docs https://docs.github.com/rest/reference/repos#get-all-contributor-commit-activity

Get all contributor commit activity

Returns the total number of commits authored by the contributor. In addition, the response includes a Weekly Hash (weeks array) with the following information:

• w - Start of the week, given as a Unix timestamp.
• a - Number of additions
• d - Number of deletions
• c - Number of commits

GetReposownerrepoStatsParticipation(String, String)

• tags repos
• get /repos/{owner}/{repo}/stats/participation
• docs https://docs.github.com/rest/reference/repos#get-the-weekly-commit-count

Get the weekly commit count Returns the total commit counts for the owner and total commit counts in all. all is everyone combined, including the owner in the last 52 weeks. If you’d like to get the commit counts for non-owners, you can subtract owner from all.

The array order is oldest week (index 0) to most recent week.

GetReposownerrepoStatsPunchCard(String, String)

• tags repos
• get /repos/{owner}/{repo}/stats/punch_card
• docs https://docs.github.com/rest/reference/repos#get-the-hourly-commit-count-for-each-day

Get the hourly commit count for each day Each array contains the day number, hour number, and number of commits:

• 0-6: Sunday - Saturday
• 0-23: Hour of day
• Number of commits

For example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.

PostReposownerrepoStatusessha(String, String, String)

• tags repos
• post /repos/{owner}/{repo}/statuses/{sha}
• docs https://docs.github.com/rest/reference/repos#create-a-commit-status

Create a commit status Users with push access in a repository can create commit statuses for a given SHA.

Note: there is a limit of 1000 statuses per sha and context within a repository. Attempts to create more than 1000 statuses will result in a validation error.

GetReposownerrepoSubscribers(String, String)

• tags activity
• get /repos/{owner}/{repo}/subscribers
• docs https://docs.github.com/rest/reference/activity#list-watchers

List watchers Lists the people watching the specified repository.

GetReposownerrepoSubscription(String, String)

• tags activity
• get /repos/{owner}/{repo}/subscription
• docs https://docs.github.com/rest/reference/activity#get-a-repository-subscription

Get a repository subscription

PutReposownerrepoSubscription(String, String)

• tags activity
• put /repos/{owner}/{repo}/subscription
• docs https://docs.github.com/rest/reference/activity#set-a-repository-subscription

Set a repository subscription If you would like to watch a repository, set subscribed to true. If you would like to ignore notifications made within a repository, set ignored to true. If you would like to stop watching a repository, delete the repository’s subscription completely.

DeleteReposownerrepoSubscription(String, String)

• tags activity
• delete /repos/{owner}/{repo}/subscription
• docs https://docs.github.com/rest/reference/activity#delete-a-repository-subscription

Delete a repository subscription This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, set the repository’s subscription manually.

GetReposownerrepoTags(String, String)

• tags repos
• get /repos/{owner}/{repo}/tags
• docs https://docs.github.com/rest/reference/repos#list-repository-tags

List repository tags

GetReposownerrepoTarballref(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/tarball/{ref}
• docs https://docs.github.com/rest/reference/repos#download-a-repository-archive

Download a repository archive (tar) Gets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually master) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use the Location header to make a second GET request. Note: For private repositories, these links are temporary and expire after five minutes.

GetReposownerrepoTeams(String, String)

• tags repos
• get /repos/{owner}/{repo}/teams
• docs https://docs.github.com/rest/reference/repos#list-repository-teams

List repository teams

GetReposownerrepoTopics(String, String)

• tags repos
• get /repos/{owner}/{repo}/topics
• docs https://docs.github.com/rest/reference/repos#get-all-repository-topics

Get all repository topics

PutReposownerrepoTopics(String, String)

• tags repos
• put /repos/{owner}/{repo}/topics
• docs https://docs.github.com/rest/reference/repos#replace-all-repository-topics

Replace all repository topics

GetReposownerrepoTrafficClones(String, String)

• tags repos
• get /repos/{owner}/{repo}/traffic/clones
• docs https://docs.github.com/rest/reference/repos#get-repository-clones

Get repository clones Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.

GetReposownerrepoTrafficPopularPaths(String, String)

• tags repos
• get /repos/{owner}/{repo}/traffic/popular/paths
• docs https://docs.github.com/rest/reference/repos#get-top-referral-paths

Get top referral paths Get the top 10 popular contents over the last 14 days.

GetReposownerrepoTrafficPopularReferrers(String, String)

• tags repos
• get /repos/{owner}/{repo}/traffic/popular/referrers
• docs https://docs.github.com/rest/reference/repos#get-top-referral-sources

Get top referral sources Get the top 10 referrers over the last 14 days.

GetReposownerrepoTrafficViews(String, String)

• tags repos
• get /repos/{owner}/{repo}/traffic/views
• docs https://docs.github.com/rest/reference/repos#get-page-views

Get page views Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.

PostReposownerrepoTransfer(String, String)

• tags repos
• post /repos/{owner}/{repo}/transfer
• docs https://docs.github.com/rest/reference/repos#transfer-a-repository

Transfer a repository A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.

GetReposownerrepoVulnerabilityAlerts(String, String)

• tags repos
• get /repos/{owner}/{repo}/vulnerability-alerts
• docs https://docs.github.com/rest/reference/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository

Check if vulnerability alerts are enabled for a repository Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see “About security alerts for vulnerable dependencies”.

PutReposownerrepoVulnerabilityAlerts(String, String)

• tags repos
• put /repos/{owner}/{repo}/vulnerability-alerts
• docs https://docs.github.com/rest/reference/repos#enable-vulnerability-alerts

Enable vulnerability alerts Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see “About security alerts for vulnerable dependencies”.

DeleteReposownerrepoVulnerabilityAlerts(String, String)

• tags repos
• delete /repos/{owner}/{repo}/vulnerability-alerts
• docs https://docs.github.com/rest/reference/repos#disable-vulnerability-alerts

Disable vulnerability alerts Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see “About security alerts for vulnerable dependencies”.

GetReposownerrepoZipballref(String, String, String)

• tags repos
• get /repos/{owner}/{repo}/zipball/{ref}
• docs https://docs.github.com/rest/reference/repos#download-a-repository-archive

Download a repository archive (zip) Gets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually master) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use the Location header to make a second GET request. Note: For private repositories, these links are temporary and expire after five minutes.

PostRepostemplateOwnertemplateRepoGenerate(String, String)

• tags repos
• post /repos/{template_owner}/{template_repo}/generate
• docs https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template

Create a repository using a template Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository’s information using the Get a repository endpoint and check that the is_template key is true.

OAuth scope requirements

When using OAuth, authorizations must include:

• public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
• repo scope to create a private repository

GetRepositories()

• tags repos
• get /repositories
• docs https://docs.github.com/rest/reference/repos#list-public-repositories

List public repositories Lists all public repositories in the order that they were created.

Note:

• For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.
• Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.

GetRepositoriesrepositoryIdEnvironmentsenvironmentNameSecrets(String, String)

• tags actions
• get /repositories/{repository_id}/environments/{environment_name}/secrets
• docs https://docs.github.com/rest/reference/actions#list-environment-secrets

List environment secrets Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.

GetRepositoriesrepositoryIdEnvironmentsenvironmentNameSecretsPublicKey(String, String)

• tags actions
• get /repositories/{repository_id}/environments/{environment_name}/secrets/public-key
• docs https://docs.github.com/rest/reference/actions#get-an-environment-public-key

Get an environment public key Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint.

GetRepositoriesrepositoryIdEnvironmentsenvironmentNameSecretssecretName(String, String, String)

• tags actions
• get /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}
• docs https://docs.github.com/rest/reference/actions#get-an-environment-secret

Get an environment secret Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.

PutRepositoriesrepositoryIdEnvironmentsenvironmentNameSecretssecretName(String, String, String)

• tags actions
• put /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}
• docs https://docs.github.com/rest/reference/actions#create-or-update-an-environment-secret

Create or update an environment secret Creates or updates an environment secret with an encrypted value. Encrypt your secret using LibSodium. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.

Example encrypting a secret using Node.js

Encrypt your secret using the tweetsodium library.

const sodium = require('tweetsodium');

const key = "base64-encoded-public-key";
const value = "plain-text-secret";

// Convert the message and key to Uint8Array's (Buffer implements that interface)
const messageBytes = Buffer.from(value);
const keyBytes = Buffer.from(key, 'base64');

// Encrypt using LibSodium.
const encryptedBytes = sodium.seal(messageBytes, keyBytes);

// Base64 the encrypted secret
const encrypted = Buffer.from(encryptedBytes).toString('base64');

console.log(encrypted);

Example encrypting a secret using Python

Encrypt your secret using pynacl with Python 3.

from base64 import b64encode
from nacl import encoding, public

def encrypt(public_key: str, secret_value: str) -> str:
  """Encrypt a Unicode string using the public key."""
  public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
  sealed_box = public.SealedBox(public_key)
  encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
  return b64encode(encrypted).decode("utf-8")

Example encrypting a secret using C#

Encrypt your secret using the Sodium.Core package.

var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");

var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);

Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));

Example encrypting a secret using Ruby

Encrypt your secret using the rbnacl gem.

require "rbnacl"
require "base64"

key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
public_key = RbNaCl::PublicKey.new(key)

box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
encrypted_secret = box.encrypt("my_secret")

# Print the base64 encoded secret
puts Base64.strict_encode64(encrypted_secret)

DeleteRepositoriesrepositoryIdEnvironmentsenvironmentNameSecretssecretName(String, String, String)

• tags actions
• delete /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}
• docs https://docs.github.com/rest/reference/actions#delete-an-environment-secret

Delete an environment secret Deletes a secret in an environment using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.

GetScimV2EnterprisesenterpriseGroups(String)

• tags enterprise-admin
• get /scim/v2/enterprises/{enterprise}/Groups
• docs https://docs.github.com/rest/reference/enterprise-admin#list-provisioned-scim-groups-for-an-enterprise

List provisioned SCIM groups for an enterprise Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.

PostScimV2EnterprisesenterpriseGroups(String)

• tags enterprise-admin
• post /scim/v2/enterprises/{enterprise}/Groups
• docs https://docs.github.com/rest/reference/enterprise-admin#provision-a-scim-enterprise-group-and-invite-users

Provision a SCIM enterprise group and invite users Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.

Provision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to.

GetScimV2EnterprisesenterpriseGroupsscimGroupId(String, String)

• tags enterprise-admin
• get /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}
• docs https://docs.github.com/rest/reference/enterprise-admin#get-scim-provisioning-information-for-an-enterprise-group

Get SCIM provisioning information for an enterprise group Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.

PutScimV2EnterprisesenterpriseGroupsscimGroupId(String, String)

• tags enterprise-admin
• put /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}
• docs https://docs.github.com/rest/reference/enterprise-admin#set-scim-information-for-a-provisioned-enterprise-group

Set SCIM information for a provisioned enterprise group Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.

Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don’t provide will be removed, including group membership. If you want to only update a specific attribute, use the Update an attribute for a SCIM enterprise group endpoint instead.

PatchScimV2EnterprisesenterpriseGroupsscimGroupId(String, String)

• tags enterprise-admin
• patch /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}
• docs https://docs.github.com/rest/reference/enterprise-admin#update-an-attribute-for-a-scim-enterprise-group

Update an attribute for a SCIM enterprise group Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.

Allows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.

DeleteScimV2EnterprisesenterpriseGroupsscimGroupId(String, String)

• tags enterprise-admin
• delete /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}
• docs https://docs.github.com/rest/reference/enterprise-admin#delete-a-scim-group-from-an-enterprise

Delete a SCIM group from an enterprise Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.

GetScimV2EnterprisesenterpriseUsers(String)

• tags enterprise-admin
• get /scim/v2/enterprises/{enterprise}/Users
• docs https://docs.github.com/rest/reference/enterprise-admin#list-scim-provisioned-identities-for-an-enterprise

List SCIM provisioned identities for an enterprise Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.

Retrieves a paginated list of all provisioned enterprise members, including pending invitations.

When a user with a SAML-provisioned external identity leaves (or is removed from) an enterprise, the account’s metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub. This can happen in certain cases where an external identity associated with an organization will not match an organization member:

• When a user with a SCIM-provisioned external identity is removed from an enterprise, the account’s metadata is preserved to allow the user to re-join the organization in the future.
• When inviting a user to join an organization, you can expect to see their external identity in the results before they accept the invitation, or if the invitation is cancelled (or never accepted).
• When a user is invited over SCIM, an external identity is created that matches with the invitee’s email address. However, this identity is only linked to a user account when the user accepts the invitation by going through SAML SSO.

The returned list of external identities can include an entry for a null user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub account after completing SSO:

1. The user is granted access by the IdP and is not a member of the GitHub enterprise.

2. The user attempts to access the GitHub enterprise and initiates the SAML SSO process, and is not currently signed in to their GitHub account.

3. After successfully authenticating with the SAML SSO IdP, the null external identity entry is created and the user is prompted to sign in to their GitHub account:

   • If the user signs in, their GitHub account is linked to this entry.
   • If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub enterprise, and the external identity null entry remains in place.

PostScimV2EnterprisesenterpriseUsers(String)

• tags enterprise-admin
• post /scim/v2/enterprises/{enterprise}/Users
• docs https://docs.github.com/rest/reference/enterprise-admin#provision-and-invite-a-scim-enterprise-user

Provision and invite a SCIM enterprise user Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.

Provision enterprise membership for a user, and send organization invitation emails to the email address.

You can optionally include the groups a user will be invited to join. If you do not provide a list of groups, the user is provisioned for the enterprise, but no organization invitation emails will be sent.

GetScimV2EnterprisesenterpriseUsersscimUserId(String, String)

• tags enterprise-admin
• get /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}
• docs https://docs.github.com/rest/reference/enterprise-admin#get-scim-provisioning-information-for-an-enterprise-user

Get SCIM provisioning information for an enterprise user Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.

PutScimV2EnterprisesenterpriseUsersscimUserId(String, String)

• tags enterprise-admin
• put /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}
• docs https://docs.github.com/rest/reference/enterprise-admin#set-scim-information-for-a-provisioned-enterprise-user

Set SCIM information for a provisioned enterprise user Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.

Replaces an existing provisioned user’s information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don’t provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.

You must at least provide the required values for the user: userName, name, and emails.

Warning: Setting active: false removes the user from the enterprise, deletes the external identity, and deletes the associated {scim_user_id}.

PatchScimV2EnterprisesenterpriseUsersscimUserId(String, String)

• tags enterprise-admin
• patch /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}
• docs https://docs.github.com/rest/reference/enterprise-admin#update-an-attribute-for-a-scim-enterprise-user

Update an attribute for a SCIM enterprise user Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.

Allows you to change a provisioned user’s individual attributes. To change a user’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.

Note: Complicated SCIM path selectors that include filters are not supported. For example, a path selector defined as "path": "emails[type eq \"work\"]" will not work.

Warning: If you set active:false using the replace operation (as shown in the JSON example below), it removes the user from the enterprise, deletes the external identity, and deletes the associated :scim_user_id.

{
  "Operations":[{
    "op":"replace",
    "value":{
      "active":false
    }
  }]
}

DeleteScimV2EnterprisesenterpriseUsersscimUserId(String, String)

• tags enterprise-admin
• delete /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}
• docs https://docs.github.com/rest/reference/enterprise-admin#delete-a-scim-user-from-an-enterprise

Delete a SCIM user from an enterprise Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.

GetScimV2OrganizationsorgUsers(String)

• tags scim
• get /scim/v2/organizations/{org}/Users
• docs https://docs.github.com/rest/reference/scim#list-scim-provisioned-identities

List SCIM provisioned identities Retrieves a paginated list of all provisioned organization members, including pending invitations. If you provide the filter parameter, the resources for all matching provisions members are returned.

When a user with a SAML-provisioned external identity leaves (or is removed from) an organization, the account’s metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub. This can happen in certain cases where an external identity associated with an organization will not match an organization member:

• When a user with a SCIM-provisioned external identity is removed from an organization, the account’s metadata is preserved to allow the user to re-join the organization in the future.
• When inviting a user to join an organization, you can expect to see their external identity in the results before they accept the invitation, or if the invitation is cancelled (or never accepted).
• When a user is invited over SCIM, an external identity is created that matches with the invitee’s email address. However, this identity is only linked to a user account when the user accepts the invitation by going through SAML SSO.

The returned list of external identities can include an entry for a null user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub account after completing SSO:

1. The user is granted access by the IdP and is not a member of the GitHub organization.

2. The user attempts to access the GitHub organization and initiates the SAML SSO process, and is not currently signed in to their GitHub account.

3. After successfully authenticating with the SAML SSO IdP, the null external identity entry is created and the user is prompted to sign in to their GitHub account:

   • If the user signs in, their GitHub account is linked to this entry.
   • If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub organization, and the external identity null entry remains in place.

PostScimV2OrganizationsorgUsers(String)

• tags scim
• post /scim/v2/organizations/{org}/Users
• docs https://docs.github.com/rest/reference/scim#provision-and-invite-a-scim-user

Provision and invite a SCIM user Provision organization membership for a user, and send an activation email to the email address.

GetScimV2OrganizationsorgUsersscimUserId(String, String)

• tags scim
• get /scim/v2/organizations/{org}/Users/{scim_user_id}
• docs https://docs.github.com/rest/reference/scim#get-scim-provisioning-information-for-a-user

Get SCIM provisioning information for a user

PutScimV2OrganizationsorgUsersscimUserId(String, String)

• tags scim
• put /scim/v2/organizations/{org}/Users/{scim_user_id}
• docs https://docs.github.com/rest/reference/scim#set-scim-information-for-a-provisioned-user

Update a provisioned organization membership Replaces an existing provisioned user’s information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don’t provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.

You must at least provide the required values for the user: userName, name, and emails.

Warning: Setting active: false removes the user from the organization, deletes the external identity, and deletes the associated {scim_user_id}.

PatchScimV2OrganizationsorgUsersscimUserId(String, String)

• tags scim
• patch /scim/v2/organizations/{org}/Users/{scim_user_id}
• docs https://docs.github.com/rest/reference/scim#update-an-attribute-for-a-scim-user

Update an attribute for a SCIM user Allows you to change a provisioned user’s individual attributes. To change a user’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.

Note: Complicated SCIM path selectors that include filters are not supported. For example, a path selector defined as "path": "emails[type eq \"work\"]" will not work.

Warning: If you set active:false using the replace operation (as shown in the JSON example below), it removes the user from the organization, deletes the external identity, and deletes the associated :scim_user_id.

{
  "Operations":[{
    "op":"replace",
    "value":{
      "active":false
    }
  }]
}

DeleteScimV2OrganizationsorgUsersscimUserId(String, String)

• tags scim
• delete /scim/v2/organizations/{org}/Users/{scim_user_id}
• docs https://docs.github.com/rest/reference/scim#delete-a-scim-user-from-an-organization

Delete a SCIM user from an organization

GetSearchCode()

• tags search
• get /search/code
• docs https://docs.github.com/rest/reference/search#search-code

Search code Searches for query terms inside of a file. This method returns up to 100 results per page.

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

q=addClass+in:file+language:js+repo:jquery/jquery

This query searches for the keyword addClass within a file’s contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

Considerations for code search

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

• Only the default branch is considered. In most cases, this will be the master branch.
• Only files smaller than 384 KB are searchable.
• You must always include at least one search term when searching source code. For example, searching for language:go is not valid, while amazing language:go is.

GetSearchCommits()

• tags search
• get /search/commits
• docs https://docs.github.com/rest/reference/search#search-commits

Search commits Find commits via various criteria on the default branch (usually master). This method returns up to 100 results per page.

When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

For example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:

q=repo:octocat/Spoon-Knife+css

GetSearchIssues()

• tags search
• get /search/issues
• docs https://docs.github.com/rest/reference/search#search-issues-and-pull-requests

Search issues and pull requests Find issues by state and keyword. This method returns up to 100 results per page.

When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

q=windows+label:bug+language:python+state:open&sort=created&order=asc

This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

Note: For user-to-server GitHub App requests, you can’t retrieve a combination of issues and pull requests in a single query. Requests that don’t include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see “Searching only issues or pull requests.”

GetSearchLabels()

• tags search
• get /search/labels
• docs https://docs.github.com/rest/reference/search#search-labels

Search labels Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page.

When searching for labels, you can get text match metadata for the label name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

For example, if you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:

q=bug+defect+enhancement&repository_id=64778136

The labels that best match the query appear first in the search results.

GetSearchRepositories()

• tags search
• get /search/repositories
• docs https://docs.github.com/rest/reference/search#search-repositories

Search repositories Find repositories via various criteria. This method returns up to 100 results per page.

When searching for repositories, you can get text match metadata for the name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:

q=tetris+language:assembly&sort=stars&order=desc

This query searches for repositories with the word tetris in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.

GetSearchTopics()

• tags search
• get /search/topics
• docs https://docs.github.com/rest/reference/search#search-topics

Search topics Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. See “Searching topics” for a detailed list of qualifiers.

When searching for topics, you can get text match metadata for the topic’s short_description, description, name, or display_name field when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:

q=ruby+is:featured

This query searches for topics with the keyword ruby and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.

GetSearchUsers()

• tags search
• get /search/users
• docs https://docs.github.com/rest/reference/search#search-users

Search users Find users via various criteria. This method returns up to 100 results per page.

When searching for users, you can get text match metadata for the issue login, email, and name fields when you pass the text-match media type. For more details about highlighting search results, see Text match metadata. For more details about how to receive highlighted search results, see Text match metadata.

For example, if you’re looking for a list of popular users, you might try this query:

q=tom+repos:%3E42+followers:%3E1000

This query searches for users with the name tom. The results are restricted to users with more than 42 repositories and over 1,000 followers.

GetTeamsteamId(String)

• tags teams
• get /teams/{team_id}
• docs https://docs.github.com/rest/reference/teams/#get-a-team-legacy

Get a team (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.

PatchTeamsteamId(String)

• tags teams
• patch /teams/{team_id}
• docs https://docs.github.com/rest/reference/teams/#update-a-team-legacy

Update a team (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.

To edit a team, the authenticated user must either be an organization owner or a team maintainer.

Note: With nested teams, the privacy for parent teams cannot be secret.

DeleteTeamsteamId(String)

• tags teams
• delete /teams/{team_id}
• docs https://docs.github.com/rest/reference/teams/#delete-a-team-legacy

Delete a team (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a team endpoint.

To delete a team, the authenticated user must be an organization owner or team maintainer.

If you are an organization owner, deleting a parent team will delete all of its child teams as well.

GetTeamsteamIdDiscussions(String)

• tags teams
• get /teams/{team_id}/discussions
• docs https://docs.github.com/rest/reference/teams#list-discussions-legacy

List discussions (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.

List all discussions on a team’s page. OAuth access tokens require the read:discussion scope.

PostTeamsteamIdDiscussions(String)

• tags teams
• post /teams/{team_id}/discussions
• docs https://docs.github.com/rest/reference/teams#create-a-discussion-legacy

Create a discussion (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.

Creates a new discussion post on a team’s page. OAuth access tokens require the write:discussion scope.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.

GetTeamsteamIdDiscussionsdiscussionNumber(String, String)

• tags teams
• get /teams/{team_id}/discussions/{discussion_number}
• docs https://docs.github.com/rest/reference/teams#get-a-discussion-legacy

Get a discussion (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.

Get a specific discussion on a team’s page. OAuth access tokens require the read:discussion scope.

PatchTeamsteamIdDiscussionsdiscussionNumber(String, String)

• tags teams
• patch /teams/{team_id}/discussions/{discussion_number}
• docs https://docs.github.com/rest/reference/teams#update-a-discussion-legacy

Update a discussion (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.

Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.

DeleteTeamsteamIdDiscussionsdiscussionNumber(String, String)

• tags teams
• delete /teams/{team_id}/discussions/{discussion_number}
• docs https://docs.github.com/rest/reference/teams#delete-a-discussion-legacy

Delete a discussion (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.

Delete a discussion from a team’s page. OAuth access tokens require the write:discussion scope.

GetTeamsteamIdDiscussionsdiscussionNumberComments(String, String)

• tags teams
• get /teams/{team_id}/discussions/{discussion_number}/comments
• docs https://docs.github.com/rest/reference/teams#list-discussion-comments-legacy

List discussion comments (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.

List all comments on a team discussion. OAuth access tokens require the read:discussion scope.

PostTeamsteamIdDiscussionsdiscussionNumberComments(String, String)

• tags teams
• post /teams/{team_id}/discussions/{discussion_number}/comments
• docs https://docs.github.com/rest/reference/teams#create-a-discussion-comment-legacy

Create a discussion comment (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.

GetTeamsteamIdDiscussionsdiscussionNumberCommentscommentNumber(String, String, String)

• tags teams
• get /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}
• docs https://docs.github.com/rest/reference/teams#get-a-discussion-comment-legacy

Get a discussion comment (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.

Get a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.

PatchTeamsteamIdDiscussionsdiscussionNumberCommentscommentNumber(String, String, String)

• tags teams
• patch /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}
• docs https://docs.github.com/rest/reference/teams#update-a-discussion-comment-legacy

Update a discussion comment (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.

Edits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.

DeleteTeamsteamIdDiscussionsdiscussionNumberCommentscommentNumber(String, String, String)

• tags teams
• delete /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}
• docs https://docs.github.com/rest/reference/teams#delete-a-discussion-comment-legacy

Delete a discussion comment (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.

Deletes a comment on a team discussion. OAuth access tokens require the write:discussion scope.

GetTeamsteamIdDiscussionsdiscussionNumberCommentscommentNumberReactions(String, String, String)

• tags reactions
• get /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions
• docs https://docs.github.com/rest/reference/reactions/#list-reactions-for-a-team-discussion-comment-legacy

List reactions for a team discussion comment (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.

List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.

PostTeamsteamIdDiscussionsdiscussionNumberCommentscommentNumberReactions(String, String, String)

• tags reactions
• post /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions
• docs https://docs.github.com/rest/reference/reactions/#create-reaction-for-a-team-discussion-comment-legacy

Create reaction for a team discussion comment (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new “Create reaction for a team discussion comment” endpoint.

Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.

GetTeamsteamIdDiscussionsdiscussionNumberReactions(String, String)

• tags reactions
• get /teams/{team_id}/discussions/{discussion_number}/reactions
• docs https://docs.github.com/rest/reference/reactions/#list-reactions-for-a-team-discussion-legacy

List reactions for a team discussion (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.

List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.

PostTeamsteamIdDiscussionsdiscussionNumberReactions(String, String)

• tags reactions
• post /teams/{team_id}/discussions/{discussion_number}/reactions
• docs https://docs.github.com/rest/reference/reactions/#create-reaction-for-a-team-discussion-legacy

Create reaction for a team discussion (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.

Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.

GetTeamsteamIdInvitations(String)

• tags teams
• get /teams/{team_id}/invitations
• docs https://docs.github.com/rest/reference/teams#list-pending-team-invitations-legacy

List pending team invitations (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List pending team invitations endpoint.

The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.

GetTeamsteamIdMembers(String)

• tags teams
• get /teams/{team_id}/members
• docs https://docs.github.com/rest/reference/teams#list-team-members-legacy

List team members (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.

Team members will include the members of child teams.

GetTeamsteamIdMembersusername(String, String)

• tags teams
• get /teams/{team_id}/members/{username}
• docs https://docs.github.com/rest/reference/teams#get-team-member-legacy

Get team member (Legacy) The “Get team member” endpoint (described below) is deprecated.

We recommend using the Get team membership for a user endpoint instead. It allows you to get both active and pending memberships.

To list members in a team, the team must be visible to the authenticated user.

PutTeamsteamIdMembersusername(String, String)

• tags teams
• put /teams/{team_id}/members/{username}
• docs https://docs.github.com/rest/reference/teams#add-team-member-legacy

Add team member (Legacy) The “Add team member” endpoint (described below) is deprecated.

We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.

To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they’re changing. The person being added to the team must be a member of the team’s organization.

Note: When you have team synchronization set up for a team with your organization’s identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team’s membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see “Synchronizing teams between your identity provider and GitHub.”

Note that you’ll need to set Content-Length to zero when calling out to this endpoint. For more information, see “HTTP verbs.”

DeleteTeamsteamIdMembersusername(String, String)

• tags teams
• delete /teams/{team_id}/members/{username}
• docs https://docs.github.com/rest/reference/teams#remove-team-member-legacy

Remove team member (Legacy) The “Remove team member” endpoint (described below) is deprecated.

We recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.

To remove a team member, the authenticated user must have ‘admin’ permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.

Note: When you have team synchronization set up for a team with your organization’s identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team’s membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see “Synchronizing teams between your identity provider and GitHub.”

GetTeamsteamIdMembershipsusername(String, String)

• tags teams
• get /teams/{team_id}/memberships/{username}
• docs https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user-legacy

Get team membership for a user (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.

Team members will include the members of child teams.

To get a user’s membership with a team, the team must be visible to the authenticated user.

Note: The response contains the state of the membership and the member’s role.

The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.

PutTeamsteamIdMembershipsusername(String, String)

• tags teams
• put /teams/{team_id}/memberships/{username}
• docs https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user-legacy

Add or update team membership for a user (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.

If the user is already a member of the team’s organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.

Note: When you have team synchronization set up for a team with your organization’s identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team’s membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see “Synchronizing teams between your identity provider and GitHub.”

If the user is unaffiliated with the team’s organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the “pending” state until the user accepts the invitation, at which point the membership will transition to the “active” state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.

If the user is already a member of the team, this endpoint will update the role of the team member’s role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.

DeleteTeamsteamIdMembershipsusername(String, String)

• tags teams
• delete /teams/{team_id}/memberships/{username}
• docs https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user-legacy

Remove team membership for a user (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.

To remove a membership between a user and a team, the authenticated user must have ‘admin’ permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

Note: When you have team synchronization set up for a team with your organization’s identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team’s membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see “Synchronizing teams between your identity provider and GitHub.”

GetTeamsteamIdProjects(String)

• tags teams
• get /teams/{team_id}/projects
• docs https://docs.github.com/rest/reference/teams/#list-team-projects-legacy

List team projects (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team projects endpoint.

Lists the organization projects for a team.

GetTeamsteamIdProjectsprojectId(String, String)

• tags teams
• get /teams/{team_id}/projects/{project_id}
• docs https://docs.github.com/rest/reference/teams/#check-team-permissions-for-a-project-legacy

Check team permissions for a project (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a project endpoint.

Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.

PutTeamsteamIdProjectsprojectId(String, String)

• tags teams
• put /teams/{team_id}/projects/{project_id}
• docs https://docs.github.com/rest/reference/teams/#add-or-update-team-project-permissions-legacy

Add or update team project permissions (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team project permissions endpoint.

Adds an organization project to a team. To add a project to a team or update the team’s permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.

DeleteTeamsteamIdProjectsprojectId(String, String)

• tags teams
• delete /teams/{team_id}/projects/{project_id}
• docs https://docs.github.com/rest/reference/teams/#remove-a-project-from-a-team-legacy

Remove a project from a team (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a project from a team endpoint.

Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. Note: This endpoint removes the project from the team, but does not delete it.

GetTeamsteamIdRepos(String)

• tags teams
• get /teams/{team_id}/repos
• docs https://docs.github.com/rest/reference/teams/#list-team-repositories-legacy

List team repositories (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.

GetTeamsteamIdReposownerrepo(String, String, String)

• tags teams
• get /teams/{team_id}/repos/{owner}/{repo}
• docs https://docs.github.com/rest/reference/teams/#check-team-permissions-for-a-repository-legacy

Check team permissions for a repository (Legacy) Note: Repositories inherited through a parent team will also be checked.

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a repository endpoint.

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:

PutTeamsteamIdReposownerrepo(String, String, String)

• tags teams
• put /teams/{team_id}/repos/{owner}/{repo}
• docs https://docs.github.com/rest/reference/teams/#add-or-update-team-repository-permissions-legacy

Add or update team repository permissions (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new “Add or update team repository permissions” endpoint.

To add a repository to a team or update the team’s permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.

Note that, if you choose not to pass any parameters, you’ll need to set Content-Length to zero when calling out to this endpoint. For more information, see “HTTP verbs.”

DeleteTeamsteamIdReposownerrepo(String, String, String)

• tags teams
• delete /teams/{team_id}/repos/{owner}/{repo}
• docs https://docs.github.com/rest/reference/teams/#remove-a-repository-from-a-team-legacy

Remove a repository from a team (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.

If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.

GetTeamsteamIdTeamSyncGroupMappings(String)

• tags teams
• get /teams/{team_id}/team-sync/group-mappings
• docs https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team-legacy

List IdP groups for a team (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List IdP groups for a team endpoint.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.

List IdP groups connected to a team on GitHub.

PatchTeamsteamIdTeamSyncGroupMappings(String)

• tags teams
• patch /teams/{team_id}/team-sync/group-mappings
• docs https://docs.github.com/rest/reference/teams#create-or-update-idp-group-connections-legacy

Create or update IdP group connections (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create or update IdP group connections endpoint.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.

Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty groups array will remove all connections for a team.

GetTeamsteamIdTeams(String)

• tags teams
• get /teams/{team_id}/teams
• docs https://docs.github.com/rest/reference/teams/#list-child-teams-legacy

List child teams (Legacy) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.

GetUser()

• tags users
• get /user
• docs https://docs.github.com/rest/reference/users#get-the-authenticated-user

Get the authenticated user If the authenticated user is authenticated through basic authentication or OAuth with the user scope, then the response lists public and private profile information.

If the authenticated user is authenticated through OAuth without the user scope, then the response lists only public profile information.

PatchUser()

• tags users
• patch /user
• docs https://docs.github.com/rest/reference/users/#update-the-authenticated-user

Update the authenticated user Note: If your email is set to private and you send an email parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.

GetUserBlocks()

• tags users
• get /user/blocks
• docs https://docs.github.com/rest/reference/users#list-users-blocked-by-the-authenticated-user

List users blocked by the authenticated user List the users you’ve blocked on your personal account.

GetUserBlocksusername(String)

• tags users
• get /user/blocks/{username}
• docs https://docs.github.com/rest/reference/users#check-if-a-user-is-blocked-by-the-authenticated-user

Check if a user is blocked by the authenticated user

PutUserBlocksusername(String)

• tags users
• put /user/blocks/{username}
• docs https://docs.github.com/rest/reference/users#block-a-user

Block a user

DeleteUserBlocksusername(String)

• tags users
• delete /user/blocks/{username}
• docs https://docs.github.com/rest/reference/users#unblock-a-user

Unblock a user

GetUserCodespaces()

• tags codespaces
• get /user/codespaces
• docs https://docs.github.com/rest/reference/codespaces#list-codespaces-for-the-authenticated-user

List codespaces for the authenticated user Lists the authenticated user’s codespaces.

You must authenticate using an access token with the codespace scope to use this endpoint.

PostUserCodespaces()

• tags codespaces
• post /user/codespaces
• docs https://docs.github.com/rest/reference/codespaces#create-a-codespace-for-the-authenticated-user

Create a codespace for the authenticated user Creates a new codespace, owned by the authenticated user.

This endpoint requires either a repository_id OR a pull_request but not both.

You must authenticate using an access token with the codespace scope to use this endpoint.

GetUserCodespacesSecrets()

• tags codespaces
• get /user/codespaces/secrets
• docs https://docs.github.com/rest/reference/codespaces#list-secrets-for-the-authenticated-user

List secrets for the authenticated user Lists all secrets available for a user’s Codespaces without revealing their encrypted values. You must authenticate using an access token with the user or read:user scope to use this endpoint. User must have Codespaces access to use this endpoint.

GetUserCodespacesSecretsPublicKey()

• tags codespaces
• get /user/codespaces/secrets/public-key
• docs https://docs.github.com/rest/reference/codespaces#get-public-key-for-the-authenticated-user

Get public key for the authenticated user Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with one of the ‘read:user’ or ‘user’ scopes in their personal access token. User must have Codespaces access to use this endpoint.

GetUserCodespacesSecretssecretName(String)

• tags codespaces
• get /user/codespaces/secrets/{secret_name}
• docs https://docs.github.com/rest/reference/codespaces#get-a-secret-for-the-authenticated-user

Get a secret for the authenticated user Gets a secret available to a user’s codespaces without revealing its encrypted value. You must authenticate using an access token with the user or read:user scope to use this endpoint. User must have Codespaces access to use this endpoint.

PutUserCodespacesSecretssecretName(String)

• tags codespaces
• put /user/codespaces/secrets/{secret_name}
• docs https://docs.github.com/rest/reference/codespaces#create-or-update-a-secret-for-the-authenticated-user

Create or update a secret for the authenticated user Creates or updates a secret for a user’s codespace with an encrypted value. Encrypt your secret using LibSodium. You must authenticate using an access token with the user scope to use this endpoint. User must also have Codespaces access to use this endpoint.

Example encrypting a secret using Node.js

Encrypt your secret using the tweetsodium library.

const sodium = require('tweetsodium');

const key = "base64-encoded-public-key";
const value = "plain-text-secret";

// Convert the message and key to Uint8Array's (Buffer implements that interface)
const messageBytes = Buffer.from(value);
const keyBytes = Buffer.from(key, 'base64');

// Encrypt using LibSodium.
const encryptedBytes = sodium.seal(messageBytes, keyBytes);

// Base64 the encrypted secret
const encrypted = Buffer.from(encryptedBytes).toString('base64');

console.log(encrypted);

Example encrypting a secret using Python

Encrypt your secret using pynacl with Python 3.

from base64 import b64encode
from nacl import encoding, public

def encrypt(public_key: str, secret_value: str) -> str:
  """Encrypt a Unicode string using the public key."""
  public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
  sealed_box = public.SealedBox(public_key)
  encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
  return b64encode(encrypted).decode("utf-8")

Example encrypting a secret using C#

Encrypt your secret using the Sodium.Core package.

var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");

var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);

Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));

Example encrypting a secret using Ruby

Encrypt your secret using the rbnacl gem.

require "rbnacl"
require "base64"

key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
public_key = RbNaCl::PublicKey.new(key)

box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
encrypted_secret = box.encrypt("my_secret")

# Print the base64 encoded secret
puts Base64.strict_encode64(encrypted_secret)

DeleteUserCodespacesSecretssecretName(String)

• tags codespaces
• delete /user/codespaces/secrets/{secret_name}
• docs https://docs.github.com/rest/reference/codespaces#delete-a-secret-for-the-authenticated-user

Delete a secret for the authenticated user Deletes a secret from a user’s codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. You must authenticate using an access token with the user scope to use this endpoint. User must have Codespaces access to use this endpoint.

GetUserCodespacesSecretssecretNameRepositories(String)

• tags codespaces
• get /user/codespaces/secrets/{secret_name}/repositories
• docs https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret

List selected repositories for a user secret List the repositories that have been granted the ability to use a user’s codespace secret. You must authenticate using an access token with the user or read:user scope to use this endpoint. User must have Codespaces access to use this endpoint.

PutUserCodespacesSecretssecretNameRepositories(String)

• tags codespaces
• put /user/codespaces/secrets/{secret_name}/repositories
• docs https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-a-user-secret

Set selected repositories for a user secret Select the repositories that will use a user’s codespace secret. You must authenticate using an access token with the user or read:user scope to use this endpoint. User must have Codespaces access to use this endpoint.

PutUserCodespacesSecretssecretNameRepositoriesrepositoryId(String, String)

• tags codespaces
• put /user/codespaces/secrets/{secret_name}/repositories/{repository_id}
• docs https://docs.github.com/rest/reference/codespaces#add-a-selected-repository-to-a-user-secret

Add a selected repository to a user secret Adds a repository to the selected repositories for a user’s codespace secret. You must authenticate using an access token with the user or read:user scope to use this endpoint. User must have Codespaces access to use this endpoint.

DeleteUserCodespacesSecretssecretNameRepositoriesrepositoryId(String, String)

• tags codespaces
• delete /user/codespaces/secrets/{secret_name}/repositories/{repository_id}
• docs https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret

Remove a selected repository from a user secret Removes a repository from the selected repositories for a user’s codespace secret. You must authenticate using an access token with the user or read:user scope to use this endpoint. User must have Codespaces access to use this endpoint.

GetUserCodespacescodespaceName(String)

• tags codespaces
• get /user/codespaces/{codespace_name}
• docs https://docs.github.com/rest/reference/codespaces#get-a-codespace-for-the-authenticated-user

Get a codespace for the authenticated user Gets information about a user’s codespace.

You must authenticate using an access token with the codespace scope to use this endpoint.

PatchUserCodespacescodespaceName(String)

• tags codespaces
• patch /user/codespaces/{codespace_name}
• docs https://docs.github.com/rest/reference/codespaces#update-a-codespace-for-the-authenticated-user

Update a codespace for the authenticated user Updates a codespace owned by the authenticated user. Currently only the codespace’s machine type and recent folders can be modified using this endpoint.

If you specify a new machine type it will be applied the next time your codespace is started.

You must authenticate using an access token with the codespace scope to use this endpoint.

DeleteUserCodespacescodespaceName(String)

• tags codespaces
• delete /user/codespaces/{codespace_name}
• docs https://docs.github.com/rest/reference/codespaces#delete-a-codespace-for-the-authenticated-user

Delete a codespace for the authenticated user Deletes a user’s codespace.

You must authenticate using an access token with the codespace scope to use this endpoint.

PostUserCodespacescodespaceNameExports(String)

• tags codespaces
• post /user/codespaces/{codespace_name}/exports

Export a codespace for the authenticated user Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.

You must authenticate using a personal access token with the codespace scope to use this endpoint.

GetUserCodespacescodespaceNameExportsexportId(String, String)

• tags codespaces
• get /user/codespaces/{codespace_name}/exports/{export_id}

Get details about a codespace export Gets information about an export of a codespace.

You must authenticate using a personal access token with the codespace scope to use this endpoint.

GetUserCodespacescodespaceNameMachines(String)

• tags codespaces
• get /user/codespaces/{codespace_name}/machines
• docs https://docs.github.com/rest/reference/codespaces#list-machine-types-for-a-codespace

List machine types for a codespace List the machine types a codespace can transition to use.

You must authenticate using an access token with the codespace scope to use this endpoint.

PostUserCodespacescodespaceNameStart(String)

• tags codespaces
• post /user/codespaces/{codespace_name}/start
• docs https://docs.github.com/rest/reference/codespaces#start-a-codespace-for-the-authenticated-user

Start a codespace for the authenticated user Starts a user’s codespace.

You must authenticate using an access token with the codespace scope to use this endpoint.

PostUserCodespacescodespaceNameStop(String)

• tags codespaces
• post /user/codespaces/{codespace_name}/stop
• docs https://docs.github.com/rest/reference/codespaces#stop-a-codespace-for-the-authenticated-user

Stop a codespace for the authenticated user Stops a user’s codespace.

You must authenticate using an access token with the codespace scope to use this endpoint.

PatchUserEmailVisibility()

• tags users
• patch /user/email/visibility
• docs https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user

Set primary email visibility for the authenticated user Sets the visibility for your primary email addresses.

GetUserEmails()

• tags users
• get /user/emails
• docs https://docs.github.com/rest/reference/users#list-email-addresses-for-the-authenticated-user

List email addresses for the authenticated user Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the user:email scope.

PostUserEmails()

• tags users
• post /user/emails
• docs https://docs.github.com/rest/reference/users#add-an-email-address-for-the-authenticated-user

Add an email address for the authenticated user This endpoint is accessible with the user scope.

DeleteUserEmails()

• tags users
• delete /user/emails
• docs https://docs.github.com/rest/reference/users#delete-an-email-address-for-the-authenticated-user

Delete an email address for the authenticated user This endpoint is accessible with the user scope.

GetUserFollowers()

• tags users
• get /user/followers
• docs https://docs.github.com/rest/reference/users#list-followers-of-the-authenticated-user

List followers of the authenticated user Lists the people following the authenticated user.

GetUserFollowing()

• tags users
• get /user/following
• docs https://docs.github.com/rest/reference/users#list-the-people-the-authenticated-user-follows

List the people the authenticated user follows Lists the people who the authenticated user follows.

GetUserFollowingusername(String)

• tags users
• get /user/following/{username}
• docs https://docs.github.com/rest/reference/users#check-if-a-person-is-followed-by-the-authenticated-user

Check if a person is followed by the authenticated user

PutUserFollowingusername(String)

• tags users
• put /user/following/{username}
• docs https://docs.github.com/rest/reference/users#follow-a-user

Follow a user Note that you’ll need to set Content-Length to zero when calling out to this endpoint. For more information, see “HTTP verbs.”

Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.

DeleteUserFollowingusername(String)

• tags users
• delete /user/following/{username}
• docs https://docs.github.com/rest/reference/users#unfollow-a-user

Unfollow a user Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.

GetUserGpgKeys()

• tags users
• get /user/gpg_keys
• docs https://docs.github.com/rest/reference/users#list-gpg-keys-for-the-authenticated-user

List GPG keys for the authenticated user Lists the current user’s GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least read:gpg_key scope.

PostUserGpgKeys()

• tags users
• post /user/gpg_keys
• docs https://docs.github.com/rest/reference/users#create-a-gpg-key-for-the-authenticated-user

Create a GPG key for the authenticated user Adds a GPG key to the authenticated user’s GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least write:gpg_key scope.

GetUserGpgKeysgpgKeyId(String)

• tags users
• get /user/gpg_keys/{gpg_key_id}
• docs https://docs.github.com/rest/reference/users#get-a-gpg-key-for-the-authenticated-user

Get a GPG key for the authenticated user View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least read:gpg_key scope.

DeleteUserGpgKeysgpgKeyId(String)

• tags users
• delete /user/gpg_keys/{gpg_key_id}
• docs https://docs.github.com/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user

Delete a GPG key for the authenticated user Removes a GPG key from the authenticated user’s GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least admin:gpg_key scope.

GetUserInstallations()

• tags apps
• get /user/installations
• docs https://docs.github.com/rest/reference/apps#list-app-installations-accessible-to-the-user-access-token

List app installations accessible to the user access token Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

You can find the permissions for the installation under the permissions key.

GetUserInstallationsinstallationIdRepositories(String)

• tags apps
• get /user/installations/{installation_id}/repositories
• docs https://docs.github.com/rest/reference/apps#list-repositories-accessible-to-the-user-access-token

List repositories accessible to the user access token List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

The access the user has to each repository is included in the hash under the permissions key.

PutUserInstallationsinstallationIdRepositoriesrepositoryId(String, String)

• tags apps
• put /user/installations/{installation_id}/repositories/{repository_id}
• docs https://docs.github.com/rest/reference/apps#add-a-repository-to-an-app-installation

Add a repository to an app installation Add a single repository to an installation. The authenticated user must have admin access to the repository.

You must use a personal access token (which you can create via the command line or Basic Authentication) to access this endpoint.

DeleteUserInstallationsinstallationIdRepositoriesrepositoryId(String, String)

• tags apps
• delete /user/installations/{installation_id}/repositories/{repository_id}
• docs https://docs.github.com/rest/reference/apps#remove-a-repository-from-an-app-installation

Remove a repository from an app installation Remove a single repository from an installation. The authenticated user must have admin access to the repository.

You must use a personal access token (which you can create via the command line or Basic Authentication) to access this endpoint.

GetUserInteractionLimits()

• tags interactions
• get /user/interaction-limits
• docs https://docs.github.com/rest/reference/interactions#get-interaction-restrictions-for-your-public-repositories

Get interaction restrictions for your public repositories Shows which type of GitHub user can interact with your public repositories and when the restriction expires.

PutUserInteractionLimits()

• tags interactions
• put /user/interaction-limits
• docs https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-your-public-repositories

Set interaction restrictions for your public repositories Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.

DeleteUserInteractionLimits()

• tags interactions
• delete /user/interaction-limits
• docs https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-from-your-public-repositories

Remove interaction restrictions from your public repositories Removes any interaction restrictions from your public repositories.

GetUserIssues()

• tags issues
• get /user/issues
• docs https://docs.github.com/rest/reference/issues#list-user-account-issues-assigned-to-the-authenticated-user

List user account issues assigned to the authenticated user List issues across owned and member repositories assigned to the authenticated user.

Note: GitHub’s REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, “Issues” endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from “Issues” endpoints will be an issue id. To find out the pull request id, use the “List pull requests” endpoint.

GetUserKeys()

• tags users
• get /user/keys
• docs https://docs.github.com/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user

List public SSH keys for the authenticated user Lists the public SSH keys for the authenticated user’s GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least read:public_key scope.

PostUserKeys()

• tags users
• post /user/keys
• docs https://docs.github.com/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user

Create a public SSH key for the authenticated user Adds a public SSH key to the authenticated user’s GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least write:public_key scope.

GetUserKeyskeyId(String)

• tags users
• get /user/keys/{key_id}
• docs https://docs.github.com/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user

Get a public SSH key for the authenticated user View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least read:public_key scope.

DeleteUserKeyskeyId(String)

• tags users
• delete /user/keys/{key_id}
• docs https://docs.github.com/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user

Delete a public SSH key for the authenticated user Removes a public SSH key from the authenticated user’s GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least admin:public_key scope.

GetUserMarketplacePurchases()

• tags apps
• get /user/marketplace_purchases
• docs https://docs.github.com/rest/reference/apps#list-subscriptions-for-the-authenticated-user

List subscriptions for the authenticated user Lists the active subscriptions for the authenticated user. You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an OAuth token.

GetUserMarketplacePurchasesStubbed()

• tags apps
• get /user/marketplace_purchases/stubbed
• docs https://docs.github.com/rest/reference/apps#list-subscriptions-for-the-authenticated-user-stubbed

List subscriptions for the authenticated user (stubbed) Lists the active subscriptions for the authenticated user. You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an OAuth token.

GetUserMembershipsOrgs()

• tags orgs
• get /user/memberships/orgs
• docs https://docs.github.com/rest/reference/orgs#list-organization-memberships-for-the-authenticated-user

List organization memberships for the authenticated user

GetUserMembershipsOrgsorg(String)

• tags orgs
• get /user/memberships/orgs/{org}
• docs https://docs.github.com/rest/reference/orgs#get-an-organization-membership-for-the-authenticated-user

Get an organization membership for the authenticated user

PatchUserMembershipsOrgsorg(String)

• tags orgs
• patch /user/memberships/orgs/{org}
• docs https://docs.github.com/rest/reference/orgs#update-an-organization-membership-for-the-authenticated-user

Update an organization membership for the authenticated user

GetUserMigrations()

• tags migrations
• get /user/migrations
• docs https://docs.github.com/rest/reference/migrations#list-user-migrations

List user migrations Lists all migrations a user has started.

PostUserMigrations()

• tags migrations
• post /user/migrations
• docs https://docs.github.com/rest/reference/migrations#start-a-user-migration

Start a user migration Initiates the generation of a user migration archive.

GetUserMigrationsmigrationId(String)

• tags migrations
• get /user/migrations/{migration_id}
• docs https://docs.github.com/rest/reference/migrations#get-a-user-migration-status

Get a user migration status Fetches a single user migration. The response includes the state of the migration, which can be one of the following values:

• pending - the migration hasn’t started yet.
• exporting - the migration is in progress.
• exported - the migration finished successfully.
• failed - the migration failed.

Once the migration has been exported you can download the migration archive.

GetUserMigrationsmigrationIdArchive(String)

• tags migrations
• get /user/migrations/{migration_id}/archive
• docs https://docs.github.com/rest/reference/migrations#download-a-user-migration-archive

Download a user migration archive Fetches the URL to download the migration archive as a tar.gz file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects:

• attachments
• bases
• commit_comments
• issue_comments
• issue_events
• issues
• milestones
• organizations
• projects
• protected_branches
• pull_request_reviews
• pull_requests
• releases
• repositories
• review_comments
• schema
• users

The archive will also contain an attachments directory that includes all attachment files uploaded to GitHub.com and a repositories directory that contains the repository’s Git data.

DeleteUserMigrationsmigrationIdArchive(String)

• tags migrations
• delete /user/migrations/{migration_id}/archive
• docs https://docs.github.com/rest/reference/migrations#delete-a-user-migration-archive

Delete a user migration archive Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the List user migrations and Get a user migration status endpoints, will continue to be available even after an archive is deleted.

DeleteUserMigrationsmigrationIdReposrepoNameLock(String, String)

• tags migrations
• delete /user/migrations/{migration_id}/repos/{repo_name}/lock
• docs https://docs.github.com/rest/reference/migrations#unlock-a-user-repository

Unlock a user repository Unlocks a repository. You can lock repositories when you start a user migration. Once the migration is complete you can unlock each repository to begin using it again or delete the repository if you no longer need the source data. Returns a status of 404 Not Found if the repository is not locked.

GetUserMigrationsmigrationIdRepositories(String)

• tags migrations
• get /user/migrations/{migration_id}/repositories
• docs https://docs.github.com/rest/reference/migrations#list-repositories-for-a-user-migration

List repositories for a user migration Lists all the repositories for this user migration.

GetUserOrgs()

• tags orgs
• get /user/orgs
• docs https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user

List organizations for the authenticated user List organizations for the authenticated user.

OAuth scope requirements

This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope. OAuth requests with insufficient scope receive a 403 Forbidden response.

GetUserPackages()

• tags packages
• get /user/packages
• docs https://docs.github.com/rest/reference/packages#list-packages-for-the-authenticated-user

List packages for the authenticated user’s namespace Lists packages owned by the authenticated user within the user’s namespace.

To use this endpoint, you must authenticate using an access token with the packages:read scope. If package_type is not container, your token must also include the repo scope.

GetUserPackagespackageTypepackageName(String, String)

• tags packages
• get /user/packages/{package_type}/{package_name}
• docs https://docs.github.com/rest/reference/packages#get-a-package-for-the-authenticated-user

Get a package for the authenticated user Gets a specific package for a package owned by the authenticated user.

To use this endpoint, you must authenticate using an access token with the packages:read scope. If package_type is not container, your token must also include the repo scope.

DeleteUserPackagespackageTypepackageName(String, String)

• tags packages
• delete /user/packages/{package_type}/{package_name}
• docs https://docs.github.com/rest/reference/packages#delete-a-package-for-the-authenticated-user

Delete a package for the authenticated user Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

To use this endpoint, you must authenticate using an access token with the packages:read and packages:delete scopes. If package_type is not container, your token must also include the repo scope.

PostUserPackagespackageTypepackageNameRestore(String, String)

• tags packages
• post /user/packages/{package_type}/{package_name}/restore
• docs https://docs.github.com/rest/reference/packages#restore-a-package-for-the-authenticated-user

Restore a package for the authenticated user Restores a package owned by the authenticated user.

You can restore a deleted package under the following conditions:

• The package was deleted within the last 30 days.
• The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package’s namespace first.

To use this endpoint, you must authenticate using an access token with the packages:read and packages:write scopes. If package_type is not container, your token must also include the repo scope.

GetUserPackagespackageTypepackageNameVersions(String, String)

• tags packages
• get /user/packages/{package_type}/{package_name}/versions
• docs https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user

Get all package versions for a package owned by the authenticated user Returns all package versions for a package owned by the authenticated user.

To use this endpoint, you must authenticate using an access token with the packages:read scope. If package_type is not container, your token must also include the repo scope.

GetUserPackagespackageTypepackageNameVersionspackageVersionId(String, String, String)

• tags packages
• get /user/packages/{package_type}/{package_name}/versions/{package_version_id}
• docs https://docs.github.com/rest/reference/packages#get-a-package-version-for-the-authenticated-user

Get a package version for the authenticated user Gets a specific package version for a package owned by the authenticated user.

To use this endpoint, you must authenticate using an access token with the packages:read scope. If package_type is not container, your token must also include the repo scope.

DeleteUserPackagespackageTypepackageNameVersionspackageVersionId(String, String, String)

• tags packages
• delete /user/packages/{package_type}/{package_name}/versions/{package_version_id}
• docs https://docs.github.com/rest/reference/packages#delete-a-package-version-for-the-authenticated-user

Delete a package version for the authenticated user Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the packages:read and packages:delete scopes. If package_type is not container, your token must also include the repo scope.

PostUserPackagespackageTypepackageNameVersionspackageVersionIdRestore(String, String, String)

• tags packages
• post /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore
• docs https://docs.github.com/rest/reference/packages#restore-a-package-version-for-the-authenticated-user

Restore a package version for the authenticated user Restores a package version owned by the authenticated user.

You can restore a deleted package version under the following conditions:

• The package was deleted within the last 30 days.
• The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package’s namespace first.

To use this endpoint, you must authenticate using an access token with the packages:read and packages:write scopes. If package_type is not container, your token must also include the repo scope.

PostUserProjects()

• tags projects
• post /user/projects
• docs https://docs.github.com/rest/reference/projects#create-a-user-project

Create a user project

GetUserPublicEmails()

• tags users
• get /user/public_emails
• docs https://docs.github.com/rest/reference/users#list-public-email-addresses-for-the-authenticated-user

List public email addresses for the authenticated user Lists your publicly visible email address, which you can set with the Set primary email visibility for the authenticated user endpoint. This endpoint is accessible with the user:email scope.

GetUserRepos()

• tags repos
• get /user/repos
• docs https://docs.github.com/rest/reference/repos#list-repositories-for-the-authenticated-user

List repositories for the authenticated user Lists repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access.

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

PostUserRepos()

• tags repos
• post /user/repos
• docs https://docs.github.com/rest/reference/repos#create-a-repository-for-the-authenticated-user

Create a repository for the authenticated user Creates a new repository for the authenticated user.

OAuth scope requirements

When using OAuth, authorizations must include:

• public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
• repo scope to create a private repository.

GetUserRepositoryInvitations()

• tags repos
• get /user/repository_invitations
• docs https://docs.github.com/rest/reference/repos#list-repository-invitations-for-the-authenticated-user

List repository invitations for the authenticated user When authenticating as a user, this endpoint will list all currently open repository invitations for that user.

PatchUserRepositoryInvitationsinvitationId(String)

• tags repos
• patch /user/repository_invitations/{invitation_id}
• docs https://docs.github.com/rest/reference/repos#accept-a-repository-invitation

Accept a repository invitation

DeleteUserRepositoryInvitationsinvitationId(String)

• tags repos
• delete /user/repository_invitations/{invitation_id}
• docs https://docs.github.com/rest/reference/repos#decline-a-repository-invitation

Decline a repository invitation

GetUserStarred()

• tags activity
• get /user/starred
• docs https://docs.github.com/rest/reference/activity#list-repositories-starred-by-the-authenticated-user

List repositories starred by the authenticated user Lists repositories the authenticated user has starred.

You can also find out when stars were created by passing the following custom media type via the Accept header:

GetUserStarredownerrepo(String, String)

• tags activity
• get /user/starred/{owner}/{repo}
• docs https://docs.github.com/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user

Check if a repository is starred by the authenticated user

PutUserStarredownerrepo(String, String)

• tags activity
• put /user/starred/{owner}/{repo}
• docs https://docs.github.com/rest/reference/activity#star-a-repository-for-the-authenticated-user

Star a repository for the authenticated user Note that you’ll need to set Content-Length to zero when calling out to this endpoint. For more information, see “HTTP verbs.”

DeleteUserStarredownerrepo(String, String)

• tags activity
• delete /user/starred/{owner}/{repo}
• docs https://docs.github.com/rest/reference/activity#unstar-a-repository-for-the-authenticated-user

Unstar a repository for the authenticated user

GetUserSubscriptions()

• tags activity
• get /user/subscriptions
• docs https://docs.github.com/rest/reference/activity#list-repositories-watched-by-the-authenticated-user

List repositories watched by the authenticated user Lists repositories the authenticated user is watching.

GetUserTeams()

• tags teams
• get /user/teams
• docs https://docs.github.com/rest/reference/teams#list-teams-for-the-authenticated-user

List teams for the authenticated user List all of the teams across all of the organizations to which the authenticated user belongs. This method requires user, repo, or read:org scope when authenticating via OAuth.

GetUsers()

• tags users
• get /users
• docs https://docs.github.com/rest/reference/users#list-users

List users Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.

Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.

GetUsersusername(String)

• tags users
• get /users/{username}
• docs https://docs.github.com/rest/reference/users#get-a-user

Get a user Provides publicly available information about someone with a GitHub account.

GitHub Apps with the Plan user permission can use this endpoint to retrieve information about a user’s GitHub plan. The GitHub App must be authenticated as a user. See “Identifying and authorizing users for GitHub Apps” for details about authentication. For an example response, see ‘Response with GitHub plan information’ below“

The email key in the following response is the publicly visible email address from your GitHub profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub. For more information, see Authentication.

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see “Emails API”.

GetUsersusernameEvents(String)

• tags activity
• get /users/{username}/events
• docs https://docs.github.com/rest/reference/activity#list-events-for-the-authenticated-user

List events for the authenticated user If you are authenticated as the given user, you will see your private events. Otherwise, you’ll only see public events.

GetUsersusernameEventsOrgsorg(String, String)

• tags activity
• get /users/{username}/events/orgs/{org}
• docs https://docs.github.com/rest/reference/activity#list-organization-events-for-the-authenticated-user

List organization events for the authenticated user This is the user’s organization dashboard. You must be authenticated as the user to view this.

GetUsersusernameEventsPublic(String)

• tags activity
• get /users/{username}/events/public
• docs https://docs.github.com/rest/reference/activity#list-public-events-for-a-user

List public events for a user

GetUsersusernameFollowers(String)

• tags users
• get /users/{username}/followers
• docs https://docs.github.com/rest/reference/users#list-followers-of-a-user

List followers of a user Lists the people following the specified user.

GetUsersusernameFollowing(String)

• tags users
• get /users/{username}/following
• docs https://docs.github.com/rest/reference/users#list-the-people-a-user-follows

List the people a user follows Lists the people who the specified user follows.

GetUsersusernameFollowingtargetUser(String, String)

• tags users
• get /users/{username}/following/{target_user}
• docs https://docs.github.com/rest/reference/users#check-if-a-user-follows-another-user

Check if a user follows another user

GetUsersusernameGists(String)

• tags gists
• get /users/{username}/gists
• docs https://docs.github.com/rest/reference/gists#list-gists-for-a-user

List gists for a user Lists public gists for the specified user:

GetUsersusernameGpgKeys(String)

• tags users
• get /users/{username}/gpg_keys
• docs https://docs.github.com/rest/reference/users#list-gpg-keys-for-a-user

List GPG keys for a user Lists the GPG keys for a user. This information is accessible by anyone.

GetUsersusernameHovercard(String)

• tags users
• get /users/{username}/hovercard
• docs https://docs.github.com/rest/reference/users#get-contextual-information-for-a-user

Get contextual information for a user Provides hovercard information when authenticated through basic auth or OAuth with the repo scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

The subject_type and subject_id parameters provide context for the person’s hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository via cURL, it would look like this:

 curl -u username:token
  https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192

GetUsersusernameInstallation(String)

• tags apps
• get /users/{username}/installation
• docs https://docs.github.com/rest/reference/apps#get-a-user-installation-for-the-authenticated-app

Get a user installation for the authenticated app Enables an authenticated GitHub App to find the user’s installation information.

You must use a JWT to access this endpoint.

GetUsersusernameKeys(String)

• tags users
• get /users/{username}/keys
• docs https://docs.github.com/rest/reference/users#list-public-keys-for-a-user

List public keys for a user Lists the verified public SSH keys for a user. This is accessible by anyone.

GetUsersusernameOrgs(String)

• tags orgs
• get /users/{username}/orgs
• docs https://docs.github.com/rest/reference/orgs#list-organizations-for-a-user

List organizations for a user List public organization memberships for the specified user.

This method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List organizations for the authenticated user API instead.

GetUsersusernamePackages(String)

• tags packages
• get /users/{username}/packages
• docs https://docs.github.com/rest/reference/packages#list-packages-for-user

List packages for a user Lists all packages in a user’s namespace for which the requesting user has access.

To use this endpoint, you must authenticate using an access token with the packages:read scope. If package_type is not container, your token must also include the repo scope.

GetUsersusernamePackagespackageTypepackageName(String, String, String)

• tags packages
• get /users/{username}/packages/{package_type}/{package_name}
• docs https://docs.github.com/rest/reference/packages#get-a-package-for-a-user

Get a package for a user Gets a specific package metadata for a public package owned by a user.

To use this endpoint, you must authenticate using an access token with the packages:read scope. If package_type is not container, your token must also include the repo scope.

DeleteUsersusernamePackagespackageTypepackageName(String, String, String)

• tags packages
• delete /users/{username}/packages/{package_type}/{package_name}
• docs https://docs.github.com/rest/reference/packages#delete-a-package-for-a-user

Delete a package for a user Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

To use this endpoint, you must authenticate using an access token with the packages:read and packages:delete scopes. In addition:

• If package_type is not container, your token must also include the repo scope.
• If package_type is container, you must also have admin permissions to the container you want to delete.

PostUsersusernamePackagespackageTypepackageNameRestore(String, String, String)

• tags packages
• post /users/{username}/packages/{package_type}/{package_name}/restore
• docs https://docs.github.com/rest/reference/packages#restore-a-package-for-a-user

Restore a package for a user Restores an entire package for a user.

You can restore a deleted package under the following conditions:

• The package was deleted within the last 30 days.
• The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package’s namespace first.

To use this endpoint, you must authenticate using an access token with the packages:read and packages:write scopes. In addition:

• If package_type is not container, your token must also include the repo scope.
• If package_type is container, you must also have admin permissions to the container that you want to restore.

GetUsersusernamePackagespackageTypepackageNameVersions(String, String, String)

• tags packages
• get /users/{username}/packages/{package_type}/{package_name}/versions
• docs https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-a-user

Get all package versions for a package owned by a user Returns all package versions for a public package owned by a specified user.

To use this endpoint, you must authenticate using an access token with the packages:read scope. If package_type is not container, your token must also include the repo scope.

GetUsersusernamePackagespackageTypepackageNameVersionspackageVersionId(String, String, String, String)

• tags packages
• get /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}
• docs https://docs.github.com/rest/reference/packages#get-a-package-version-for-a-user

Get a package version for a user Gets a specific package version for a public package owned by a specified user.

At this time, to use this endpoint, you must authenticate using an access token with the packages:read scope. If package_type is not container, your token must also include the repo scope.

DeleteUsersusernamePackagespackageTypepackageNameVersionspackageVersionId(String, String, String, String)

• tags packages
• delete /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}
• docs https://docs.github.com/rest/reference/packages#delete-a-package-version-for-a-user

Delete package version for a user Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

To use this endpoint, you must authenticate using an access token with the packages:read and packages:delete scopes. In addition:

• If package_type is not container, your token must also include the repo scope.
• If package_type is container, you must also have admin permissions to the container you want to delete.

PostUsersusernamePackagespackageTypepackageNameVersionspackageVersionIdRestore(String, String, String, String)

• tags packages
• post /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore
• docs https://docs.github.com/rest/reference/packages#restore-a-package-version-for-a-user

Restore package version for a user Restores a specific package version for a user.

You can restore a deleted package under the following conditions:

• The package was deleted within the last 30 days.
• The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package’s namespace first.

To use this endpoint, you must authenticate using an access token with the packages:read and packages:write scopes. In addition:

• If package_type is not container, your token must also include the repo scope.
• If package_type is container, you must also have admin permissions to the container that you want to restore.

GetUsersusernameProjects(String)

• tags projects
• get /users/{username}/projects
• docs https://docs.github.com/rest/reference/projects#list-user-projects

List user projects

GetUsersusernameReceivedEvents(String)

• tags activity
• get /users/{username}/received_events
• docs https://docs.github.com/rest/reference/activity#list-events-received-by-the-authenticated-user

List events received by the authenticated user These are events that you’ve received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you’ll only see public events.

GetUsersusernameReceivedEventsPublic(String)

• tags activity
• get /users/{username}/received_events/public
• docs https://docs.github.com/rest/reference/activity#list-public-events-received-by-a-user

List public events received by a user

GetUsersusernameRepos(String)

• tags repos
• get /users/{username}/repos
• docs https://docs.github.com/rest/reference/repos#list-repositories-for-a-user

List repositories for a user Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.

GetUsersusernameSettingsBillingActions(String)

• tags billing
• get /users/{username}/settings/billing/actions
• docs https://docs.github.com/rest/reference/billing#get-github-actions-billing-for-a-user

Get GitHub Actions billing for a user Gets the summary of the free and paid GitHub Actions minutes used.

Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see “Managing billing for GitHub Actions”.

Access tokens must have the user scope.

GetUsersusernameSettingsBillingPackages(String)

• tags billing
• get /users/{username}/settings/billing/packages
• docs https://docs.github.com/rest/reference/billing#get-github-packages-billing-for-a-user

Get GitHub Packages billing for a user Gets the free and paid storage used for GitHub Packages in gigabytes.

Paid minutes only apply to packages stored for private repositories. For more information, see “Managing billing for GitHub Packages.”

Access tokens must have the user scope.

GetUsersusernameSettingsBillingSharedStorage(String)

• tags billing
• get /users/{username}/settings/billing/shared-storage
• docs https://docs.github.com/rest/reference/billing#get-shared-storage-billing-for-a-user

Get shared storage billing for a user Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages.

Paid minutes only apply to packages stored for private repositories. For more information, see “Managing billing for GitHub Packages.”

Access tokens must have the user scope.

GetUsersusernameStarred(String)

• tags activity
• get /users/{username}/starred
• docs https://docs.github.com/rest/reference/activity#list-repositories-starred-by-a-user

List repositories starred by a user Lists repositories a user has starred.

You can also find out when stars were created by passing the following custom media type via the Accept header:

GetUsersusernameSubscriptions(String)

• tags activity
• get /users/{username}/subscriptions
• docs https://docs.github.com/rest/reference/activity#list-repositories-watched-by-a-user

List repositories watched by a user Lists repositories a user is watching.

GetZen()

• tags meta
• get /zen

Get the Zen of GitHub Get a random sentence from the Zen of GitHub

Implementations

impl EndPoints

pub const fn method(&self) -> Methods

pub fn path(&self) -> String