Publish a deployment - Zite Platform

POST

apps

{appId}

deployments

Publish a deployment

curl --request POST \
  --url https://api.zite.com/v1/apps/{appId}/deployments \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.zite.com/v1/apps/{appId}/deployments', 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.zite.com/v1/apps/{appId}/deployments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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.zite.com/v1/apps/{appId}/deployments"

	req, _ := http.NewRequest("POST", 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))

}

require 'uri'
require 'net/http'

url = URI("https://api.zite.com/v1/apps/{appId}/deployments")

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

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

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

{
  "id": "dep_5f7c2a",
  "status": "live",
  "accessMode": "external",
  "liveUrl": "https://agent-console.zite.so"
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid API key."
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Workspace not found."
  }
}

{
  "error": {
    "code": "BUILD_NOT_READY",
    "message": "The latest build is still building. Poll GET /apps/{appId} until buildStatus is success."
  }
}

Publishes the app’s latest successful build.

External apps deploy to https://<subdomain>.zite.so (or a custom domain).
Internal apps become available to your organization; customSubdomain is null.

Publishing requires a successful build. If the latest build is still building or failed, the call returns a 400 explaining why — poll GET /apps/{appId} until buildStatus is success, or fix errors with check / logs and commit again.

Authorizations

Authorization

string

header

required

Enter your Zite API key. Format: Bearer <api_key>

Path Parameters

appId

string

required

The app ID.

Response

The live deployment

published

boolean

Example:

true

snapshotId

integer

The build snapshot that is now live.

accessMode

enum<string>

default:internal

internal apps are available to your organization; external apps deploy to a public subdomain.

Available options:

internal,

external

customSubdomain

string | null

For external apps, the <subdomain>.zite.so host serving the app.

Example:

"agent-console"

publicIdentifier

string

Example:

"app_a1b2c3"

workspaceId

string | null

Example:

"wsp8bce4d1edc51710"

Publish a deployment

curl --request POST \
  --url https://api.zite.com/v1/apps/{appId}/deployments \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.zite.com/v1/apps/{appId}/deployments', 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.zite.com/v1/apps/{appId}/deployments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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.zite.com/v1/apps/{appId}/deployments"

	req, _ := http.NewRequest("POST", 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))

}

require 'uri'
require 'net/http'

url = URI("https://api.zite.com/v1/apps/{appId}/deployments")

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

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

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

{
  "id": "dep_5f7c2a",
  "status": "live",
  "accessMode": "external",
  "liveUrl": "https://agent-console.zite.so"
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid API key."
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Workspace not found."
  }
}

{
  "error": {
    "code": "BUILD_NOT_READY",
    "message": "The latest build is still building. Poll GET /apps/{appId} until buildStatus is success."
  }
}