Delete Link

Delete a recording link

DELETE /public/workspace/{workspaceId}/links/{linkId}

Delete recording link

cURL

curl --request DELETE \
  --url https://api.userplane.io/api/v1/public/workspace/{workspaceId}/links/{linkId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.userplane.io/api/v1/public/workspace/{workspaceId}/links/{linkId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.userplane.io/api/v1/public/workspace/{workspaceId}/links/{linkId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.userplane.io/api/v1/public/workspace/{workspaceId}/links/{linkId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.userplane.io/api/v1/public/workspace/{workspaceId}/links/{linkId}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.delete("https://api.userplane.io/api/v1/public/workspace/{workspaceId}/links/{linkId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.userplane.io/api/v1/public/workspace/{workspaceId}/links/{linkId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "message": "<string>",
  "data": {
    "workspaceId": "<string>",
    "linkId": "<string>"
  }
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "Invalid request parameters. Check the request body and query parameters. See https://docs.userplane.io/api/error-handling",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "API key is required. Include it as Authorization: Bearer <your-api-key>. See https://docs.userplane.io/api/authentication",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "The API key is disabled. Enable it or create a new key. See https://docs.userplane.io/api/authentication",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "Workspace not found",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "Workspace has been deleted",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "Rate limit exceeded. Wait and retry with exponential backoff. See https://docs.userplane.io/api/rate-limits",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "Failed to delete link",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "API key verification service is temporarily unavailable. Please try again later. See https://docs.userplane.io/api/error-handling",
  "data": "<unknown>"
}

Soft-deletes a recording link. Only the link creator or a workspace admin/owner can delete a link.

This is a soft delete. The link data is preserved but becomes inaccessible. Subsequent requests for this link return 410 Gone.

Errors

Error code	Status	Description
LINK_NOT_FOUND	404	Link does not exist
LINK_GONE	410	Link has already been deleted
LINK_DELETE_FORBIDDEN	403	You do not have permission to delete this link
LINK_DELETE_FAILED	500	Failed to delete the link

Also returns common authentication errors.

Related

List Links

View all active links in the workspace

Create Link

Create a new recording link

Get Link

Retrieve link details by ID

Error Handling

Understand 410 Gone and other error codes

Authorizations

Authorization · string · header · required

API key with uspl_ prefix. Create keys at dash.userplane.io/_/account?tab=developers

Path Parameters

workspaceId · string · required

Minimum string length: 1

linkId · string · required

Minimum string length: 1

Response

200

application/json

OK

message · string · required

data · object · required

Show child attributes