COcontext7
Docs7 Sites

Update a Docs7 site

Changed on

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}

Request

  • Base URL
    https://context7.com/api
  • URL
    https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}
  • Auth
    HTTP bearer

Path parameters

teamspaceIdstring uuid required

Teamspace id.

siteIdstring uuid required

Docs7 site id.

Request body

hosting'on'

Publish a site added for the agents only. One way; delete the site to stop publishing. The only field a developer can send.

slugstring
analyticsUrlstring uri nullable
customDomainstring nullable
customDomainPathstring nullable
customDomainRouting'dns' | 'proxy' nullable
branchstring nullable
docsPathstring
context7Indexboolean
improveSchedule'off' | 'daily' | 'weekly'
buildFixSchedule'off' | 'after_build' | 'daily' | 'weekly'

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

snippetSchedule'off' | 'monthly'

Whether the Example Check Agent runs every code example of the docs once a month (Docs7 Pro).

Response

The updated site

deploymentIdstring uuid nullable required

The first build when this call published the site.

context7Noticestring nullable required

Why Context7 could not index the repository, when context7Index was turned on but the library cannot refresh.

Example response

{
  "data": {
    "platformHostname": "acme-docs.docs7.io",
    "context7LibraryName": "/acme/docs"
  }
}

Changes