Sign in
aliases

Delete Alias

Delete a stored alias in one scope.

Scoped by workspace_id and user_id for the same reason the upsert is: deleting one workspace's alias must not touch another's, deleting the workspace-wide alias must not take a user's override with it, and deleting an override must leave the workspace-wide one serving everyone else.

delete/v1/aliases/{name}

Path parameters

namestring required

Query parameters

user_idstring nullable

Delete the alias scoped to this user. Omit to delete the workspace-wide alias of that name.

Delete the alias scoped to this user. Omit to delete the workspace-wide alias of that name.

workspace_idstring uuid nullable

Delete the alias in this workspace. Omit for the deployment's default workspace.

Delete the alias in this workspace. Omit for the deployment's default workspace.

Response

Successful Response

Changes