No description
- Java 100%
Alex Nordlund
cf219f89f8
All checks were successful
Java CI with Maven / Build YNAB API Endpoints (push) Successful in 2m5s
|
||
|---|---|---|
| .forgejo/workflows | ||
| api | ||
| docs | ||
| gradle/wrapper | ||
| src | ||
| .gitignore | ||
| .openapi-generator-ignore | ||
| build.gradle | ||
| gradle.properties | ||
| gradlew | ||
| gradlew.bat | ||
| README.md | ||
| settings.gradle | ||
forgejo
Forgejo API
- API version: 15.0.9+gitea-1.22.0+patch1
- Build date: 2026-09-28T16:24:31.414706+02:00[Europe/Stockholm]
- Generator version: 7.21.0
This documentation describes the Forgejo API.
Automatically generated by the OpenAPI Generator
Requirements
Building the API client library requires:
- Java 1.8+
- Maven (3.8.3+)/Gradle (7.2+)
Installation
To install the API client library to your local Maven repository, simply execute:
mvn clean install
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
mvn clean deploy
Refer to the OSSRH Guide for more information.
Maven users
Add this dependency to your project's POM:
<dependency>
<groupId>build.cursed.genapi</groupId>
<artifactId>forgejo</artifactId>
<version>15.0.9+gitea-1.22.0+patch1</version>
<scope>compile</scope>
</dependency>
Gradle users
Add this dependency to your project's build file:
repositories {
mavenCentral() // Needed if the 'forgejo' jar has been published to maven central.
mavenLocal() // Needed if the 'forgejo' jar has been published to the local maven repo.
}
dependencies {
implementation "build.cursed.genapi:forgejo:15.0.9+gitea-1.22.0+patch1"
}
Others
At first generate the JAR by executing:
mvn clean package
Then manually install the following JARs:
target/forgejo-15.0.9+gitea-1.22.0+patch1.jartarget/lib/*.jar
Getting Started
Please follow the installation instruction and execute the following Java code:
// Import classes:
import build.cursed.genapi.forgejo.ApiClient;
import build.cursed.genapi.forgejo.ApiException;
import build.cursed.genapi.forgejo.Configuration;
import build.cursed.genapi.forgejo.auth.*;
import build.cursed.genapi.forgejo.model.*;
import build.cursed.genapi.forgejo.api.ActivitypubApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("/api/v1");
// Configure API key authorization: TOTPHeader
ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader");
TOTPHeader.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//TOTPHeader.setApiKeyPrefix("Token");
// Configure API key authorization: AuthorizationHeaderToken
ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken");
AuthorizationHeaderToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//AuthorizationHeaderToken.setApiKeyPrefix("Token");
// Configure API key authorization: SudoHeader
ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader");
SudoHeader.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//SudoHeader.setApiKeyPrefix("Token");
// Configure HTTP basic authorization: BasicAuth
HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
BasicAuth.setUsername("YOUR USERNAME");
BasicAuth.setPassword("YOUR PASSWORD");
// Configure API key authorization: SudoParam
ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam");
SudoParam.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//SudoParam.setApiKeyPrefix("Token");
ActivitypubApi apiInstance = new ActivitypubApi(defaultClient);
try {
ActivityPub result = apiInstance.activitypubInstanceActor();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ActivitypubApi#activitypubInstanceActor");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Documentation for API Endpoints
All URIs are relative to /api/v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ActivitypubApi | activitypubInstanceActor | GET /activitypub/actor | Returns the instance's Actor |
| ActivitypubApi | activitypubInstanceActorInbox | POST /activitypub/actor/inbox | Send to the inbox |
| ActivitypubApi | activitypubInstanceActorOutbox | POST /activitypub/actor/outbox | Display the outbox (always empty) |
| ActivitypubApi | activitypubPerson | GET /activitypub/user-id/{user-id} | Returns the Person actor for a user |
| ActivitypubApi | activitypubPersonActivity | GET /activitypub/user-id/{user-id}/activities/{activity-id}/activity | Get a specific activity of the user |
| ActivitypubApi | activitypubPersonActivityNote | GET /activitypub/user-id/{user-id}/activities/{activity-id} | Get a specific activity object of the user |
| ActivitypubApi | activitypubPersonFeed | GET /activitypub/user-id/{user-id}/outbox | List the user's recorded activity |
| ActivitypubApi | activitypubPersonInbox | POST /activitypub/user-id/{user-id}/inbox | Send to the inbox |
| ActivitypubApi | activitypubRepository | GET /activitypub/repository-id/{repository-id} | Returns the Repository actor for a repo |
| ActivitypubApi | activitypubRepositoryInbox | POST /activitypub/repository-id/{repository-id}/inbox | Send to the inbox |
| ActivitypubApi | activitypubRepositoryOutbox | POST /activitypub/repository-id/{repository-id}/outbox | Display the outbox |
| AdminApi | adminAddRuleToQuotaGroup | PUT /admin/quota/groups/{quotagroup}/rules/{quotarule} | Adds a rule to a quota group |
| AdminApi | adminAddUserToQuotaGroup | PUT /admin/quota/groups/{quotagroup}/users/{username} | Add a user to a quota group |
| AdminApi | adminAdoptRepository | POST /admin/unadopted/{owner}/{repo} | Adopt unadopted files as a repository |
| AdminApi | adminCreateHook | POST /admin/hooks | Create a hook |
| AdminApi | adminCreateOrg | POST /admin/users/{username}/orgs | Create an organization |
| AdminApi | adminCreatePublicKey | POST /admin/users/{username}/keys | Add an SSH public key to user's account |
| AdminApi | adminCreateQuotaGroup | POST /admin/quota/groups | Create a new quota group |
| AdminApi | adminCreateQuotaRule | POST /admin/quota/rules | Create a new quota rule |
| AdminApi | adminCreateRepo | POST /admin/users/{username}/repos | Create a repository on behalf of a user |
| AdminApi | adminCreateUser | POST /admin/users | Create a user account |
| AdminApi | adminCronList | GET /admin/cron | List cron tasks |
| AdminApi | adminCronRun | POST /admin/cron/{task} | Run cron task |
| AdminApi | adminDeleteHook | DELETE /admin/hooks/{id} | Delete a hook |
| AdminApi | adminDeleteQuotaGroup | DELETE /admin/quota/groups/{quotagroup} | Delete a quota group |
| AdminApi | adminDeleteQuotaRule | DELETE /admin/quota/rules/{quotarule} | Deletes a quota rule |
| AdminApi | adminDeleteUnadoptedRepository | DELETE /admin/unadopted/{owner}/{repo} | Delete unadopted files |
| AdminApi | adminDeleteUser | DELETE /admin/users/{username} | Delete user account |
| AdminApi | adminDeleteUserEmails | DELETE /admin/users/{username}/emails | Delete email addresses from a user's account |
| AdminApi | adminDeleteUserPublicKey | DELETE /admin/users/{username}/keys/{id} | Remove a public key from user's account |
| AdminApi | adminEditHook | PATCH /admin/hooks/{id} | Update a hook |
| AdminApi | adminEditQuotaRule | PATCH /admin/quota/rules/{quotarule} | Change an existing quota rule |
| AdminApi | adminEditUser | PATCH /admin/users/{username} | Edit an existing user |
| AdminApi | adminGetActionRunJobs | GET /admin/actions/runners/jobs | Get action run jobs |
| AdminApi | adminGetAllEmails | GET /admin/emails | List all users' email addresses |
| AdminApi | adminGetAllOrgs | GET /admin/orgs | List all organizations |
| AdminApi | adminGetHook | GET /admin/hooks/{id} | Get a hook |
| AdminApi | adminGetQuotaGroup | GET /admin/quota/groups/{quotagroup} | Get information about the quota group |
| AdminApi | adminGetQuotaRule | GET /admin/quota/rules/{quotarule} | Get information about a quota rule |
| AdminApi | adminGetRegistrationToken | GET /admin/runners/registration-token | Get a runner registration token for registering global runners |
| AdminApi | adminGetRunnerRegistrationToken | GET /admin/actions/runners/registration-token | Get a runner registration token for registering global runners |
| AdminApi | adminGetUserQuota | GET /admin/users/{username}/quota | Get the user's quota info |
| AdminApi | adminListHooks | GET /admin/hooks | List global (system) webhooks |
| AdminApi | adminListQuotaGroups | GET /admin/quota/groups | List the available quota groups |
| AdminApi | adminListQuotaRules | GET /admin/quota/rules | List the available quota rules |
| AdminApi | adminListUserEmails | GET /admin/users/{username}/emails | List all email addresses for a user |
| AdminApi | adminListUsersInQuotaGroup | GET /admin/quota/groups/{quotagroup}/users | List users in a quota group |
| AdminApi | adminRemoveRuleFromQuotaGroup | DELETE /admin/quota/groups/{quotagroup}/rules/{quotarule} | Removes a rule from a quota group |
| AdminApi | adminRemoveUserFromQuotaGroup | DELETE /admin/quota/groups/{quotagroup}/users/{username} | Remove a user from a quota group |
| AdminApi | adminRenameUser | POST /admin/users/{username}/rename | Rename a user |
| AdminApi | adminSearchEmails | GET /admin/emails/search | Search users' email addresses |
| AdminApi | adminSearchRunJobs | GET /admin/runners/jobs | Search action jobs according to filter conditions |
| AdminApi | adminSearchUsers | GET /admin/users | Search users according filter conditions |
| AdminApi | adminSetUserQuotaGroups | POST /admin/users/{username}/quota/groups | Set the user's quota groups to a given list. |
| AdminApi | adminUnadoptedList | GET /admin/unadopted | List unadopted repositories |
| AdminApi | deleteAdminRunner | DELETE /admin/actions/runners/{runner_id} | Delete a particular runner, no matter whether it is a global runner or scoped to an organization, user, or repository |
| AdminApi | getAdminRunner | GET /admin/actions/runners/{runner_id} | Get a particular runner, no matter whether it is a global runner or scoped to an organization, user, or repository |
| AdminApi | getAdminRunners | GET /admin/actions/runners | Get all runners, no matter whether they are global runners or scoped to an organization, user, or repository |
| AdminApi | registerAdminRunner | POST /admin/actions/runners | Register a new global runner |
| IssueApi | issueAddLabel | POST /repos/{owner}/{repo}/issues/{index}/labels | Add a label to an issue |
| IssueApi | issueAddSubscription | PUT /repos/{owner}/{repo}/issues/{index}/subscriptions/{user} | Subscribe user to issue |
| IssueApi | issueAddTime | POST /repos/{owner}/{repo}/issues/{index}/times | Add tracked time to a issue |
| IssueApi | issueCheckSubscription | GET /repos/{owner}/{repo}/issues/{index}/subscriptions/check | Check if user is subscribed to an issue |
| IssueApi | issueClearLabels | DELETE /repos/{owner}/{repo}/issues/{index}/labels | Remove all labels from an issue |
| IssueApi | issueCreateComment | POST /repos/{owner}/{repo}/issues/{index}/comments | Add a comment to an issue |
| IssueApi | issueCreateIssue | POST /repos/{owner}/{repo}/issues | Create an issue. If using deadline only the date will be taken into account, and time of day ignored. |
| IssueApi | issueCreateIssueAttachment | POST /repos/{owner}/{repo}/issues/{index}/assets | Create an issue attachment |
| IssueApi | issueCreateIssueBlocking | POST /repos/{owner}/{repo}/issues/{index}/blocks | Block the issue given in the body by the issue in path |
| IssueApi | issueCreateIssueCommentAttachment | POST /repos/{owner}/{repo}/issues/comments/{id}/assets | Create a comment attachment |
| IssueApi | issueCreateIssueDependencies | POST /repos/{owner}/{repo}/issues/{index}/dependencies | Make the issue in the url depend on the issue in the form. |
| IssueApi | issueCreateLabel | POST /repos/{owner}/{repo}/labels | Create a label |
| IssueApi | issueCreateMilestone | POST /repos/{owner}/{repo}/milestones | Create a milestone |
| IssueApi | issueDelete | DELETE /repos/{owner}/{repo}/issues/{index} | Delete an issue |
| IssueApi | issueDeleteComment | DELETE /repos/{owner}/{repo}/issues/comments/{id} | Delete a comment |
| IssueApi | issueDeleteCommentDeprecated | DELETE /repos/{owner}/{repo}/issues/{index}/comments/{id} | Delete a comment |
| IssueApi | issueDeleteCommentReaction | DELETE /repos/{owner}/{repo}/issues/comments/{id}/reactions | Remove a reaction from a comment of an issue |
| IssueApi | issueDeleteIssueAttachment | DELETE /repos/{owner}/{repo}/issues/{index}/assets/{attachment_id} | Delete an issue attachment |
| IssueApi | issueDeleteIssueCommentAttachment | DELETE /repos/{owner}/{repo}/issues/comments/{id}/assets/{attachment_id} | Delete a comment attachment |
| IssueApi | issueDeleteIssueReaction | DELETE /repos/{owner}/{repo}/issues/{index}/reactions | Remove a reaction from an issue |
| IssueApi | issueDeleteLabel | DELETE /repos/{owner}/{repo}/labels/{id} | Delete a label |
| IssueApi | issueDeleteMilestone | DELETE /repos/{owner}/{repo}/milestones/{id} | Delete a milestone |
| IssueApi | issueDeleteStopWatch | DELETE /repos/{owner}/{repo}/issues/{index}/stopwatch/delete | Delete an issue's existing stopwatch. |
| IssueApi | issueDeleteSubscription | DELETE /repos/{owner}/{repo}/issues/{index}/subscriptions/{user} | Unsubscribe user from issue |
| IssueApi | issueDeleteTime | DELETE /repos/{owner}/{repo}/issues/{index}/times/{id} | Delete specific tracked time |
| IssueApi | issueEditComment | PATCH /repos/{owner}/{repo}/issues/comments/{id} | Edit a comment |
| IssueApi | issueEditCommentDeprecated | PATCH /repos/{owner}/{repo}/issues/{index}/comments/{id} | Edit a comment |
| IssueApi | issueEditIssue | PATCH /repos/{owner}/{repo}/issues/{index} | Edit an issue. If using deadline only the date will be taken into account, and time of day ignored. |
| IssueApi | issueEditIssueAttachment | PATCH /repos/{owner}/{repo}/issues/{index}/assets/{attachment_id} | Edit an issue attachment |
| IssueApi | issueEditIssueCommentAttachment | PATCH /repos/{owner}/{repo}/issues/comments/{id}/assets/{attachment_id} | Edit a comment attachment |
| IssueApi | issueEditIssueDeadline | POST /repos/{owner}/{repo}/issues/{index}/deadline | Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored. |
| IssueApi | issueEditLabel | PATCH /repos/{owner}/{repo}/labels/{id} | Update a label |
| IssueApi | issueEditMilestone | PATCH /repos/{owner}/{repo}/milestones/{id} | Update a milestone |
| IssueApi | issueGetComment | GET /repos/{owner}/{repo}/issues/comments/{id} | Get a comment |
| IssueApi | issueGetCommentReactions | GET /repos/{owner}/{repo}/issues/comments/{id}/reactions | Get a list of reactions from a comment of an issue |
| IssueApi | issueGetComments | GET /repos/{owner}/{repo}/issues/{index}/comments | List all comments on an issue |
| IssueApi | issueGetCommentsAndTimeline | GET /repos/{owner}/{repo}/issues/{index}/timeline | List all comments and events on an issue |
| IssueApi | issueGetIssue | GET /repos/{owner}/{repo}/issues/{index} | Get an issue |
| IssueApi | issueGetIssueAttachment | GET /repos/{owner}/{repo}/issues/{index}/assets/{attachment_id} | Get an issue attachment |
| IssueApi | issueGetIssueCommentAttachment | GET /repos/{owner}/{repo}/issues/comments/{id}/assets/{attachment_id} | Get a comment attachment |
| IssueApi | issueGetIssueReactions | GET /repos/{owner}/{repo}/issues/{index}/reactions | Get a list reactions of an issue |
| IssueApi | issueGetLabel | GET /repos/{owner}/{repo}/labels/{id} | Get a single label |
| IssueApi | issueGetLabels | GET /repos/{owner}/{repo}/issues/{index}/labels | Get an issue's labels |
| IssueApi | issueGetMilestone | GET /repos/{owner}/{repo}/milestones/{id} | Get a milestone |
| IssueApi | issueGetMilestonesList | GET /repos/{owner}/{repo}/milestones | Get all of a repository's opened milestones |
| IssueApi | issueGetRepoComments | GET /repos/{owner}/{repo}/issues/comments | List all comments in a repository |
| IssueApi | issueListBlocks | GET /repos/{owner}/{repo}/issues/{index}/blocks | List issues that are blocked by this issue |
| IssueApi | issueListIssueAttachments | GET /repos/{owner}/{repo}/issues/{index}/assets | List issue's attachments |
| IssueApi | issueListIssueCommentAttachments | GET /repos/{owner}/{repo}/issues/comments/{id}/assets | List comment's attachments |
| IssueApi | issueListIssueDependencies | GET /repos/{owner}/{repo}/issues/{index}/dependencies | List an issue's dependencies, i.e all issues that block this issue. |
| IssueApi | issueListIssues | GET /repos/{owner}/{repo}/issues | List a repository's issues |
| IssueApi | issueListLabels | GET /repos/{owner}/{repo}/labels | Get all of a repository's labels |
| IssueApi | issuePostCommentReaction | POST /repos/{owner}/{repo}/issues/comments/{id}/reactions | Add a reaction to a comment of an issue |
| IssueApi | issuePostIssueReaction | POST /repos/{owner}/{repo}/issues/{index}/reactions | Add a reaction to an issue |
| IssueApi | issueRemoveIssueBlocking | DELETE /repos/{owner}/{repo}/issues/{index}/blocks | Unblock the issue given in the body by the issue in path |
| IssueApi | issueRemoveIssueDependencies | DELETE /repos/{owner}/{repo}/issues/{index}/dependencies | Remove an issue dependency |
| IssueApi | issueRemoveLabel | DELETE /repos/{owner}/{repo}/issues/{index}/labels/{identifier} | Remove a label from an issue |
| IssueApi | issueReplaceLabels | PUT /repos/{owner}/{repo}/issues/{index}/labels | Replace an issue's labels |
| IssueApi | issueResetTime | DELETE /repos/{owner}/{repo}/issues/{index}/times | Reset a tracked time of an issue |
| IssueApi | issueSearchIssues | GET /repos/issues/search | Search for issues across the repositories that the user has access to |
| IssueApi | issueStartStopWatch | POST /repos/{owner}/{repo}/issues/{index}/stopwatch/start | Start stopwatch on an issue. |
| IssueApi | issueStopStopWatch | POST /repos/{owner}/{repo}/issues/{index}/stopwatch/stop | Stop an issue's existing stopwatch. |
| IssueApi | issueSubscriptions | GET /repos/{owner}/{repo}/issues/{index}/subscriptions | Get users who subscribed on an issue. |
| IssueApi | issueTrackedTimes | GET /repos/{owner}/{repo}/issues/{index}/times | List an issue's tracked times |
| IssueApi | moveIssuePin | PATCH /repos/{owner}/{repo}/issues/{index}/pin/{position} | Moves the Pin to the given Position |
| IssueApi | pinIssue | POST /repos/{owner}/{repo}/issues/{index}/pin | Pin an Issue |
| IssueApi | unpinIssue | DELETE /repos/{owner}/{repo}/issues/{index}/pin | Unpin an Issue |
| MiscellaneousApi | getGitignoreTemplateInfo | GET /gitignore/templates/{name} | Returns information about a gitignore template |
| MiscellaneousApi | getLabelTemplateInfo | GET /label/templates/{name} | Returns all labels in a template |
| MiscellaneousApi | getLicenseTemplateInfo | GET /licenses/{name} | Returns information about a license template |
| MiscellaneousApi | getNodeInfo | GET /nodeinfo | Returns the nodeinfo of the Forgejo application |
| MiscellaneousApi | getSSHSigningKey | GET /signing-key.ssh | Get default signing-key.ssh |
| MiscellaneousApi | getSigningKey | GET /signing-key.gpg | Get default signing-key.gpg |
| MiscellaneousApi | getVersion | GET /version | Returns the version of the running application |
| MiscellaneousApi | listGitignoresTemplates | GET /gitignore/templates | Returns a list of all gitignore templates |
| MiscellaneousApi | listLabelTemplates | GET /label/templates | Returns a list of all label templates |
| MiscellaneousApi | listLicenseTemplates | GET /licenses | Returns a list of all license templates |
| MiscellaneousApi | renderMarkdown | POST /markdown | Render a markdown document as HTML |
| MiscellaneousApi | renderMarkdownRaw | POST /markdown/raw | Render raw markdown as HTML |
| MiscellaneousApi | renderMarkup | POST /markup | Render a markup document as HTML |
| NotificationApi | notifyGetList | GET /notifications | List users's notification threads |
| NotificationApi | notifyGetRepoList | GET /repos/{owner}/{repo}/notifications | List users's notification threads on a specific repo |
| NotificationApi | notifyGetThread | GET /notifications/threads/{id} | Get notification thread by ID |
| NotificationApi | notifyNewAvailable | GET /notifications/new | Check if unread notifications exist |
| NotificationApi | notifyReadList | PUT /notifications | Mark notification threads as read, pinned or unread |
| NotificationApi | notifyReadRepoList | PUT /repos/{owner}/{repo}/notifications | Mark notification threads as read, pinned or unread on a specific repo |
| NotificationApi | notifyReadThread | PATCH /notifications/threads/{id} | Mark notification thread as read by ID |
| OrganizationApi | createOrgRepo | POST /orgs/{org}/repos | Create a repository in an organization |
| OrganizationApi | createOrgRepoDeprecated | POST /org/{org}/repos | Create a repository in an organization |
| OrganizationApi | createOrgVariable | POST /orgs/{org}/actions/variables/{variablename} | Create a new variable in organization |
| OrganizationApi | deleteOrgRunner | DELETE /orgs/{org}/actions/runners/{runner_id} | Delete a particular runner that belongs to the organization |
| OrganizationApi | deleteOrgSecret | DELETE /orgs/{org}/actions/secrets/{secretname} | Delete a secret in an organization |
| OrganizationApi | deleteOrgVariable | DELETE /orgs/{org}/actions/variables/{variablename} | Delete organization's variable by name |
| OrganizationApi | getOrgRunner | GET /orgs/{org}/actions/runners/{runner_id} | Get a particular runner that belongs to the organization |
| OrganizationApi | getOrgRunners | GET /orgs/{org}/actions/runners | Get the organization's runners |
| OrganizationApi | getOrgVariable | GET /orgs/{org}/actions/variables/{variablename} | Get organization's variable by name |
| OrganizationApi | getOrgVariablesList | GET /orgs/{org}/actions/variables | List variables of an organization |
| OrganizationApi | orgAddTeamMember | PUT /teams/{id}/members/{username} | Add a team member |
| OrganizationApi | orgAddTeamRepository | PUT /teams/{id}/repos/{org}/{repo} | Add a repository to a team |
| OrganizationApi | orgBlockUser | PUT /orgs/{org}/block/{username} | Blocks a user from the organization |
| OrganizationApi | orgCheckQuota | GET /orgs/{org}/quota/check | Check if the organization is over quota for a given subject |
| OrganizationApi | orgConcealMember | DELETE /orgs/{org}/public_members/{username} | Conceal a user's membership |
| OrganizationApi | orgCreate | POST /orgs | Create an organization |
| OrganizationApi | orgCreateHook | POST /orgs/{org}/hooks | Create a hook |
| OrganizationApi | orgCreateLabel | POST /orgs/{org}/labels | Create a label for an organization |
| OrganizationApi | orgCreateTeam | POST /orgs/{org}/teams | Create a team |
| OrganizationApi | orgDelete | DELETE /orgs/{org} | Delete an organization |
| OrganizationApi | orgDeleteAvatar | DELETE /orgs/{org}/avatar | Delete an organization's avatar. It will be replaced by a default one |
| OrganizationApi | orgDeleteHook | DELETE /orgs/{org}/hooks/{id} | Delete a hook |
| OrganizationApi | orgDeleteLabel | DELETE /orgs/{org}/labels/{id} | Delete a label |
| OrganizationApi | orgDeleteMember | DELETE /orgs/{org}/members/{username} | Remove a member from an organization |
| OrganizationApi | orgDeleteTeam | DELETE /teams/{id} | Delete a team |
| OrganizationApi | orgEdit | PATCH /orgs/{org} | Edit an organization |
| OrganizationApi | orgEditHook | PATCH /orgs/{org}/hooks/{id} | Update a hook |
| OrganizationApi | orgEditLabel | PATCH /orgs/{org}/labels/{id} | Update a label |
| OrganizationApi | orgEditTeam | PATCH /teams/{id} | Edit a team |
| OrganizationApi | orgGet | GET /orgs/{org} | Get an organization |
| OrganizationApi | orgGetAll | GET /orgs | List all organizations |
| OrganizationApi | orgGetHook | GET /orgs/{org}/hooks/{id} | Get a hook |
| OrganizationApi | orgGetLabel | GET /orgs/{org}/labels/{id} | Get a single label |
| OrganizationApi | orgGetQuota | GET /orgs/{org}/quota | Get quota information for an organization |
| OrganizationApi | orgGetRunnerRegistrationToken | GET /orgs/{org}/actions/runners/registration-token | Get the organization's runner registration token |
| OrganizationApi | orgGetTeam | GET /teams/{id} | Get a team |
| OrganizationApi | orgGetUserPermissions | GET /users/{username}/orgs/{org}/permissions | Get user permissions in organization |
| OrganizationApi | orgIsMember | GET /orgs/{org}/members/{username} | Check if a user is a member of an organization |
| OrganizationApi | orgIsPublicMember | GET /orgs/{org}/public_members/{username} | Check if a user is a public member of an organization |
| OrganizationApi | orgListActionsSecrets | GET /orgs/{org}/actions/secrets | List actions secrets of an organization |
| OrganizationApi | orgListActivityFeeds | GET /orgs/{org}/activities/feeds | List an organization's activity feeds |
| OrganizationApi | orgListBlockedUsers | GET /orgs/{org}/list_blocked | List the organization's blocked users |
| OrganizationApi | orgListCurrentUserOrgs | GET /user/orgs | List the current user's organizations |
| OrganizationApi | orgListHooks | GET /orgs/{org}/hooks | List an organization's webhooks |
| OrganizationApi | orgListLabels | GET /orgs/{org}/labels | List an organization's labels |
| OrganizationApi | orgListMembers | GET /orgs/{org}/members | List an organization's members |
| OrganizationApi | orgListPublicMembers | GET /orgs/{org}/public_members | List an organization's public members |
| OrganizationApi | orgListQuotaArtifacts | GET /orgs/{org}/quota/artifacts | List the artifacts affecting the organization's quota |
| OrganizationApi | orgListQuotaAttachments | GET /orgs/{org}/quota/attachments | List the attachments affecting the organization's quota |
| OrganizationApi | orgListQuotaPackages | GET /orgs/{org}/quota/packages | List the packages affecting the organization's quota |
| OrganizationApi | orgListRepos | GET /orgs/{org}/repos | List an organization's repos |
| OrganizationApi | orgListTeamActivityFeeds | GET /teams/{id}/activities/feeds | List a team's activity feeds |
| OrganizationApi | orgListTeamMember | GET /teams/{id}/members/{username} | List a particular member of team |
| OrganizationApi | orgListTeamMembers | GET /teams/{id}/members | List a team's members |
| OrganizationApi | orgListTeamRepo | GET /teams/{id}/repos/{org}/{repo} | List a particular repo of team |
| OrganizationApi | orgListTeamRepos | GET /teams/{id}/repos | List a team's repos |
| OrganizationApi | orgListTeams | GET /orgs/{org}/teams | List an organization's teams |
| OrganizationApi | orgListUserOrgs | GET /users/{username}/orgs | List a user's organizations |
| OrganizationApi | orgPublicizeMember | PUT /orgs/{org}/public_members/{username} | Publicize a user's membership |
| OrganizationApi | orgRemoveTeamMember | DELETE /teams/{id}/members/{username} | Remove a team member |
| OrganizationApi | orgRemoveTeamRepository | DELETE /teams/{id}/repos/{org}/{repo} | Remove a repository from a team |
| OrganizationApi | orgSearchRunJobs | GET /orgs/{org}/actions/runners/jobs | Search for organization's action jobs according filter conditions |
| OrganizationApi | orgUnblockUser | PUT /orgs/{org}/unblock/{username} | Unblock a user from the organization |
| OrganizationApi | orgUpdateAvatar | POST /orgs/{org}/avatar | Update an organization's avatar |
| OrganizationApi | registerOrgRunner | POST /orgs/{org}/actions/runners | Register a new organization-level runner |
| OrganizationApi | renameOrg | POST /orgs/{org}/rename | Rename an organization |
| OrganizationApi | teamSearch | GET /orgs/{org}/teams/search | Search for teams within an organization |
| OrganizationApi | updateOrgSecret | PUT /orgs/{org}/actions/secrets/{secretname} | Create or Update a secret value in an organization |
| OrganizationApi | updateOrgVariable | PUT /orgs/{org}/actions/variables/{variablename} | Update variable in organization |
| PackageApi | deletePackage | DELETE /packages/{owner}/{type}/{name}/{version} | Delete a package |
| PackageApi | getPackage | GET /packages/{owner}/{type}/{name}/{version} | Gets a package |
| PackageApi | linkPackage | POST /packages/{owner}/{type}/{name}/-/link/{repo_name} | Link a package to a repository |
| PackageApi | listPackageFiles | GET /packages/{owner}/{type}/{name}/{version}/files | Gets all files of a package |
| PackageApi | listPackages | GET /packages/{owner} | Gets all packages of an owner |
| PackageApi | unlinkPackage | POST /packages/{owner}/{type}/{name}/-/unlink | Unlink a package from a repository |
| RepositoryApi | acceptRepoTransfer | POST /repos/{owner}/{repo}/transfer/accept | Accept a repo transfer |
| RepositoryApi | actionRun | GET /repos/{owner}/{repo}/actions/runs/{run_id} | Get an action run |
| RepositoryApi | createCurrentUserRepo | POST /user/repos | Create a repository |
| RepositoryApi | createFork | POST /repos/{owner}/{repo}/forks | Fork a repository |
| RepositoryApi | createRepoVariable | POST /repos/{owner}/{repo}/actions/variables/{variablename} | Create a repo-level variable |
| RepositoryApi | deleteRepoRunner | DELETE /repos/{owner}/{repo}/actions/runners/{runner_id} | Delete a particular runner that belongs to a repository |
| RepositoryApi | deleteRepoSecret | DELETE /repos/{owner}/{repo}/actions/secrets/{secretname} | Delete a secret in a repository |
| RepositoryApi | deleteRepoVariable | DELETE /repos/{owner}/{repo}/actions/variables/{variablename} | Delete a repo-level variable |
| RepositoryApi | dispatchWorkflow | POST /repos/{owner}/{repo}/actions/workflows/{workflowfilename}/dispatches | Dispatches a workflow |
| RepositoryApi | generateRepo | POST /repos/{template_owner}/{template_repo}/generate | Create a repository using a template |
| RepositoryApi | getAnnotatedTag | GET /repos/{owner}/{repo}/git/tags/{sha} | Gets the tag object of an annotated tag (not lightweight tags) |
| RepositoryApi | getBlob | GET /repos/{owner}/{repo}/git/blobs/{sha} | Gets the blob of a repository. |
| RepositoryApi | getBlobs | GET /repos/{owner}/{repo}/git/blobs | Gets multiple blobs of a repository. |
| RepositoryApi | getRepoRunner | GET /repos/{owner}/{repo}/actions/runners/{runner_id} | Get a particular runner that belongs to the repository |
| RepositoryApi | getRepoRunners | GET /repos/{owner}/{repo}/actions/runners | Get runners belonging to the repository |
| RepositoryApi | getRepoVariable | GET /repos/{owner}/{repo}/actions/variables/{variablename} | Get a repo-level variable |
| RepositoryApi | getRepoVariablesList | GET /repos/{owner}/{repo}/actions/variables | Get repo-level variables list |
| RepositoryApi | getTree | GET /repos/{owner}/{repo}/git/trees/{sha} | Gets the tree of a repository. |
| RepositoryApi | listActionRuns | GET /repos/{owner}/{repo}/actions/runs | List a repository's action runs |
| RepositoryApi | listActionTasks | GET /repos/{owner}/{repo}/actions/tasks | List a repository's action tasks |
| RepositoryApi | listForks | GET /repos/{owner}/{repo}/forks | List a repository's forks |
| RepositoryApi | registerRepoRunner | POST /repos/{owner}/{repo}/actions/runners | Register a new repository-level runner |
| RepositoryApi | rejectRepoTransfer | POST /repos/{owner}/{repo}/transfer/reject | Reject a repo transfer |
| RepositoryApi | repoAddCollaborator | PUT /repos/{owner}/{repo}/collaborators/{collaborator} | Add a collaborator to a repository |
| RepositoryApi | repoAddFlag | PUT /repos/{owner}/{repo}/flags/{flag} | Add a flag to a repository |
| RepositoryApi | repoAddPushMirror | POST /repos/{owner}/{repo}/push_mirrors | Set up a new push mirror in a repository |
| RepositoryApi | repoAddTeam | PUT /repos/{owner}/{repo}/teams/{team} | Add a team to a repository |
| RepositoryApi | repoAddTopic | PUT /repos/{owner}/{repo}/topics/{topic} | Add a topic to a repository |
| RepositoryApi | repoApplyDiffPatch | POST /repos/{owner}/{repo}/diffpatch | Apply diff patch to repository |
| RepositoryApi | repoCancelScheduledAutoMerge | DELETE /repos/{owner}/{repo}/pulls/{index}/merge | Cancel the scheduled auto merge for the given pull request |
| RepositoryApi | repoChangeFiles | POST /repos/{owner}/{repo}/contents | Modify multiple files in a repository |
| RepositoryApi | repoCheckCollaborator | GET /repos/{owner}/{repo}/collaborators/{collaborator} | Check if a user is a collaborator of a repository |
| RepositoryApi | repoCheckFlag | GET /repos/{owner}/{repo}/flags/{flag} | Check if a repository has a given flag |
| RepositoryApi | repoCheckTeam | GET /repos/{owner}/{repo}/teams/{team} | Check if a team is assigned to a repository |
| RepositoryApi | repoCompareDiff | GET /repos/{owner}/{repo}/compare/{basehead} | Get commit comparison information |
| RepositoryApi | repoConvert | POST /repos/{owner}/{repo}/convert | Convert a mirror repo to a normal repo. |
| RepositoryApi | repoCreateBranch | POST /repos/{owner}/{repo}/branches | Create a branch |
| RepositoryApi | repoCreateBranchProtection | POST /repos/{owner}/{repo}/branch_protections | Create a branch protections for a repository |
| RepositoryApi | repoCreateFile | POST /repos/{owner}/{repo}/contents/{filepath} | Create a file in a repository |
| RepositoryApi | repoCreateHook | POST /repos/{owner}/{repo}/hooks | Create a hook |
| RepositoryApi | repoCreateKey | POST /repos/{owner}/{repo}/keys | Add a key to a repository |
| RepositoryApi | repoCreatePullRequest | POST /repos/{owner}/{repo}/pulls | Create a pull request |
| RepositoryApi | repoCreatePullReview | POST /repos/{owner}/{repo}/pulls/{index}/reviews | Create a review to an pull request |
| RepositoryApi | repoCreatePullReviewComment | POST /repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments | Add a new comment to a pull request review |
| RepositoryApi | repoCreatePullReviewRequests | POST /repos/{owner}/{repo}/pulls/{index}/requested_reviewers | Create review requests for a pull request |
| RepositoryApi | repoCreateRelease | POST /repos/{owner}/{repo}/releases | Create a release |
| RepositoryApi | repoCreateReleaseAttachment | POST /repos/{owner}/{repo}/releases/{id}/assets | Create a release attachment |
| RepositoryApi | repoCreateStatus | POST /repos/{owner}/{repo}/statuses/{sha} | Create a commit status |
| RepositoryApi | repoCreateTag | POST /repos/{owner}/{repo}/tags | Create a new git tag in a repository |
| RepositoryApi | repoCreateTagProtection | POST /repos/{owner}/{repo}/tag_protections | Create a tag protections for a repository |
| RepositoryApi | repoCreateWikiPage | POST /repos/{owner}/{repo}/wiki/new | Create a wiki page |
| RepositoryApi | repoDelete | DELETE /repos/{owner}/{repo} | Delete a repository |
| RepositoryApi | repoDeleteAllFlags | DELETE /repos/{owner}/{repo}/flags | Remove all flags from a repository |
| RepositoryApi | repoDeleteAvatar | DELETE /repos/{owner}/{repo}/avatar | Delete a repository's avatar |
| RepositoryApi | repoDeleteBranch | DELETE /repos/{owner}/{repo}/branches/{branch} | Delete a specific branch from a repository |
| RepositoryApi | repoDeleteBranchProtection | DELETE /repos/{owner}/{repo}/branch_protections/{name} | Delete a specific branch protection for the repository |
| RepositoryApi | repoDeleteCollaborator | DELETE /repos/{owner}/{repo}/collaborators/{collaborator} | Delete a collaborator from a repository |
| RepositoryApi | repoDeleteFile | DELETE /repos/{owner}/{repo}/contents/{filepath} | Delete a file in a repository |
| RepositoryApi | repoDeleteFlag | DELETE /repos/{owner}/{repo}/flags/{flag} | Remove a flag from a repository |
| RepositoryApi | repoDeleteGitHook | DELETE /repos/{owner}/{repo}/hooks/git/{id} | Delete a Git hook in a repository |
| RepositoryApi | repoDeleteHook | DELETE /repos/{owner}/{repo}/hooks/{id} | Delete a hook in a repository |
| RepositoryApi | repoDeleteKey | DELETE /repos/{owner}/{repo}/keys/{id} | Delete a key from a repository |
| RepositoryApi | repoDeletePullReview | DELETE /repos/{owner}/{repo}/pulls/{index}/reviews/{id} | Delete a specific review from a pull request |
| RepositoryApi | repoDeletePullReviewComment | DELETE /repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments/{comment} | Delete a pull review comment |
| RepositoryApi | repoDeletePullReviewRequests | DELETE /repos/{owner}/{repo}/pulls/{index}/requested_reviewers | Cancel review requests for a pull request |
| RepositoryApi | repoDeletePushMirror | DELETE /repos/{owner}/{repo}/push_mirrors/{name} | Remove a push mirror from a repository by remoteName |
| RepositoryApi | repoDeleteRelease | DELETE /repos/{owner}/{repo}/releases/{id} | Delete a release |
| RepositoryApi | repoDeleteReleaseAttachment | DELETE /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id} | Delete a release attachment |
| RepositoryApi | repoDeleteReleaseByTag | DELETE /repos/{owner}/{repo}/releases/tags/{tag} | Delete a release by tag name |
| RepositoryApi | repoDeleteTag | DELETE /repos/{owner}/{repo}/tags/{tag} | Delete a repository's tag by name |
| RepositoryApi | repoDeleteTagProtection | DELETE /repos/{owner}/{repo}/tag_protections/{id} | Delete a specific tag protection for the repository |
| RepositoryApi | repoDeleteTeam | DELETE /repos/{owner}/{repo}/teams/{team} | Delete a team from a repository |
| RepositoryApi | repoDeleteTopic | DELETE /repos/{owner}/{repo}/topics/{topic} | Delete a topic from a repository |
| RepositoryApi | repoDeleteWikiPage | DELETE /repos/{owner}/{repo}/wiki/page/{pageName} | Delete a wiki page |
| RepositoryApi | repoDismissPullReview | POST /repos/{owner}/{repo}/pulls/{index}/reviews/{id}/dismissals | Dismiss a review for a pull request |
| RepositoryApi | repoDownloadCommitDiffOrPatch | GET /repos/{owner}/{repo}/git/commits/{sha}.{diffType} | Get a commit's diff or patch |
| RepositoryApi | repoDownloadPullDiffOrPatch | GET /repos/{owner}/{repo}/pulls/{index}.{diffType} | Get a pull request diff or patch |
| RepositoryApi | repoEdit | PATCH /repos/{owner}/{repo} | Edit a repository's properties. Only fields that are set will be changed. |
| RepositoryApi | repoEditBranchProtection | PATCH /repos/{owner}/{repo}/branch_protections/{name} | Edit a branch protections for a repository. Only fields that are set will be changed |
| RepositoryApi | repoEditGitHook | PATCH /repos/{owner}/{repo}/hooks/git/{id} | Edit a Git hook in a repository |
| RepositoryApi | repoEditHook | PATCH /repos/{owner}/{repo}/hooks/{id} | Edit a hook in a repository |
| RepositoryApi | repoEditPullRequest | PATCH /repos/{owner}/{repo}/pulls/{index} | Update a pull request. If using deadline only the date will be taken into account, and time of day ignored. |
| RepositoryApi | repoEditRelease | PATCH /repos/{owner}/{repo}/releases/{id} | Update a release |
| RepositoryApi | repoEditReleaseAttachment | PATCH /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id} | Edit a release attachment |
| RepositoryApi | repoEditTagProtection | PATCH /repos/{owner}/{repo}/tag_protections/{id} | Edit a tag protections for a repository. Only fields that are set will be changed |
| RepositoryApi | repoEditWikiPage | PATCH /repos/{owner}/{repo}/wiki/page/{pageName} | Edit a wiki page |
| RepositoryApi | repoGet | GET /repos/{owner}/{repo} | Get a repository |
| RepositoryApi | repoGetAllCommits | GET /repos/{owner}/{repo}/commits | Get a list of all commits from a repository |
| RepositoryApi | repoGetArchive | GET /repos/{owner}/{repo}/archive/{archive} | Get an archive of a repository |
| RepositoryApi | repoGetAssignees | GET /repos/{owner}/{repo}/assignees | Return all users that have write access and can be assigned to issues |
| RepositoryApi | repoGetBranch | GET /repos/{owner}/{repo}/branches/{branch} | Retrieve a specific branch from a repository, including its effective branch protection |
| RepositoryApi | repoGetBranchProtection | GET /repos/{owner}/{repo}/branch_protections/{name} | Get a specific branch protection for the repository |
| RepositoryApi | repoGetByID | GET /repositories/{id} | Get a repository by id |
| RepositoryApi | repoGetCombinedStatusByRef | GET /repos/{owner}/{repo}/commits/{ref}/status | Get a commit's combined status, by branch/tag/commit reference |
| RepositoryApi | repoGetCommitPullRequest | GET /repos/{owner}/{repo}/commits/{sha}/pull | Get the pull request of the commit |
| RepositoryApi | repoGetContents | GET /repos/{owner}/{repo}/contents/{filepath} | Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir |
| RepositoryApi | repoGetContentsList | GET /repos/{owner}/{repo}/contents | Gets the metadata of all the entries of the root dir |
| RepositoryApi | repoGetEditorConfig | GET /repos/{owner}/{repo}/editorconfig/{filepath} | Get the EditorConfig definitions of a file in a repository |
| RepositoryApi | repoGetGitHook | GET /repos/{owner}/{repo}/hooks/git/{id} | Get a Git hook |
| RepositoryApi | repoGetHook | GET /repos/{owner}/{repo}/hooks/{id} | Get a hook |
| RepositoryApi | repoGetIssueConfig | GET /repos/{owner}/{repo}/issue_config | Returns the issue config for a repo |
| RepositoryApi | repoGetIssueTemplates | GET /repos/{owner}/{repo}/issue_templates | Get available issue templates for a repository |
| RepositoryApi | repoGetKey | GET /repos/{owner}/{repo}/keys/{id} | Get a repository's key by id |
| RepositoryApi | repoGetLanguages | GET /repos/{owner}/{repo}/languages | Get languages and number of bytes of code written |
| RepositoryApi | repoGetLatestRelease | GET /repos/{owner}/{repo}/releases/latest | Gets the most recent non-prerelease, non-draft release of a repository, sorted by created_at |
| RepositoryApi | repoGetNote | GET /repos/{owner}/{repo}/git/notes/{sha} | Get a note corresponding to a single commit from a repository |
| RepositoryApi | repoGetPullRequest | GET /repos/{owner}/{repo}/pulls/{index} | Get a pull request |
| RepositoryApi | repoGetPullRequestByBaseHead | GET /repos/{owner}/{repo}/pulls/{base}/{head} | Get a pull request by base and head |
| RepositoryApi | repoGetPullRequestCommits | GET /repos/{owner}/{repo}/pulls/{index}/commits | Get commits for a pull request |
| RepositoryApi | repoGetPullRequestFiles | GET /repos/{owner}/{repo}/pulls/{index}/files | Get changed files for a pull request |
| RepositoryApi | repoGetPullReview | GET /repos/{owner}/{repo}/pulls/{index}/reviews/{id} | Get a specific review for a pull request |
| RepositoryApi | repoGetPullReviewComment | GET /repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments/{comment} | Get a pull review comment |
| RepositoryApi | repoGetPullReviewComments | GET /repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments | Get a specific review for a pull request |
| RepositoryApi | repoGetPushMirrorByRemoteName | GET /repos/{owner}/{repo}/push_mirrors/{name} | Get push mirror of the repository by remoteName |
| RepositoryApi | repoGetRawFile | GET /repos/{owner}/{repo}/raw/{filepath} | Get a file from a repository |
| RepositoryApi | repoGetRawFileOrLFS | GET /repos/{owner}/{repo}/media/{filepath} | Get a file or it's LFS object from a repository |
| RepositoryApi | repoGetRelease | GET /repos/{owner}/{repo}/releases/{id} | Get a release |
| RepositoryApi | repoGetReleaseAttachment | GET /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id} | Get a release attachment |
| RepositoryApi | repoGetReleaseByTag | GET /repos/{owner}/{repo}/releases/tags/{tag} | Get a release by tag name |
| RepositoryApi | repoGetRepoPermissions | GET /repos/{owner}/{repo}/collaborators/{collaborator}/permission | Get repository permissions for a user |
| RepositoryApi | repoGetReviewers | GET /repos/{owner}/{repo}/reviewers | Return all users that can be requested to review in this repo |
| RepositoryApi | repoGetRunnerRegistrationToken | GET /repos/{owner}/{repo}/actions/runners/registration-token | Get a repository's runner registration token |
| RepositoryApi | repoGetSingleCommit | GET /repos/{owner}/{repo}/git/commits/{sha} | Get a single commit from a repository |
| RepositoryApi | repoGetTag | GET /repos/{owner}/{repo}/tags/{tag} | Get the tag of a repository by tag name |
| RepositoryApi | repoGetTagProtection | GET /repos/{owner}/{repo}/tag_protections/{id} | Get a specific tag protection for the repository |
| RepositoryApi | repoGetWikiPage | GET /repos/{owner}/{repo}/wiki/page/{pageName} | Get a wiki page |
| RepositoryApi | repoGetWikiPageRevisions | GET /repos/{owner}/{repo}/wiki/revisions/{pageName} | Get revisions of a wiki page |
| RepositoryApi | repoGetWikiPages | GET /repos/{owner}/{repo}/wiki/pages | Get all wiki pages |
| RepositoryApi | repoListActionsSecrets | GET /repos/{owner}/{repo}/actions/secrets | List an repo's actions secrets |
| RepositoryApi | repoListActivityFeeds | GET /repos/{owner}/{repo}/activities/feeds | List a repository's activity feeds |
| RepositoryApi | repoListAllGitRefs | GET /repos/{owner}/{repo}/git/refs | Get specified ref or filtered repository's refs |
| RepositoryApi | repoListBranchProtection | GET /repos/{owner}/{repo}/branch_protections | List branch protections for a repository |
| RepositoryApi | repoListBranches | GET /repos/{owner}/{repo}/branches | List a repository's branches |
| RepositoryApi | repoListCollaborators | GET /repos/{owner}/{repo}/collaborators | List a repository's collaborators |
| RepositoryApi | repoListFlags | GET /repos/{owner}/{repo}/flags | List a repository's flags |
| RepositoryApi | repoListGitHooks | GET /repos/{owner}/{repo}/hooks/git | List the Git hooks in a repository |
| RepositoryApi | repoListGitRefs | GET /repos/{owner}/{repo}/git/refs/{ref} | Get specified ref or filtered repository's refs |
| RepositoryApi | repoListHooks | GET /repos/{owner}/{repo}/hooks | List the hooks in a repository |
| RepositoryApi | repoListKeys | GET /repos/{owner}/{repo}/keys | List a repository's keys |
| RepositoryApi | repoListPinnedIssues | GET /repos/{owner}/{repo}/issues/pinned | List a repo's pinned issues |
| RepositoryApi | repoListPinnedPullRequests | GET /repos/{owner}/{repo}/pulls/pinned | List a repo's pinned pull requests |
| RepositoryApi | repoListPullRequests | GET /repos/{owner}/{repo}/pulls | List a repo's pull requests. If a pull request is selected but fails to be retrieved for any reason, it will be a null value in the list of results. |
| RepositoryApi | repoListPullReviews | GET /repos/{owner}/{repo}/pulls/{index}/reviews | List all reviews for a pull request |
| RepositoryApi | repoListPushMirrors | GET /repos/{owner}/{repo}/push_mirrors | Get all push mirrors of the repository |
| RepositoryApi | repoListReleaseAttachments | GET /repos/{owner}/{repo}/releases/{id}/assets | List release's attachments |
| RepositoryApi | repoListReleases | GET /repos/{owner}/{repo}/releases | List a repo's releases |
| RepositoryApi | repoListStargazers | GET /repos/{owner}/{repo}/stargazers | List a repo's stargazers |
| RepositoryApi | repoListStatuses | GET /repos/{owner}/{repo}/statuses/{sha} | Get a commit's statuses |
| RepositoryApi | repoListStatusesByRef | GET /repos/{owner}/{repo}/commits/{ref}/statuses | Get a commit's statuses, by branch/tag/commit reference |
| RepositoryApi | repoListSubscribers | GET /repos/{owner}/{repo}/subscribers | List a repo's watchers |
| RepositoryApi | repoListTagProtection | GET /repos/{owner}/{repo}/tag_protections | List tag protections for a repository |
| RepositoryApi | repoListTags | GET /repos/{owner}/{repo}/tags | List a repository's tags |
| RepositoryApi | repoListTeams | GET /repos/{owner}/{repo}/teams | List a repository's teams |
| RepositoryApi | repoListTopics | GET /repos/{owner}/{repo}/topics | Get list of topics that a repository has |
| RepositoryApi | repoMergePullRequest | POST /repos/{owner}/{repo}/pulls/{index}/merge | Merge a pull request |
| RepositoryApi | repoMigrate | POST /repos/migrate | Migrate a remote git repository |
| RepositoryApi | repoMirrorSync | POST /repos/{owner}/{repo}/mirror-sync | Sync a mirrored repository |
| RepositoryApi | repoNewPinAllowed | GET /repos/{owner}/{repo}/new_pin_allowed | Returns if new Issue Pins are allowed |
| RepositoryApi | repoPullRequestIsMerged | GET /repos/{owner}/{repo}/pulls/{index}/merge | Check if a pull request has been merged |
| RepositoryApi | repoPushMirrorSync | POST /repos/{owner}/{repo}/push_mirrors-sync | Sync all push mirrored repository |
| RepositoryApi | repoRemoveNote | DELETE /repos/{owner}/{repo}/git/notes/{sha} | Removes a note corresponding to a single commit from a repository |
| RepositoryApi | repoReplaceAllFlags | PUT /repos/{owner}/{repo}/flags | Replace all flags of a repository |
| RepositoryApi | repoSearch | GET /repos/search | Search for repositories |
| RepositoryApi | repoSearchRunJobs | GET /repos/{owner}/{repo}/actions/runners/jobs | Search for repository's action jobs according filter conditions |
| RepositoryApi | repoSetNote | POST /repos/{owner}/{repo}/git/notes/{sha} | Set a note corresponding to a single commit from a repository |
| RepositoryApi | repoSigningKey | GET /repos/{owner}/{repo}/signing-key.gpg | Get signing-key.gpg for given repository |
| RepositoryApi | repoSubmitPullReview | POST /repos/{owner}/{repo}/pulls/{index}/reviews/{id} | Submit a pending review to an pull request |
| RepositoryApi | repoSyncForkBranch | POST /repos/{owner}/{repo}/sync_fork/{branch} | Syncs a fork branch with the base branch |
| RepositoryApi | repoSyncForkBranchInfo | GET /repos/{owner}/{repo}/sync_fork/{branch} | Gets information about syncing a fork branch with the base branch |
| RepositoryApi | repoSyncForkDefault | POST /repos/{owner}/{repo}/sync_fork | Syncs the default branch of a fork with the base branch |
| RepositoryApi | repoSyncForkDefaultInfo | GET /repos/{owner}/{repo}/sync_fork | Gets information about syncing the fork default branch with the base branch |
| RepositoryApi | repoTestHook | POST /repos/{owner}/{repo}/hooks/{id}/tests | Test a push webhook |
| RepositoryApi | repoTrackedTimes | GET /repos/{owner}/{repo}/times | List a repo's tracked times |
| RepositoryApi | repoTransfer | POST /repos/{owner}/{repo}/transfer | Transfer a repo ownership |
| RepositoryApi | repoUnDismissPullReview | POST /repos/{owner}/{repo}/pulls/{index}/reviews/{id}/undismissals | Cancel to dismiss a review for a pull request |
| RepositoryApi | repoUpdateAvatar | POST /repos/{owner}/{repo}/avatar | Update a repository's avatar |
| RepositoryApi | repoUpdateBranch | PATCH /repos/{owner}/{repo}/branches/{branch} | Update a branch |
| RepositoryApi | repoUpdateFile | PUT /repos/{owner}/{repo}/contents/{filepath} | Update a file in a repository |
| RepositoryApi | repoUpdatePullRequest | POST /repos/{owner}/{repo}/pulls/{index}/update | Merge PR's baseBranch into headBranch |
| RepositoryApi | repoUpdateTopics | PUT /repos/{owner}/{repo}/topics | Replace list of topics for a repository |
| RepositoryApi | repoValidateIssueConfig | GET /repos/{owner}/{repo}/issue_config/validate | Returns the validation information for a issue config |
| RepositoryApi | topicSearch | GET /topics/search | Search for topics by keyword |
| RepositoryApi | updateRepoSecret | PUT /repos/{owner}/{repo}/actions/secrets/{secretname} | Create or Update a secret value in a repository |
| RepositoryApi | updateRepoVariable | PUT /repos/{owner}/{repo}/actions/variables/{variablename} | Update a repo-level variable |
| RepositoryApi | userCurrentCheckSubscription | GET /repos/{owner}/{repo}/subscription | Check if the current user is watching a repo |
| RepositoryApi | userCurrentDeleteSubscription | DELETE /repos/{owner}/{repo}/subscription | Unwatch a repo |
| RepositoryApi | userCurrentPutSubscription | PUT /repos/{owner}/{repo}/subscription | Watch a repo |
| RepositoryApi | userTrackedTimes | GET /repos/{owner}/{repo}/times/{user} | List a user's tracked times in a repo |
| SettingsApi | getGeneralAPISettings | GET /settings/api | Get instance's global settings for api |
| SettingsApi | getGeneralAttachmentSettings | GET /settings/attachment | Get instance's global settings for Attachment |
| SettingsApi | getGeneralRepositorySettings | GET /settings/repository | Get instance's global settings for repositories |
| SettingsApi | getGeneralUISettings | GET /settings/ui | Get instance's global settings for ui |
| UserApi | createCurrentUserRepo | POST /user/repos | Create a repository |
| UserApi | createUserVariable | POST /user/actions/variables/{variablename} | Create a user-level variable |
| UserApi | deleteUserRunner | DELETE /user/actions/runners/{runner_id} | Delete a particular user-level runner |
| UserApi | deleteUserSecret | DELETE /user/actions/secrets/{secretname} | Delete a secret in a user scope |
| UserApi | deleteUserVariable | DELETE /user/actions/variables/{variablename} | Delete a user-level variable which is created by current doer |
| UserApi | getUserRunner | GET /user/actions/runners/{runner_id} | Get a particular runner that belongs to the user |
| UserApi | getUserRunners | GET /user/actions/runners | Get the user's runners |
| UserApi | getUserSettings | GET /user/settings | Get current user's account settings |
| UserApi | getUserVariable | GET /user/actions/variables/{variablename} | Get a user-level variable which is created by current doer |
| UserApi | getUserVariablesList | GET /user/actions/variables | Get the user-level list of variables which is created by current doer |
| UserApi | getVerificationToken | GET /user/gpg_key_token | Get a Token to verify |
| UserApi | registerUserRunner | POST /user/actions/runners | Register a new user-level runner |
| UserApi | updateUserSecret | PUT /user/actions/secrets/{secretname} | Create or Update a secret value in a user scope |
| UserApi | updateUserSettings | PATCH /user/settings | Update settings in current user's account |
| UserApi | updateUserVariable | PUT /user/actions/variables/{variablename} | Update a user-level variable which is created by current doer |
| UserApi | userAddEmail | POST /user/emails | Add an email addresses to the current user's account |
| UserApi | userBlockUser | PUT /user/block/{username} | Blocks a user from the doer |
| UserApi | userCheckFollowing | GET /users/{username}/following/{target} | Check if one user is following another user |
| UserApi | userCheckQuota | GET /user/quota/check | Check if the authenticated user is over quota for a given subject |
| UserApi | userCreateHook | POST /user/hooks | Create a hook |
| UserApi | userCreateOAuth2Application | POST /user/applications/oauth2 | Creates a new OAuth2 application |
| UserApi | userCreateToken | POST /users/{username}/tokens | Generate an access token for the specified user |
| UserApi | userCurrentCheckFollowing | GET /user/following/{username} | Check whether a user is followed by the authenticated user |
| UserApi | userCurrentCheckStarring | GET /user/starred/{owner}/{repo} | Whether the authenticated is starring the repo |
| UserApi | userCurrentDeleteFollow | DELETE /user/following/{username} | Unfollow a user |
| UserApi | userCurrentDeleteGPGKey | DELETE /user/gpg_keys/{id} | Remove a GPG public key from current user's account |
| UserApi | userCurrentDeleteKey | DELETE /user/keys/{id} | Delete a public key |
| UserApi | userCurrentDeleteStar | DELETE /user/starred/{owner}/{repo} | Unstar the given repo |
| UserApi | userCurrentGetGPGKey | GET /user/gpg_keys/{id} | Get a GPG key |
| UserApi | userCurrentGetKey | GET /user/keys/{id} | Get a public key |
| UserApi | userCurrentListFollowers | GET /user/followers | List the authenticated user's followers |
| UserApi | userCurrentListFollowing | GET /user/following | List the users that the authenticated user is following |
| UserApi | userCurrentListGPGKeys | GET /user/gpg_keys | List the authenticated user's GPG keys |
| UserApi | userCurrentListKeys | GET /user/keys | List the authenticated user's public keys |
| UserApi | userCurrentListRepos | GET /user/repos | List the repos that the authenticated user owns |
| UserApi | userCurrentListStarred | GET /user/starred | The repos that the authenticated user has starred |
| UserApi | userCurrentListSubscriptions | GET /user/subscriptions | List repositories watched by the authenticated user |
| UserApi | userCurrentPostGPGKey | POST /user/gpg_keys | Add a GPG public key to current user's account |
| UserApi | userCurrentPostKey | POST /user/keys | Create a public key |
| UserApi | userCurrentPutFollow | PUT /user/following/{username} | Follow a user |
| UserApi | userCurrentPutStar | PUT /user/starred/{owner}/{repo} | Star the given repo |
| UserApi | userCurrentTrackedTimes | GET /user/times | List the current user's tracked times |
| UserApi | userDeleteAccessToken | DELETE /users/{username}/tokens/{token} | Delete an access token from the specified user's account |
| UserApi | userDeleteAvatar | DELETE /user/avatar | Delete avatar of the current user. It will be replaced by a default one |
| UserApi | userDeleteEmail | DELETE /user/emails | Delete email addresses from the current user's account |
| UserApi | userDeleteHook | DELETE /user/hooks/{id} | Delete a hook |
| UserApi | userDeleteOAuth2Application | DELETE /user/applications/oauth2/{id} | Delete an OAuth2 application |
| UserApi | userEditHook | PATCH /user/hooks/{id} | Update a hook |
| UserApi | userGet | GET /users/{username} | Get a user |
| UserApi | userGetCurrent | GET /user | Get the authenticated user |
| UserApi | userGetHeatmapData | GET /users/{username}/heatmap | Get a user's heatmap |
| UserApi | userGetHook | GET /user/hooks/{id} | Get a hook |
| UserApi | userGetOAuth2Application | GET /user/applications/oauth2/{id} | Get an OAuth2 application |
| UserApi | userGetOAuth2Applications | GET /user/applications/oauth2 | List the authenticated user's oauth2 applications |
| UserApi | userGetQuota | GET /user/quota | Get quota information for the authenticated user |
| UserApi | userGetRunnerRegistrationToken | GET /user/actions/runners/registration-token | Get the user's runner registration token |
| UserApi | userGetStopWatches | GET /user/stopwatches | Get list of all existing stopwatches |
| UserApi | userGetTokens | GET /users/{username}/tokens | List the specified user's access tokens |
| UserApi | userListActivityFeeds | GET /users/{username}/activities/feeds | List a user's activity feeds |
| UserApi | userListBlockedUsers | GET /user/list_blocked | List the authenticated user's blocked users |
| UserApi | userListEmails | GET /user/emails | List all email addresses of the current user |
| UserApi | userListFollowers | GET /users/{username}/followers | List the given user's followers |
| UserApi | userListFollowing | GET /users/{username}/following | List the users that the given user is following |
| UserApi | userListGPGKeys | GET /users/{username}/gpg_keys | List the given user's GPG keys |
| UserApi | userListHooks | GET /user/hooks | List the authenticated user's webhooks |
| UserApi | userListKeys | GET /users/{username}/keys | List the given user's public keys |
| UserApi | userListQuotaArtifacts | GET /user/quota/artifacts | List the artifacts affecting the authenticated user's quota |
| UserApi | userListQuotaAttachments | GET /user/quota/attachments | List the attachments affecting the authenticated user's quota |
| UserApi | userListQuotaPackages | GET /user/quota/packages | List the packages affecting the authenticated user's quota |
| UserApi | userListRepos | GET /users/{username}/repos | List the repos owned by the given user |
| UserApi | userListStarred | GET /users/{username}/starred | The repos that the given user has starred |
| UserApi | userListSubscriptions | GET /users/{username}/subscriptions | List the repositories watched by a user |
| UserApi | userListTeams | GET /user/teams | List all the teams a user belongs to |
| UserApi | userSearch | GET /users/search | Search for users |
| UserApi | userSearchRunJobs | GET /user/actions/runners/jobs | Search for user's action jobs according filter conditions |
| UserApi | userUnblockUser | PUT /user/unblock/{username} | Unblocks a user from the doer |
| UserApi | userUpdateAvatar | POST /user/avatar | Update avatar of the current user |
| UserApi | userUpdateOAuth2Application | PATCH /user/applications/oauth2/{id} | Update an OAuth2 application, this includes regenerating the client secret |
| UserApi | userVerifyGPGKey | POST /user/gpg_key_verify | Verify a GPG key |
Documentation for Models
- APIError
- APIForbiddenError
- APIInternalServerError
- APIInvalidTopicsError
- APINotFound
- APIRepoArchivedError
- APIUnauthorizedError
- APIValidationError
- AccessToken
- ActionRun
- ActionRunJob
- ActionRunner
- ActionTask
- ActionTaskResponse
- ActionVariable
- Activity
- ActivityPub
- AddCollaboratorOption
- AddTimeOption
- AnnotatedTag
- AnnotatedTagObject
- Attachment
- BlockedUser
- Branch
- BranchProtection
- ChangeFileOperation
- ChangeFilesOptions
- ChangedFile
- CombinedStatus
- Comment
- Commit
- CommitAffectedFiles
- CommitDateOptions
- CommitMeta
- CommitStats
- CommitStatus
- CommitUser
- Compare
- ContentsResponse
- CreateAccessTokenOption
- CreateBranchProtectionOption
- CreateBranchRepoOption
- CreateEmailOption
- CreateFileOptions
- CreateForkOption
- CreateGPGKeyOption
- CreateHookOption
- CreateIssueCommentOption
- CreateIssueOption
- CreateKeyOption
- CreateLabelOption
- CreateMilestoneOption
- CreateOAuth2ApplicationOptions
- CreateOrUpdateSecretOption
- CreateOrgOption
- CreatePullRequestOption
- CreatePullReviewComment
- CreatePullReviewOptions
- CreatePushMirrorOption
- CreateQuotaGroupOptions
- CreateQuotaRuleOptions
- CreateReleaseOption
- CreateRepoOption
- CreateStatusOption
- CreateTagOption
- CreateTagProtectionOption
- CreateTeamOption
- CreateUserOption
- CreateVariableOption
- CreateWikiPageOptions
- Cron
- DeleteEmailOption
- DeleteFileOptions
- DeleteLabelsOption
- DeployKey
- DismissPullReviewOptions
- DispatchWorkflowOption
- DispatchWorkflowRun
- EditAttachmentOptions
- EditBranchProtectionOption
- EditDeadlineOption
- EditGitHookOption
- EditHookOption
- EditIssueCommentOption
- EditIssueOption
- EditLabelOption
- EditMilestoneOption
- EditOrgOption
- EditPullRequestOption
- EditQuotaRuleOptions
- EditReactionOption
- EditReleaseOption
- EditRepoOption
- EditTagProtectionOption
- EditTeamOption
- EditUserOption
- ExternalTracker
- ExternalWiki
- FileCommitResponse
- FileDeleteResponse
- FileLinksResponse
- FileResponse
- FilesResponse
- GPGKey
- GPGKeyEmail
- GeneralAPISettings
- GeneralAttachmentSettings
- GeneralRepoSettings
- GeneralUISettings
- GenerateRepoOption
- GitBlob
- GitEntry
- GitHook
- GitObject
- GitTreeResponse
- GitignoreTemplateInfo
- Hook
- Identity
- InternalTracker
- Issue
- IssueConfig
- IssueConfigContactLink
- IssueConfigValidation
- IssueDeadline
- IssueFormField
- IssueLabelsOption
- IssueMeta
- IssueTemplate
- Label
- LabelTemplate
- LicenseTemplateInfo
- LicensesTemplateListEntry
- ListActionRunResponse
- MarkdownOption
- MarkupOption
- MergePullRequestOption
- MigrateRepoOptions
- Milestone
- ModelPackage
- NewIssuePinsAllowed
- NodeInfo
- NodeInfoServices
- NodeInfoSoftware
- NodeInfoUsage
- NodeInfoUsageUsers
- Note
- NoteOptions
- NotificationCount
- NotificationSubject
- NotificationThread
- OAuth2Application
- Organization
- OrganizationPermissions
- PRBranchInfo
- PackageFile
- PayloadCommit
- PayloadCommitVerification
- PayloadUser
- Permission
- PublicKey
- PullRequest
- PullRequestMeta
- PullReview
- PullReviewComment
- PullReviewRequestOptions
- PushMirror
- QuotaGroup
- QuotaInfo
- QuotaRuleInfo
- QuotaUsed
- QuotaUsedArtifact
- QuotaUsedAttachment
- QuotaUsedAttachmentContainedIn
- QuotaUsedPackage
- QuotaUsedSize
- QuotaUsedSizeAssets
- QuotaUsedSizeAssetsAttachments
- QuotaUsedSizeAssetsPackages
- QuotaUsedSizeGit
- QuotaUsedSizeRepos
- Reaction
- Reference
- RegisterRunnerOptions
- RegisterRunnerResponse
- RegistrationToken
- Release
- RenameOrgOption
- RenameUserOption
- ReplaceFlagsOption
- RepoCollaboratorPermission
- RepoCommit
- RepoCreateReleaseAttachmentRequest
- RepoTargetOption
- RepoTopicOptions
- RepoTransfer
- Repository
- RepositoryMeta
- SearchResults
- Secret
- ServerVersion
- SetUserQuotaGroupsOptions
- StopWatch
- SubmitPullReviewOptions
- SyncForkInfo
- Tag
- TagArchiveDownloadCount
- TagProtection
- Team
- TeamSearchResults
- TimelineComment
- TopicName
- TopicResponse
- TopicSearchResults
- TrackedTime
- TransferRepoOption
- UpdateBranchRepoOption
- UpdateFileOptions
- UpdateRepoAvatarOption
- UpdateUserAvatarOption
- UpdateVariableOption
- User
- UserHeatmapData
- UserSearchResults
- UserSettings
- UserSettingsOptions
- VerifyGPGKeyOption
- WatchInfo
- WikiCommit
- WikiCommitList
- WikiPage
- WikiPageMetaData
Documentation for Authorization
Authentication schemes defined for the API:
AuthorizationHeaderToken
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
BasicAuth
- Type: HTTP basic authentication
SudoHeader
- Type: API key
- API key parameter name: Sudo
- Location: HTTP header
SudoParam
- Type: API key
- API key parameter name: sudo
- Location: URL query string
TOTPHeader
- Type: API key
- API key parameter name: X-FORGEJO-OTP
- Location: HTTP header
Recommendation
It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.