Documentation
Types
Aliases
AssignAliasProps

AssignAliasProps

export interface AssignAliasProps {
    /**
     * The ID of the deployment the aliases should be listed for
     * @example dpl_FjvFJncQHQcZMznrUm9EoB8sFuPa
     */
    id: string;
 
    /**
     * The Team identifier or slug to perform the request on behalf of.
     */
    teamId?: string;
 
    /**
     * The alias we want to assign to the deployment defined in the URL
     * @example my-alias.vercel.app
     */
    alias?: string;
 
    /**
     * The redirect property will take precedence over the deployment
     * id from the URL and consists of a hostname (like test.com) to
     * which the alias should redirect using status code 307
     */
    redirect?: string | null;
}