Get a repository wiki

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

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

fetch('https://api.example.com/api/wiki', 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/wiki",
  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/wiki"

	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/wiki")

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

{
  "exists": true,
  "docCount": 123,
  "url": "<string>",
  "lastUpdatedAt": "<string>",
  "lastUpdatedCommit": "<string>"
}

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

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

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

GET

api

wiki

Get a repository wiki

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

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

fetch('https://api.example.com/api/wiki', 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/wiki",
  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/wiki"

	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/wiki")

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

{
  "exists": true,
  "docCount": 123,
  "url": "<string>",
  "lastUpdatedAt": "<string>",
  "lastUpdatedCommit": "<string>"
}

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

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

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

This endpoint is rate limited. Each call counts toward your daily request limit.

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

repo

string

required

The fully-qualified repository name.

Response

Whether the repository has a wiki, with a link when it does.

exists

boolean

required

Whether the repository has a wiki with at least one doc.

docCount

integer

required

The number of docs in the wiki, including its README overview.

url

string

The wiki's home page in the Sourcebot web app. Omitted when exists is false.

lastUpdatedAt

string

When a scan last updated the wiki, in ISO 8601. A scan updates each doc it checks against the code, even when the doc's text stays the same. Omitted when no scan has updated a doc.

lastUpdatedCommit

string

The SHA of the repository's commit that the wiki was last updated against. Present when lastUpdatedAt is.

Overview

Search & Navigation

Repositories

Connections

Scoped Access Tokens

Git

Enterprise Management

System

Get a repository wiki

Authorizations

Query Parameters

Response