hot.dev/supabase-admin / ::supabase::admin::domains

Functions

activate-custom-hostname

fn (project-ref: Str): Map

Activate a verified custom hostname. DNS must be verified first.

activate-vanity-subdomain

fn (request: ActivateVanitySubdomainRequest): Map

Activate a vanity subdomain for a project (e.g. myapp.supabase.co).

check-vanity-subdomain

fn (request: CheckVanitySubdomainRequest): Map

Check if a vanity subdomain is available.

Example

::domains ::supabase::admin::domains

result ::domains/check-vanity-subdomain(::domains/CheckVanitySubdomainRequest({
  project_ref: "my-project-ref",
  vanity_subdomain: "myapp"
}))
result.available  // => true

delete-custom-hostname

fn (project-ref: Str): Map

Remove the custom hostname configuration for a project.

delete-vanity-subdomain

fn (project-ref: Str): Map

Remove the vanity subdomain for a project.

get-custom-hostname

fn (project-ref: Str): DomainConfig

Get the custom hostname configuration for a project.

Example

::domains ::supabase::admin::domains

config ::domains/get-custom-hostname("my-project-ref")
// => {custom_hostname: "api.myapp.com", status: "ACTIVE", ...}

get-vanity-subdomain

fn (project-ref: Str): Map

Get the vanity subdomain configuration for a project.

ns alias

Alias of ::supabase::admin::domains/

update-custom-hostname

fn (request: UpdateCustomHostnameRequest): Map

Configure a custom hostname for a project. You must set up DNS records (CNAME) before activating.

Example

::domains ::supabase::admin::domains

::domains/update-custom-hostname(::domains/UpdateCustomHostnameRequest({
  project_ref: "my-project-ref",
  custom_hostname: "api.myapp.com"
}))

verify-custom-hostname

fn (project-ref: Str): Map

Verify DNS configuration for a custom hostname.

Types

ActivateVanitySubdomainRequest

ActivateVanitySubdomainRequest type {
    project_ref: Str,
    vanity_subdomain: Str
}

CheckVanitySubdomainRequest

CheckVanitySubdomainRequest type {
    project_ref: Str,
    vanity_subdomain: Str
}

DomainConfig

DomainConfig type {
    custom_hostname: Str?,
    status: Str?,
    data: Map?
}

UpdateCustomHostnameRequest

UpdateCustomHostnameRequest type {
    project_ref: Str,
    custom_hostname: Str
}