Skip to content
Management API Reference

[Beta] Gets current vanity subdomain config

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

OAuth scopes

  • domains:read

This endpoint is only available on the following plans:

  • Pro
  • Team
  • Enterprise

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

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

Response (200)

1
{
2
  "status": "not-used",
3
  "custom_domain": "lorem"
4
}