Branding

Get the host brand

GET/branding/host-brand
branding:readget_host_brandRead-only

Returns the colours of the token organisation's host, each with name, red, green, blue and alpha, in the order they were first stored. The host is the organisation's default host, or its lowest live host when none is the default; an organisation with no host returns 409 conflict. Unlike GET /branding these colours belong to this organisation. Changes nothing.

Responses

200

The host brand colours.

HostBrandEnvelope
{
  "data": {
    "colours": [
      {
        "name": "primary",
        "red": 12,
        "green": 74,
        "blue": 110,
        "alpha": 1
      }
    ]
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
409

The request conflicts with existing state (error.code = conflict), e.g. a compliance flow with the requested name already exists.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/branding/host-brand\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"