Delete an Alias | Edgenivo SDK

APIs & SDKs

Delete an Alias

DEL/__remote/api.vercel.com/v2/aliases/{aliasId}

Delete an Alias with the specified ID.

Request

import { Edgenivo } from "@vercel/sdk";

const vercel = new Edgenivo({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.aliases.deleteAlias({
    aliasId: "2WjyKQmM8ZnGcJsPWMrHRHrE",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();

Response

{
  "status": "SUCCESS"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

aliasIdanyRequired

The ID or alias that will be removed

Query parameters

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Response

200The alias was successfully removed

statusstringRequired

Errors

400One of the provided values in the request query is invalid.

401The request is not authorized.

403You do not have permission to access this resource.

404The alias was not found

410Error

Request

import { Edgenivo } from "@vercel/sdk";

const vercel = new Edgenivo({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.aliases.deleteAlias({
    aliasId: "2WjyKQmM8ZnGcJsPWMrHRHrE",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();

Response

{
  "status": "SUCCESS"
}

OpenAPI Specification