Update a Docs7 site
curl --request PATCH \
--url https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"hosting": "on",
"slug": "<string>",
"analyticsUrl": "<string>",
"customDomain": "<string>",
"customDomainPath": "<string>",
"branch": "<string>",
"docsPath": "<string>",
"context7Index": true
}
'import requests
url = "https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}"
payload = {
"hosting": "on",
"slug": "<string>",
"analyticsUrl": "<string>",
"customDomain": "<string>",
"customDomainPath": "<string>",
"branch": "<string>",
"docsPath": "<string>",
"context7Index": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
hosting: 'on',
slug: '<string>',
analyticsUrl: '<string>',
customDomain: '<string>',
customDomainPath: '<string>',
branch: '<string>',
docsPath: '<string>',
context7Index: true
})
};
fetch('https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}', 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://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'hosting' => 'on',
'slug' => '<string>',
'analyticsUrl' => '<string>',
'customDomain' => '<string>',
'customDomainPath' => '<string>',
'branch' => '<string>',
'docsPath' => '<string>',
'context7Index' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}"
payload := strings.NewReader("{\n \"hosting\": \"on\",\n \"slug\": \"<string>\",\n \"analyticsUrl\": \"<string>\",\n \"customDomain\": \"<string>\",\n \"customDomainPath\": \"<string>\",\n \"branch\": \"<string>\",\n \"docsPath\": \"<string>\",\n \"context7Index\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"hosting\": \"on\",\n \"slug\": \"<string>\",\n \"analyticsUrl\": \"<string>\",\n \"customDomain\": \"<string>\",\n \"customDomainPath\": \"<string>\",\n \"branch\": \"<string>\",\n \"docsPath\": \"<string>\",\n \"context7Index\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"hosting\": \"on\",\n \"slug\": \"<string>\",\n \"analyticsUrl\": \"<string>\",\n \"customDomain\": \"<string>\",\n \"customDomainPath\": \"<string>\",\n \"branch\": \"<string>\",\n \"docsPath\": \"<string>\",\n \"context7Index\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"repoUrl": "<string>",
"docsPath": "<string>",
"hosting": "off",
"platformHostname": "acme-docs.docs7.io",
"customDomainStatus": "none",
"context7Index": true,
"improveSchedule": "off",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"repositoryId": "<string>",
"installationId": 123,
"branch": "<string>",
"defaultBranch": "<string>",
"analyticsUrl": "<string>",
"workerName": "<string>",
"customDomain": "<string>",
"customDomainPath": "<string>",
"customDomainRouting": "dns",
"customHostnameId": "<string>",
"customDomainError": "<string>",
"customDomainRecords": [
{
"purpose": "domain_ownership",
"type": "CNAME",
"name": "<string>",
"value": "<string>"
}
],
"context7LibraryName": "/acme/docs",
"pullRequestReview": {
"enabled": true,
"response": "comment"
},
"codeWatch": {
"enabled": true,
"repositories": [
{
"repositoryId": "<string>",
"repoUrl": "<string>"
}
]
},
"buildFixSchedule": "off",
"snippetSchedule": "off"
},
"deploymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"context7Notice": "<string>"
}{
"error": "invalid_payload"
}{
"error": "unauthorized",
"message": "Authentication required."
}{
"error": "docs7_pro_required"
}{
"error": "not_found",
"message": "Site not found."
}{
"error": "slug_conflict"
}{
"error": "internal_error",
"message": "Internal server error."
}{
"error": "site_update_failed"
}Docs7 Sites
Update a Docs7 site
Change settings of a GitHub site. Send only the fields to change. Owners and admins can send every field; a developer can only send { "hosting": "on" } to publish a site added for the agents only. A new slug or custom domain path starts a rebuild. A new Code Watch repository is checked against the caller’s GitHub access. Only for GitHub sites: a CLI site (source: "local") answers 404.
PATCH
/
v2
/
teamspaces
/
{teamspaceId}
/
sites
/
{siteId}
Update a Docs7 site
curl --request PATCH \
--url https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"hosting": "on",
"slug": "<string>",
"analyticsUrl": "<string>",
"customDomain": "<string>",
"customDomainPath": "<string>",
"branch": "<string>",
"docsPath": "<string>",
"context7Index": true
}
'import requests
url = "https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}"
payload = {
"hosting": "on",
"slug": "<string>",
"analyticsUrl": "<string>",
"customDomain": "<string>",
"customDomainPath": "<string>",
"branch": "<string>",
"docsPath": "<string>",
"context7Index": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
hosting: 'on',
slug: '<string>',
analyticsUrl: '<string>',
customDomain: '<string>',
customDomainPath: '<string>',
branch: '<string>',
docsPath: '<string>',
context7Index: true
})
};
fetch('https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}', 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://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'hosting' => 'on',
'slug' => '<string>',
'analyticsUrl' => '<string>',
'customDomain' => '<string>',
'customDomainPath' => '<string>',
'branch' => '<string>',
'docsPath' => '<string>',
'context7Index' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}"
payload := strings.NewReader("{\n \"hosting\": \"on\",\n \"slug\": \"<string>\",\n \"analyticsUrl\": \"<string>\",\n \"customDomain\": \"<string>\",\n \"customDomainPath\": \"<string>\",\n \"branch\": \"<string>\",\n \"docsPath\": \"<string>\",\n \"context7Index\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"hosting\": \"on\",\n \"slug\": \"<string>\",\n \"analyticsUrl\": \"<string>\",\n \"customDomain\": \"<string>\",\n \"customDomainPath\": \"<string>\",\n \"branch\": \"<string>\",\n \"docsPath\": \"<string>\",\n \"context7Index\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"hosting\": \"on\",\n \"slug\": \"<string>\",\n \"analyticsUrl\": \"<string>\",\n \"customDomain\": \"<string>\",\n \"customDomainPath\": \"<string>\",\n \"branch\": \"<string>\",\n \"docsPath\": \"<string>\",\n \"context7Index\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"repoUrl": "<string>",
"docsPath": "<string>",
"hosting": "off",
"platformHostname": "acme-docs.docs7.io",
"customDomainStatus": "none",
"context7Index": true,
"improveSchedule": "off",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"repositoryId": "<string>",
"installationId": 123,
"branch": "<string>",
"defaultBranch": "<string>",
"analyticsUrl": "<string>",
"workerName": "<string>",
"customDomain": "<string>",
"customDomainPath": "<string>",
"customDomainRouting": "dns",
"customHostnameId": "<string>",
"customDomainError": "<string>",
"customDomainRecords": [
{
"purpose": "domain_ownership",
"type": "CNAME",
"name": "<string>",
"value": "<string>"
}
],
"context7LibraryName": "/acme/docs",
"pullRequestReview": {
"enabled": true,
"response": "comment"
},
"codeWatch": {
"enabled": true,
"repositories": [
{
"repositoryId": "<string>",
"repoUrl": "<string>"
}
]
},
"buildFixSchedule": "off",
"snippetSchedule": "off"
},
"deploymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"context7Notice": "<string>"
}{
"error": "invalid_payload"
}{
"error": "unauthorized",
"message": "Authentication required."
}{
"error": "docs7_pro_required"
}{
"error": "not_found",
"message": "Site not found."
}{
"error": "slug_conflict"
}{
"error": "internal_error",
"message": "Internal server error."
}{
"error": "site_update_failed"
}Authorizations
Get your API key at context7.com/dashboard. Treat your API key like a password and store it securely. Every key can read the management API (/v2/teamspaces/*), except personal data: member and invitation emails, library requesters, visitor questions, Docs7 reader searches, conversations, feedback and feature requests, and the GitHub account behind a build. To read those or make changes there, the key must be created with Write access ticked; other keys get 403 write_access_required.
Path Parameters
Teamspace id.
Docs7 site id.
Body
application/json
Only the fields to change.
Publish a site added for the agents only. One way; delete the site to stop publishing. The only field a developer can send.
Available options:
on Required string length:
3 - 40Available options:
dns, proxy Required string length:
1 - 255Available options:
off, daily, weekly PR Review Agent settings.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
When the Build Fix Agent fixes the issues of the latest production build (hosted sites).
Available options:
off, after_build, daily, weekly Whether the Example Check Agent runs every code example of the docs once a month (Docs7 Pro).
Available options:
off, monthly Response
The updated site
A Docs7 site built from a GitHub repository.
Show child attributes
Show child attributes
The first build when this call published the site.
Why Context7 could not index the repository, when context7Index was turned on but the library cannot refresh.
Was this page helpful?