Delete an alias

DELETE

/v1/aliases/{name}

curl -X DELETE -H "X-Api-Key: $KEY" http://localhost:9027/v1/aliases/letter

package main

import (
  "io"
  "log"
  "net/http"
  "os"
)

func main() {
  request, err := http.NewRequest("DELETE", "http://localhost:9027/v1/aliases/letter", nil)
  if err != nil {
    log.Fatal(err)
  }
  request.Header.Set("X-Api-Key", os.Getenv("KEY"))

  response, err := http.DefaultClient.Do(request)
  if err != nil {
    log.Fatal(err)
  }
  defer response.Body.Close()
  if response.StatusCode >= 300 {
    message, _ := io.ReadAll(response.Body)
    log.Fatalf("%s: %s", response.Status, message)
  }
}

Deletes an alias and its history. The templates it named stay. Setting it again starts at version 1.

Authorizations

api_key
bearer
basic

Parameters

Path Parameters

name

required

string

The alias

Responses

204

Deleted

404

This caller has no such alias

application/json

The JSON body of every error response.

object

error

required

A stable, machine-readable kind.

string

message

required

What went wrong, for a person.

string

Example

{
  "error": "invalid_request",
  "message": "unknown step 'teleport'"
}

501

RUSTICDOC_STORE is not set

application/json

The JSON body of every error response.

object

error

required

A stable, machine-readable kind.

string

message

required

What went wrong, for a person.

string

Example

{
  "error": "invalid_request",
  "message": "unknown step 'teleport'"
}

503

The store cannot be reached

application/json

The JSON body of every error response.

object

error

required

A stable, machine-readable kind.

string

message

required

What went wrong, for a person.

string

Example

{
  "error": "invalid_request",
  "message": "unknown step 'teleport'"
}