Get file contents

Returns the raw source content of a file at a given repository path and optional git ref.

GET /api/source

Get file contents

cURL

curl --request GET \
  --url https://api.example.com/api/source \
  --header 'Authorization: Bearer <token>'

200

{
  "source": "<string>",
  "language": "<string>",
  "path": "<string>",
  "repo": "<string>",
  "webUrl": "<string>",
  "repoDisplayName": "<string>",
  "repoExternalWebUrl": "<string>",
  "externalWebUrl": "<string>"
}

Authorizations

bearerTokenapiKeyHeader

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your API key.

Query Parameters

path · string · required

repo · string · required

ref · string

Response

200

application/json

File source and metadata.

source · string · required

language · string · required

path · string · required

repo · string · required

repoCodeHostType · enum<string> · required

Available options: github, gitlab, gitea, gerrit, bitbucketServer, bitbucketCloud, genericGitHost, azuredevops

webUrl · string · required

repoDisplayName · string

repoExternalWebUrl · string

externalWebUrl · string