Get file contents

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/source', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/source",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/source"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/source")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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

{
  "statusCode": 123,
  "errorCode": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "errorCode": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "errorCode": "<string>",
  "message": "<string>"
}

GET

api

source

Get file contents

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/source', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/source",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/source"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/source")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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

{
  "statusCode": 123,
  "errorCode": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "errorCode": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "errorCode": "<string>",
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>. The token may be a Sourcebot API key, OAuth access token, or scoped access token, subject to endpoint requirements.

Query Parameters

path

string

required

repo

string

required

ref

string

Response

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

blobSha

string

⌘I

Overview

Search & Navigation

Repositories

Scoped Access Tokens

Git

Enterprise Management

System

Get file contents

Authorizations

Query Parameters

Response