Check a custom domain again

post/v2/teamspaces/{teamspaceId}/sites/{siteId}/domain/refresh

Request example

curl --request POST \
  --url https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}/domain/refresh \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}/domain/refresh"
headers = {
    "Authorization": "Bearer <token>",
}

response = requests.request("POST", url, headers=headers)

print(response.text)

const response = await fetch('https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}/domain/refresh', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <token>'
  }
});

const data = await response.json();
console.log(data);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}/domain/refresh',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <token>',
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

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

func main() {
	url := "https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}/domain/refresh"

	req, _ := http.NewRequest("POST", 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))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}/domain/refresh"))
    .header("Authorization", "Bearer <token>")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

require 'uri'
require 'net/http'

url = URI('https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}/domain/refresh')

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = url.scheme == 'https'

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

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

Response

{
  "data": {
    "id": "<string>",
    "projectId": "<string>",
    "createdBy": "<string>",
    "repoUrl": "<string>",
    "repositoryId": "<string>",
    "installationId": 1,
    "branch": "<string>",
    "defaultBranch": "<string>",
    "docsPath": "<string>",
    "hosting": "off",
    "analyticsUrl": "<string>",
    "workerName": "<string>",
    "platformHostname": "acme-docs.docs7.io",
    "customDomain": "<string>",
    "customDomainPath": "<string>",
    "customDomainRouting": "dns",
    "customHostnameId": "<string>",
    "customDomainStatus": "none",
    "customDomainError": "<string>",
    "customDomainRecords": [
      {
        "purpose": "domain_ownership",
        "type": "CNAME",
        "name": "<string>",
        "value": "<string>"
      }
    ],
    "context7Index": true,
    "context7LibraryName": "/acme/docs",
    "improveSchedule": "off",
    "pullRequestReview": {
      "enabled": true,
      "response": "comment"
    },
    "codeWatch": {
      "enabled": true,
      "repositories": [
        {
          "repositoryId": "<string>",
          "repoUrl": "<string>"
        }
      ]
    },
    "createdAt": "2026-08-10T12:00:00Z",
    "updatedAt": "2026-08-10T12:00:00Z",
    "buildFixSchedule": "off"
  }
}

{
  "error": "invalid_id",
  "message": "Invalid site id."
}

{
  "error": "unauthorized",
  "message": "Authentication required."
}

{
  "error": "forbidden",
  "message": "You do not have permission to do this."
}

{
  "error": "not_found",
  "message": "Site not found."
}

{
  "error": "custom_domain_not_configured"
}

{
  "error": "internal_error",
  "message": "Internal server error."
}

{
  "error": "domain_refresh_failed",
  "message": "Failed to refresh the custom domain"
}

post/v2/teamspaces/{teamspaceId}/sites/{siteId}/domain/refresh

Authorization

Authorizationstringheaderrequired#

Get your API key at context7.com/dashboard. Treat your API key like a password and store it securely.

Path parameters

teamspaceIdstringrequired#

Teamspace id.

siteIdstringrequired#

Docs7 site id.

Responses

application/json

The site with the new domain state

dataobjectrequired#

A Docs7 site built from a GitHub repository.

Show child attributes

idstringrequired#

projectIdstringrequired#

Teamspace id.

createdBystring#

repoUrlstringrequired#

repositoryIdstring#

GitHub repository id.

installationIdinteger#

GitHub App installation id.

branchstring#

Pinned production branch. Null follows the default branch.

defaultBranchstring#

docsPathstringrequired#

Docs folder in the repository; . is the root.

hostingenum<string>required#

off: added for the agents only, nothing is published.

Options:offon

analyticsUrlstring#

External docs URL for browser analytics of a site that Docs7 does not host.

workerNamestring#

platformHostnamestringrequired#

customDomainstring#

customDomainPathstring#

Path prefix the docs are served under on the custom domain.

customDomainRoutingenum<string>#

Options:dnsproxy

customHostnameIdstring#

customDomainStatusenum<string>required#

Options:nonepending_ownershippending_dnspending_validationpending_certificatepending_proxyactivefailed

customDomainErrorstring#

customDomainRecordsobject[]#

Show child attributes

purposeenum<string>required#

Options:domain_ownershiptls_certificate

typeenum<string>required#

Options:CNAMETXT

namestringrequired#

valuestringrequired#

context7Indexbooleanrequired#

Whether the repository is indexed in Context7.

context7LibraryNamestring#

improveScheduleenum<string>required#

How often the Context7 Agent runs on its own.

Options:offdailyweekly

pullRequestReviewobject#

PR Review Agent settings.

Show child attributes

enabledbooleanrequired#

responseenum<string>required#

What the agent does with its fixes. The findings comment is always posted, and every check always runs.

Options:commentpull_requestcommit

codeWatchobject#

Code Watch Agent settings: code repositories whose merged pull requests can change the docs.

Show child attributes

enabledbooleanrequired#

repositoriesobject[]required#

Show child attributes

repositoryIdstringrequired#

repoUrlstringrequired#

createdAtstringrequired#

updatedAtstringrequired#

buildFixScheduleenum<string>#

When the Build Fix Agent fixes the issues of the latest production build (hosted sites).

Options:offafter_builddailyweekly

Update a Docs7 site List deployments