Get branding configuration

curl --request GET \
  --url http://10.2.4.166:8080/composer/api/branding \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('http://10.2.4.166:8080/composer/api/branding', 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 => "8080",
  CURLOPT_URL => "http://10.2.4.166:8080/composer/api/branding",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$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 := "http://10.2.4.166:8080/composer/api/branding"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	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("http://10.2.4.166:8080/composer/api/branding")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "title": "<string>",
  "copyrightEnabled": true,
  "copyright": "<string>",
  "termsEnabled": true,
  "terms": "<string>",
  "favicon": "<string>",
  "headerLogo": "<string>",
  "loginLogo": "<string>",
  "background": "<string>",
  "homeBackground": "<string>",
  "iconLogo": "<string>",
  "customCss": true,
  "customJs": true,
  "supportEnabled": true,
  "supportLink": "<string>",
  "documentationEnabled": true,
  "documentationLink": "<string>",
  "customHtml": {
    "enableHeader": true,
    "headerContent": "<string>",
    "headerHeight": 123,
    "enableFooter": true,
    "footerContent": "<string>",
    "footerHeight": 123
  },
  "brandingTs": 123,
  "url": "<string>",
  "customMessage": "<string>",
  "defaultLogo": true,
  "quickstartEnabled": true,
  "zdContactLink": "<string>",
  "zdSupportLink": "<string>",
  "zdQuickstartLink": "<string>",
  "zdContactVal": "<string>",
  "zdSupportVal": "<string>",
  "zdQuickstartVal": "<string>"
}

Get branding configuration

curl --request GET \
  --url http://10.2.4.166:8080/composer/api/branding \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('http://10.2.4.166:8080/composer/api/branding', 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 => "8080",
  CURLOPT_URL => "http://10.2.4.166:8080/composer/api/branding",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$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 := "http://10.2.4.166:8080/composer/api/branding"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	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("http://10.2.4.166:8080/composer/api/branding")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "title": "<string>",
  "copyrightEnabled": true,
  "copyright": "<string>",
  "termsEnabled": true,
  "terms": "<string>",
  "favicon": "<string>",
  "headerLogo": "<string>",
  "loginLogo": "<string>",
  "background": "<string>",
  "homeBackground": "<string>",
  "iconLogo": "<string>",
  "customCss": true,
  "customJs": true,
  "supportEnabled": true,
  "supportLink": "<string>",
  "documentationEnabled": true,
  "documentationLink": "<string>",
  "customHtml": {
    "enableHeader": true,
    "headerContent": "<string>",
    "headerHeight": 123,
    "enableFooter": true,
    "footerContent": "<string>",
    "footerHeight": 123
  },
  "brandingTs": 123,
  "url": "<string>",
  "customMessage": "<string>",
  "defaultLogo": true,
  "quickstartEnabled": true,
  "zdContactLink": "<string>",
  "zdSupportLink": "<string>",
  "zdQuickstartLink": "<string>",
  "zdContactVal": "<string>",
  "zdSupportVal": "<string>",
  "zdQuickstartVal": "<string>"
}

Authorizations

Authorization

string

header

required

HTTP Basic authentication using global administrator credentials (username and password).

Response

200 - application/vnd.composer.v3+json

Branded UI settings for the Composer application

title

string

copyrightEnabled

boolean

string

termsEnabled

boolean

terms

string

favicon

string

headerLogo

string

background

string

homeBackground

string

iconLogo

string

customCss

boolean

customJs

boolean

supportEnabled

boolean

supportLink

string

documentationEnabled

boolean

documentationLink

string

customHtml

object

Custom HTML settings within a Branding configuration

Show child attributes

brandingTs

integer<int64>

url

string