Skip to content
Management API Reference

[Beta] Checks vanity subdomain availability

post/v1/projects/{ref}/vanity-subdomain/check-availability

OAuth scopes

  • domains:write

This endpoint is only available on the following plans:

  • Pro
  • Team
  • Enterprise

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • vanity_subdomain
    Required
    string

Response codes

  • 201
  • 400
  • 401
  • 403
  • 429
  • 500

Response (201)

1
{
2
  "available": true
3
}