GOgogs
Repositories

Get contents

Get the contents of a file, directory, symlink, or submodule in a repository.

get/repos/{owner}/{repo}/contents/{path}

Request

  • Base URL
    https://gogs.example.com/api/v1
  • Auth
    API key in header Authorization

Path parameters

ownerstring required

Repository owner

repostring required

Repository name

pathstring required

File or directory path

Query parameters

refstring

Branch, tag, or commit. Defaults to the default branch.

Response

Success

type'file' | 'dir' | 'symlink' | 'submodule'
encodingstring
sizeinteger
namestring
pathstring
contentstring
shastring
urlstring
git_urlstring
html_urlstring
download_urlstring

Changes

No recorded changes to this operation across all 3 revisions of this API.