Gitea API.
  1. repository
Gitea API.
  • admin
    • List cron tasks
    • Run cron task
    • List all organizations
    • List unadopted repositories
    • Delete unadopted files
    • Adopt unadopted files as a repository
    • List all users
    • Create a user
    • Delete a user
    • Edit an existing user
    • Add a public key on behalf of a user
    • Delete a user's public key
    • Create an organization
    • Create a repository on behalf of a user
  • miscellaneous
    • Render a markdown document as HTML
    • Render raw markdown as HTML
    • Get default signing-key.gpg
    • Returns the version of the Gitea application
  • notification
    • List users's notification threads
    • Mark notification threads as read, pinned or unread
    • Check if unread notifications exist
    • Get notification thread by ID
    • Mark notification thread as read by ID
    • List users's notification threads on a specific repo
    • Mark notification threads as read, pinned or unread on a specific repo
  • organization
    • Create a repository in an organization
    • Get list of organizations
    • Create an organization
    • Delete an organization
    • Get an organization
    • Edit an organization
    • List an organization's webhooks
    • Create a hook
    • Delete a hook
    • Get a hook
    • Update a hook
    • List an organization's labels
    • Create a label for an organization
    • Delete a label
    • Get a single label
    • Update a label
    • List an organization's members
    • Remove a member from an organization
    • Check if a user is a member of an organization
    • List an organization's public members
    • Conceal a user's membership
    • Check if a user is a public member of an organization
    • Publicize a user's membership
    • List an organization's repos
    • Create a repository in an organization
    • List an organization's teams
    • Create a team
    • Search for teams within an organization
    • Delete a team
    • Get a team
    • Edit a team
    • List a team's members
    • Remove a team member
    • List a particular member of team
    • Add a team member
    • List a team's repos
    • Remove a repository from a team
    • Add a repository to a team
    • List the current user's organizations
    • List a user's organizations
  • issue
    • Search for issues across the repositories that the user has access to
    • List a repository's issues
    • Create an issue. If using deadline only the date will be taken into account, and time of day ignored.
    • List all comments in a repository
    • Delete a comment
    • Get a comment
    • Edit a comment
    • Remove a reaction from a comment of an issue
    • Get a list of reactions from a comment of an issue
    • Add a reaction to a comment of an issue
    • Get an issue
    • Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.
    • List all comments on an issue
    • Add a comment to an issue
    • Delete a comment
    • Edit a comment
    • 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.
    • Remove all labels from an issue
    • Get an issue's labels
    • Add a label to an issue
    • Replace an issue's labels
    • Remove a label from an issue
    • Remove a reaction from an issue
    • Get a list reactions of an issue
    • Add a reaction to an issue
    • Delete an issue's existing stopwatch.
    • Start stopwatch on an issue.
    • Stop an issue's existing stopwatch.
    • Get users who subscribed on an issue.
    • Check if user is subscribed to an issue
    • Unsubscribe user from issue
    • Subscribe user to issue
    • Reset a tracked time of an issue
    • List an issue's tracked times
    • Add tracked time to a issue
    • Delete specific tracked time
    • Get all of a repository's labels
    • Create a label
    • Delete a label
    • Get a single label
    • Update a label
    • Get all of a repository's opened milestones
    • Create a milestone
    • Delete a milestone
    • Get a milestone
    • Update a milestone
  • repository
    • Migrate a remote git repository
      POST
    • Search for repositories
      GET
    • Delete a repository
      DELETE
    • Get a repository
      GET
    • Edit a repository's properties. Only fields that are set will be changed.
      PATCH
    • Get an archive of a repository
      GET
    • Return all users that have write access and can be assigned to issues
      GET
    • List branch protections for a repository
      GET
    • Create a branch protections for a repository
      POST
    • Delete a specific branch protection for the repository
      DELETE
    • Get a specific branch protection for the repository
      GET
    • Edit a branch protections for a repository. Only fields that are set will be changed
      PATCH
    • List a repository's branches
      GET
    • Create a branch
      POST
    • Delete a specific branch from a repository
      DELETE
    • Retrieve a specific branch from a repository, including its effective branch protection
      GET
    • List a repository's collaborators
      GET
    • Delete a collaborator from a repository
      DELETE
    • Check if a user is a collaborator of a repository
      GET
    • Add a collaborator to a repository
      PUT
    • Get a list of all commits from a repository
      GET
    • Get a commit's combined status, by branch/tag/commit reference
      GET
    • Get a commit's statuses, by branch/tag/commit reference
      GET
    • Gets the metadata of all the entries of the root dir
      GET
    • Delete a file in a repository
      DELETE
    • Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir
      GET
    • Create a file in a repository
      POST
    • Update a file in a repository
      PUT
    • Get the EditorConfig definitions of a file in a repository
      GET
    • List a repository's forks
      GET
    • Fork a repository
      POST
    • Gets the blob of a repository.
      GET
    • Get a single commit from a repository
      GET
    • Get a note corresponding to a single commit from a repository
      GET
    • Get specified ref or filtered repository's refs
      GET
    • Get specified ref or filtered repository's refs
      GET
    • Gets the tag object of an annotated tag (not lightweight tags)
      GET
    • Gets the tree of a repository.
      GET
    • List the hooks in a repository
      GET
    • Create a hook
      POST
    • List the Git hooks in a repository
      GET
    • Delete a Git hook in a repository
      DELETE
    • Get a Git hook
      GET
    • Edit a Git hook in a repository
      PATCH
    • Delete a hook in a repository
      DELETE
    • Get a hook
      GET
    • Edit a hook in a repository
      PATCH
    • Test a push webhook
      POST
    • Get available issue templates for a repository
      GET
    • List a repository's keys
      GET
    • Add a key to a repository
      POST
    • Delete a key from a repository
      DELETE
    • Get a repository's key by id
      GET
    • Get languages and number of bytes of code written
      GET
    • Sync a mirrored repository
      POST
    • List a repo's pull requests
      GET
    • Create a pull request
      POST
    • Get a pull request
      GET
    • Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.
      PATCH
    • Get a pull request diff
      GET
    • Get a pull request patch file
      GET
    • Get commits for a pull request
      GET
    • Check if a pull request has been merged
      GET
    • Merge a pull request
      POST
    • cancel review requests for a pull request
      DELETE
    • create review requests for a pull request
      POST
    • List all reviews for a pull request
      GET
    • Create a review to an pull request
      POST
    • Delete a specific review from a pull request
      DELETE
    • Get a specific review for a pull request
      GET
    • Submit a pending review to an pull request
      POST
    • Get a specific review for a pull request
      GET
    • Dismiss a review for a pull request
      POST
    • Cancel to dismiss a review for a pull request
      POST
    • Merge PR's baseBranch into headBranch
      POST
    • Get a file from a repository
      GET
    • List a repo's releases
      GET
    • Create a release
      POST
    • Delete a release by tag name
      DELETE
    • Get a release by tag name
      GET
    • Delete a release
      DELETE
    • Get a release
      GET
    • Update a release
      PATCH
    • List release's attachments
      GET
    • Create a release attachment
      POST
    • Delete a release attachment
      DELETE
    • Get a release attachment
      GET
    • Edit a release attachment
      PATCH
    • Return all users that can be requested to review in this repo
      GET
    • Get signing-key.gpg for given repository
      GET
    • List a repo's stargazers
      GET
    • Get a commit's statuses
      GET
    • Create a commit status
      POST
    • List a repo's watchers
      GET
    • Unwatch a repo
      DELETE
    • Check if the current user is watching a repo
      GET
    • Watch a repo
      PUT
    • List a repository's tags
      GET
    • Create a new git tag in a repository
      POST
    • Delete a repository's tag by name
      DELETE
    • Get the tag of a repository by tag name
      GET
    • List a repository's teams
      GET
    • Delete a team from a repository
      DELETE
    • Check if a team is assigned to a repository
      GET
    • Add a team to a repository
      PUT
    • List a repo's tracked times
      GET
    • List a user's tracked times in a repo
      GET
    • Get list of topics that a repository has
      GET
    • Replace list of topics for a repository
      PUT
    • Delete a topic from a repository
      DELETE
    • Add a topic to a repository
      PUT
    • Transfer a repo ownership
      POST
    • Create a repository using a template
      POST
    • Get a repository by id
      GET
    • search topics via keyword
      GET
    • Create a repository
      POST
  • settings
    • Get instance's global settings for api
    • Get instance's global settings for Attachment
    • Get instance's global settings for repositories
    • Get instance's global settings for ui
  • user
    • Get the authenticated user
    • List the authenticated user's oauth2 applications
    • creates a new OAuth2 application
    • delete an OAuth2 Application
    • get an OAuth2 Application
    • update an OAuth2 Application, this includes regenerating the client secret
    • Delete email addresses
    • List the authenticated user's email addresses
    • Add email addresses
    • List the authenticated user's followers
    • List the users that the authenticated user is following
    • Unfollow a user
    • Check whether a user is followed by the authenticated user
    • Follow a user
    • Get a Token to verify
    • Verify a GPG key
    • List the authenticated user's GPG keys
    • Create a GPG key
    • Remove a GPG key
    • Get a GPG key
    • List the authenticated user's public keys
    • Create a public key
    • Delete a public key
    • Get a public key
    • List the repos that the authenticated user owns
    • Get user settings
    • Update user settings
    • The repos that the authenticated user has starred
    • Unstar the given repo
    • Whether the authenticated is starring the repo
    • Star the given repo
    • Get list of all existing stopwatches
    • List repositories watched by the authenticated user
    • List all the teams a user belongs to
    • List the current user's tracked times
    • Search for users
    • Check if one user is following another user
    • Get a user
    • List the given user's followers
    • List the users that the given user is following
    • List the given user's GPG keys
    • Get a user's heatmap
    • List the given user's public keys
    • List the repos owned by the given user
    • The repos that the given user has starred
    • List the repositories watched by a user
    • List the authenticated user's access tokens
    • Create an access token
    • delete an access token
  1. repository

