Create Link

Create a new recording link for a domain

POST /public/workspace/{workspaceId}/links

Create recording link

cURL

curl --request POST \
  --url https://api.userplane.io/api/v1/public/workspace/{workspaceId}/links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domainId": "<string>",
  "linkReusable": false,
  "projectId": "<string>",
  "linkReference": "<string>",
  "linkMeta": {}
}
'

import requests

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

payload = {
    "domainId": "<string>",
    "linkReusable": False,
    "projectId": "<string>",
    "linkReference": "<string>",
    "linkMeta": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    domainId: '<string>',
    linkReusable: false,
    projectId: '<string>',
    linkReference: '<string>',
    linkMeta: {}
  })
};

fetch('https://api.userplane.io/api/v1/public/workspace/{workspaceId}/links', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'domainId' => '<string>',
    'linkReusable' => false,
    'projectId' => '<string>',
    'linkReference' => '<string>',
    'linkMeta' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"domainId\": \"<string>\",\n  \"linkReusable\": false,\n  \"projectId\": \"<string>\",\n  \"linkReference\": \"<string>\",\n  \"linkMeta\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.userplane.io/api/v1/public/workspace/{workspaceId}/links")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"domainId\": \"<string>\",\n  \"linkReusable\": false,\n  \"projectId\": \"<string>\",\n  \"linkReference\": \"<string>\",\n  \"linkMeta\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"domainId\": \"<string>\",\n  \"linkReusable\": false,\n  \"projectId\": \"<string>\",\n  \"linkReference\": \"<string>\",\n  \"linkMeta\": {}\n}"

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

200

{
  "message": "<string>",
  "data": {
    "workspaceId": "<string>",
    "link": {
      "linkId": "<string>",
      "linkTitle": "<string>",
      "linkReusable": true,
      "linkProviderId": "<string>",
      "linkProviderReference": "<string>",
      "linkURL": "<string>",
      "linkMeta": {},
      "createdAt": "<unknown>",
      "project": {
        "projectId": "<string>",
        "title": "<string>"
      },
      "creator": {
        "workspaceMemberId": "<string>",
        "name": "<string>"
      },
      "domain": {
        "domainId": "<string>",
        "url": "<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 create 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>"
}

Creates a new recording link in the specified workspace.

Errors

Error code	Status	Description
LINK_DEFAULT_PROJECT_NOT_FOUND	404	No default project found for workspace
LINK_PROJECT_DELETED	410	The specified project has been deleted
LINK_CREATE_FAILED	500	Failed to create the link
PLAN_LIMIT_EXCEEDED	403	Workspace plan limit exceeded

Also returns common authentication errors.

Related

List Links

View all links in a workspace

Get Link

Retrieve the created link by ID

Update Link

Update link settings after creation

List Projects

Find project IDs for link creation

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

Body

application/json

domainId · string · required

Minimum string length: 1

linkReusable · boolean · default: false · required

projectId · string

Minimum string length: 1

linkReference · string

Maximum string length: 2048

linkMeta · object

Show child attributes

Response

200

application/json

OK

message · string · required

data · object · required

Show child attributes