Documentation
Classes
Managers
AliasesManager

AliasesManager

Extends BaseManager

export class AliasesManager extends BaseManager {}

Methods

assign(props)

Creates a new alias for the deployment with the given deployment ID. The authenticated user or team must own this deployment. If the desired alias is already assigned to another deployment, then it will be removed from the old deployment and assigned to the new one. API Reference (opens in a new tab)

props

Return Type

Promise<AssignAliasReturnType>

delete(props)

Delete an Alias with the specified ID. API Reference (opens in a new tab)

props

Return Type

Promise<DeleteAliasReturnType>

get(props)

Retrieves an Alias for the given host name or alias ID. API Reference (opens in a new tab)

props

Return Type

Promise<GetAliasReturnType>