Publish a team

Publishes a version so it can be installed. For a new team, or one with no version yet, send the package as data_base64 (a zip with team.yml, at most 10 MB); otherwise the latest version is published again with the new visibility, tags and description. version sets the number, or bump picks the next one; versions only go up. cliq team publish builds the package for you.

Requires a signed-in user token (Authorization: Bearer cliq_tok_…). Results are limited to what that user can see.

POST

teams

publish

Publish a team

curl --request POST \
  --url https://{host}/v1/teams/publish \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scope": "acme",
  "name": "code-review",
  "visibility": "public",
  "bump": "minor",
  "changelog": "Adds a fix phase",
  "tags": [
    "review",
    "github"
  ]
}
'

import requests

url = "https://{host}/v1/teams/publish"

payload = {
    "scope": "acme",
    "name": "code-review",
    "visibility": "public",
    "bump": "minor",
    "changelog": "Adds a fix phase",
    "tags": ["review", "github"]
}
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',
    name: 'code-review',
    visibility: 'public',
    bump: 'minor',
    changelog: 'Adds a fix phase',
    tags: ['review', 'github']
  })
};

fetch('https://{host}/v1/teams/publish', 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://{host}/v1/teams/publish",
  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',
    'name' => 'code-review',
    'visibility' => 'public',
    'bump' => 'minor',
    'changelog' => 'Adds a fix phase',
    'tags' => [
        'review',
        'github'
    ]
  ]),
  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://{host}/v1/teams/publish"

	payload := strings.NewReader("{\n  \"scope\": \"acme\",\n  \"name\": \"code-review\",\n  \"visibility\": \"public\",\n  \"bump\": \"minor\",\n  \"changelog\": \"Adds a fix phase\",\n  \"tags\": [\n    \"review\",\n    \"github\"\n  ]\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://{host}/v1/teams/publish")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"scope\": \"acme\",\n  \"name\": \"code-review\",\n  \"visibility\": \"public\",\n  \"bump\": \"minor\",\n  \"changelog\": \"Adds a fix phase\",\n  \"tags\": [\n    \"review\",\n    \"github\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/v1/teams/publish")

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  \"scope\": \"acme\",\n  \"name\": \"code-review\",\n  \"visibility\": \"public\",\n  \"bump\": \"minor\",\n  \"changelog\": \"Adds a fix phase\",\n  \"tags\": [\n    \"review\",\n    \"github\"\n  ]\n}"

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

{
  "ok": true,
  "data": {
    "id": "3f6c2a8e-6b1d-4c1e-9a57-0d2f4b8e91c4",
    "name": "code-review",
    "scope": "acme",
    "version": "1.6.0",
    "status": "published",
    "listed": true
  }
}

Authorizations

Authorization

string

header

required

User PAT (cliq_tok_…, including session-scoped) or realm token (cliq_dt_…).

Body

application/json

name

string

Team name — mutually exclusive with team_id as the lookup key

scope

string

Scope (publisher) slug

team_id

string<uuid>

Team UUID — mutually exclusive with name as the lookup key

version

string

Explicit version string; omit to auto-bump from latest

bump

enum<string>

Bump magnitude when auto-versioning; omit for patch

Available options:

patch,

minor,

major

changelog

string

Release notes for this version

description

string

Updated description to apply on publish

license

string

SPDX license identifier

Response

Success.

enum<boolean>

required

Always true on success.

Available options:

true

data

object

required

Show child attributes

Publish a team

curl --request POST \
  --url https://{host}/v1/teams/publish \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scope": "acme",
  "name": "code-review",
  "visibility": "public",
  "bump": "minor",
  "changelog": "Adds a fix phase",
  "tags": [
    "review",
    "github"
  ]
}
'

import requests

url = "https://{host}/v1/teams/publish"

payload = {
    "scope": "acme",
    "name": "code-review",
    "visibility": "public",
    "bump": "minor",
    "changelog": "Adds a fix phase",
    "tags": ["review", "github"]
}
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',
    name: 'code-review',
    visibility: 'public',
    bump: 'minor',
    changelog: 'Adds a fix phase',
    tags: ['review', 'github']
  })
};

fetch('https://{host}/v1/teams/publish', 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://{host}/v1/teams/publish",
  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',
    'name' => 'code-review',
    'visibility' => 'public',
    'bump' => 'minor',
    'changelog' => 'Adds a fix phase',
    'tags' => [
        'review',
        'github'
    ]
  ]),
  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://{host}/v1/teams/publish"

	payload := strings.NewReader("{\n  \"scope\": \"acme\",\n  \"name\": \"code-review\",\n  \"visibility\": \"public\",\n  \"bump\": \"minor\",\n  \"changelog\": \"Adds a fix phase\",\n  \"tags\": [\n    \"review\",\n    \"github\"\n  ]\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://{host}/v1/teams/publish")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"scope\": \"acme\",\n  \"name\": \"code-review\",\n  \"visibility\": \"public\",\n  \"bump\": \"minor\",\n  \"changelog\": \"Adds a fix phase\",\n  \"tags\": [\n    \"review\",\n    \"github\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/v1/teams/publish")

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  \"scope\": \"acme\",\n  \"name\": \"code-review\",\n  \"visibility\": \"public\",\n  \"bump\": \"minor\",\n  \"changelog\": \"Adds a fix phase\",\n  \"tags\": [\n    \"review\",\n    \"github\"\n  ]\n}"

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

{
  "ok": true,
  "data": {
    "id": "3f6c2a8e-6b1d-4c1e-9a57-0d2f4b8e91c4",
    "name": "code-review",
    "scope": "acme",
    "version": "1.6.0",
    "status": "published",
    "listed": true
  }
}

Introduction

System

Auth

Users

Organizations

Invitations

Teams

Realms

Daemons

Workspaces

Runs

Artifacts

Events

Reviews

Notification channels

Notifications

Agents

Settings

Mesh

Jira

A2A

Publish a team

Authorizations

Body

Response