Create a file in a repository

POST
/repos/{owner}/{repo}/contents/{filepath}
repository
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v1/repos///contents/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "author": {
        "email": "user@example.com",
        "name": "string"
    },
    "branch": "string",
    "committer": {
        "email": "user@example.com",
        "name": "string"
    },
    "content": "string",
    "dates": {
        "author": "2019-08-24T14:15:22Z",
        "committer": "2019-08-24T14:15:22Z"
    },
    "message": "string",
    "new_branch": "string",
    "signoff": true
}'
Response Response Example
201 - Example 1
{
    "commit": {
        "author": {
            "date": "string",
            "email": "user@example.com",
            "name": "string"
        },
        "committer": {
            "date": "string",
            "email": "user@example.com",
            "name": "string"
        },
        "created": "2019-08-24T14:15:22Z",
        "html_url": "string",
        "message": "string",
        "parents": [
            {
                "created": "2019-08-24T14:15:22Z",
                "sha": "string",
                "url": "string"
            }
        ],
        "sha": "string",
        "tree": {
            "created": "2019-08-24T14:15:22Z",
            "sha": "string",
            "url": "string"
        },
        "url": "string"
    },
    "content": {
        "_links": {
            "git": "string",
            "html": "string",
            "self": "string"
        },
        "content": "string",
        "download_url": "string",
        "encoding": "string",
        "git_url": "string",
        "html_url": "string",
        "name": "string",
        "path": "string",
        "sha": "string",
        "size": 0,
        "submodule_git_url": "string",
        "target": "string",
        "type": "string",
        "url": "string"
    },
    "verification": {
        "payload": "string",
        "reason": "string",
        "signature": "string",
        "signer": {
            "email": "user@example.com",
            "name": "string",
            "username": "string"
        },
        "verified": true
    }
}

