Canonical URLs

Update canonical URL

Set or unset the canonical URL for a deployment's convex.cloud or convex.site domain. This allows you to customize the CONVEX_SITE_URL and CONVEX_CLOUD_URL environment variables in your deployment.

post/update_canonical_url

Request

  • Base URL: https://happy-animal-123.convex.cloud/api/v1
  • URL: https://happy-animal-123.convex.cloud/api/v1/update_canonical_url
  • Auth: one of:
    • API key in header Authorization
    • API key in header Authorization
    • API key in header Authorization
    • API key in header Authorization

Request body

requestDestination'convexCloud' | 'convexSite' required
urlstring nullable

The new canonical URL. Omit this to reset the canonical URl to the default value.

Changes

No recorded changes to this operation across all 1 revision of this API.