Uninstall a team

Removes a team from this daemon’s catalog. Idempotent: uninstalling a team that isn’t installed succeeds with removed: false.

When the daemon is connected to CliqHub the removal is reported right away. Agent settings no other installed team needs are cleaned up in the background.

From the CLI: cliq team uninstall @acme/code-review.

No credential is needed from this machine. From another host, send Authorization: Bearer with a dispatch token CliqHub signed for this daemon or a cliq_tok_… personal token of a user in the daemon’s realm; this only works once the daemon is connected to CliqHub. See Authentication.

POST

teams

uninstall

Uninstall a team

curl --request POST \
  --url http://127.0.0.1:4900/v1/teams/uninstall \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scope": "acme",
  "slug": "code-review"
}
'

import requests

url = "http://127.0.0.1:4900/v1/teams/uninstall"

payload = {
    "scope": "acme",
    "slug": "code-review"
}
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({scope: 'acme', slug: 'code-review'})
};

fetch('http://127.0.0.1:4900/v1/teams/uninstall', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "4900",
  CURLOPT_URL => "http://127.0.0.1:4900/v1/teams/uninstall",
  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([
    'scope' => 'acme',
    'slug' => 'code-review'
  ]),
  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://127.0.0.1:4900/v1/teams/uninstall"

	payload := strings.NewReader("{\n  \"scope\": \"acme\",\n  \"slug\": \"code-review\"\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("http://127.0.0.1:4900/v1/teams/uninstall")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"scope\": \"acme\",\n  \"slug\": \"code-review\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://127.0.0.1:4900/v1/teams/uninstall")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"scope\": \"acme\",\n  \"slug\": \"code-review\"\n}"

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

{
  "ok": true,
  "data": {
    "scope": "acme",
    "slug": "code-review",
    "removed": true
  }
}

Authorizations

Authorization

string

header

required

Not needed from the same machine. From another host: a dispatch JWT CliqHub signed for this daemon, or a cliq_tok_… personal token whose user is in the daemon's realm.

Body

application/json

scope

string

required

Team scope (org namespace)

Minimum string length: 1

slug

string

required

Team slug

Minimum string length: 1

version

string

Version to uninstall (default: latest)

Minimum string length: 1

force

boolean

Allow uninstalling a Hub-origin team

latest

boolean

When multiple versions exist, pick the latest

Response

Success.

boolean

required

data

object

required

Show child attributes

Uninstall a team

curl --request POST \
  --url http://127.0.0.1:4900/v1/teams/uninstall \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scope": "acme",
  "slug": "code-review"
}
'

import requests

url = "http://127.0.0.1:4900/v1/teams/uninstall"

payload = {
    "scope": "acme",
    "slug": "code-review"
}
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({scope: 'acme', slug: 'code-review'})
};

fetch('http://127.0.0.1:4900/v1/teams/uninstall', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "4900",
  CURLOPT_URL => "http://127.0.0.1:4900/v1/teams/uninstall",
  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([
    'scope' => 'acme',
    'slug' => 'code-review'
  ]),
  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://127.0.0.1:4900/v1/teams/uninstall"

	payload := strings.NewReader("{\n  \"scope\": \"acme\",\n  \"slug\": \"code-review\"\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("http://127.0.0.1:4900/v1/teams/uninstall")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"scope\": \"acme\",\n  \"slug\": \"code-review\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://127.0.0.1:4900/v1/teams/uninstall")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"scope\": \"acme\",\n  \"slug\": \"code-review\"\n}"

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

{
  "ok": true,
  "data": {
    "scope": "acme",
    "slug": "code-review",
    "removed": true
  }
}

Introduction

System

Teams

Workspaces

Runs

Artifacts

Agents

Settings

Instances

Daemon

Sign-in

Local tokens

HUG

Hub commands

Uninstall a team

Authorizations

Body

Response