Skip to content
Management API Reference

Gets current vanity subdomain config

get/v1/projects/{ref}/vanity-subdomain

This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.

This endpoint is currently in its Beta stage.

OAuth scopes

  • domains:read

This endpoint is only available on the following plans:

  • Pro
  • Team
  • Enterprise

The fine-grained token must include the following permissions to access this endpoint:

  • vanity_subdomain_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 400
  • 401
  • 403
  • 429
  • 500

Response (200)

{
  "status": "not-used",
  "custom_domain": "lorem"
}