workspace
Delete a workspace
Permanently deletes a workspace, every team, project, environment, secret and member. This action cannot be undone.
DELETE
/
v1
/
workspace
/
{ws}
cURL
curl -X DELETE 'http://localhost:8080/v1/workspace/ws_example' \
-H 'Authorization: Bearer ek_live_xxxxx' \
-H 'Content-Type: application/json' \
-d '{ // request body fields, see schema }'const response = await fetch('http://localhost:8080/v1/workspace/ws_example', {
method: 'DELETE',
headers: {
Authorization: 'Bearer ek_live_xxxxx',
'Content-Type': 'application/json',
},
body: JSON.stringify({
// request body fields, see schema
}),
});
const data = await response.json();import requests
response = requests.delete(
'http://localhost:8080/v1/workspace/ws_example',
headers={
'Authorization': 'Bearer ek_live_xxxxx',
'Content-Type': 'application/json',
},
json={
# request body fields, see schema
},
)
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/v1/workspace/{ws}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'reason' => '<string>'
]),
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 := "http://localhost:8080/v1/workspace/{ws}"
payload := strings.NewReader("{\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("DELETE", 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.delete("http://localhost:8080/v1/workspace/{ws}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/v1/workspace/{ws}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true
}Authorizations
API key authentication. Pass Authorization: Bearer ek_live_xxxxx on every request.
Path Parameters
Required string length:
2 - 48Pattern:
^[a-z0-9-]+$Body
application/json
Required string length:
1 - 1000Response
200 - application/json
Default Response
Previous
Get your workspace roleReturns the authenticated user's role in a workspace (`admin`, `developer` or `member`). Useful for client-side permission checks.
Next
⌘I
cURL
curl -X DELETE 'http://localhost:8080/v1/workspace/ws_example' \
-H 'Authorization: Bearer ek_live_xxxxx' \
-H 'Content-Type: application/json' \
-d '{ // request body fields, see schema }'const response = await fetch('http://localhost:8080/v1/workspace/ws_example', {
method: 'DELETE',
headers: {
Authorization: 'Bearer ek_live_xxxxx',
'Content-Type': 'application/json',
},
body: JSON.stringify({
// request body fields, see schema
}),
});
const data = await response.json();import requests
response = requests.delete(
'http://localhost:8080/v1/workspace/ws_example',
headers={
'Authorization': 'Bearer ek_live_xxxxx',
'Content-Type': 'application/json',
},
json={
# request body fields, see schema
},
)
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/v1/workspace/{ws}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'reason' => '<string>'
]),
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 := "http://localhost:8080/v1/workspace/{ws}"
payload := strings.NewReader("{\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("DELETE", 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.delete("http://localhost:8080/v1/workspace/{ws}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/v1/workspace/{ws}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true
}