Request

Path Params
owner
string 
required
owner of the repo
repo
string 
required
name of the repo
filepath
string 
required
path of the file to create
Body Params application/json
CreateFileOptions options for creating files Note: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)
author
object (Identity) 
optional
Identity for a person's identity like an author or committer
email
string <email>
optional
name
string 
optional
branch
string 
optional
branch (optional) to base this file from. if not given, the default branch is used
committer
object (Identity) 
optional
Identity for a person's identity like an author or committer
content
string 
required
content must be base64 encoded
dates
object (CommitDateOptions) 
optional
CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE
author
string <date-time>
optional
committer
string <date-time>
optional
message
string 
optional
message (optional) for the commit of this file. if not supplied, a default message will be used
new_branch
string 
optional
new_branch (optional) will make a new branch from branch before creating the file
signoff
boolean 
optional
Add a Signed-off-by trailer by the committer at the end of the commit log message.
Examples

Responses

🟢201OK
application/json
Body
FileResponse contains information about a repo's file
commit
object (FileCommitResponse contains information generated from a Git commit for a repo's file.) 
optional
author
object (CommitUser contains information of a user in the context of a commit.) 
optional
committer
object (CommitUser contains information of a user in the context of a commit.) 
optional
created
string <date-time>
optional
html_url
string 
optional
message
string 
optional
parents
array[object (CommitMeta contains meta information of a commit in terms of API.) {3}] 
optional
sha
string 
optional
tree
object (CommitMeta contains meta information of a commit in terms of API.) 
optional
url
string 
optional
content
object (ContentsResponse) 
optional
ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content
_links
object (FileLinksResponse) 
optional
FileLinksResponse contains the links for a repo's file
content
string 
optional
content is populated when type is file, otherwise null
download_url
string 
optional
encoding
string 
optional
encoding is populated when type is file, otherwise null
git_url
string 
optional
html_url
string 
optional
name
string 
optional
path
string 
optional
sha
string 
optional
size
integer <int64>
optional
submodule_git_url
string 
optional
submodule_git_url is populated when type is submodule, otherwise null
target
string 
optional
target is populated when type is symlink, otherwise null
type
string 
optional
type will be file, dir, symlink, or submodule
url
string 
optional
verification
object (PayloadCommitVerification) 
optional
PayloadCommitVerification represents the GPG verification of a commit
payload
string 
optional
reason
string 
optional
signature
string 
optional
signer
object (PayloadUser) 
optional
PayloadUser represents the author or committer of a commit
verified
boolean 
optional
🟠403403
🟠404404
🟠422422
Modified at 2022-09-10 23:12:52
Previous
Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir
Next
Update a file in a repository
Built with