Kiali

Base URL: /api, Version: 0.2.0.Alpha

Kiali project, observability for the Istio service mesh

Default request content-types: application/json

Default response content-types: application/json

Schemes: http

Summary

Path	Operation	Description
/	GET
/namespaces/{namespace}/istio	GET
/status	GET
/token	GET

Paths

GET /

Handler to get the status of Kiali

application/json

200 OK #/responses/statusInfo

HTTP status code 200 and statusInfo model in data

code: integer (int64) 200: HTTP status code
data: StatusInfo

GET /namespaces/{namespace}/istio

Handler to get the list of Istio Config of a namespace

application/json


namespace	The id of the namespace.	path	string

application/json

200 OK #/responses/istioConfigList

HTTP status code 200 and IstioConfigList model in data

code: integer (int64) 200: HTTP status code
data: IstioConfigList

GET /status

Handler to get the status of Kiali

application/json

200 OK #/responses/statusInfo

HTTP status code 200 and statusInfo model in data

code: integer (int64) 200: HTTP status code
data: StatusInfo

GET /token

Handler to get the authentication token

application/json

200 OK #/responses/tokenGenerated

HTTP status code 200 and tokenGenerated model in data

code: integer (int64) 200: HTTP status code
data: TokenGenerated


authorization	user , password

Response definitions

istioConfigList

HTTP status code 200 and IstioConfigList model in data

code: integer (int64) 200: HTTP status code
data: IstioConfigList

statusInfo

HTTP status code 200 and statusInfo model in data

code: integer (int64) 200: HTTP status code
data: StatusInfo

tokenGenerated

HTTP status code 200 and tokenGenerated model in data

code: integer (int64) 200: HTTP status code
data: TokenGenerated

Schema definitions

destinationPolicies: object[]

This is used for returning an array of DestinationPolicies

destinationPolicy

destinationPolicy: object

This is used for returning a DestinationPolicy

circuitBreaker: object
createdAt: string: The creation date of the destinationPolicy
destination: object
loadbalancing: object
name: string: The name of the destinationPolicy
resourceVersion: string: The resource version of the destinationPolicy
source: object

destinationRule: object

This is used for returning a DestinationRule

createdAt: string: The creation date of the destinationRule
host: object
name: string: The name of the destinationRule
resourceVersion: string: The resource version of the destinationRule
subsets: object
trafficPolicy: object

destinationRules: object[]

This is used for returning an array of DestinationRules

destinationRule

externalServiceInfo: object

This is used for returning a response of Kiali Status

name: string

The name of the service

"Istio"

version: string

The installed version of the service

"0.8.0"

IstioConfigList: object

This is used for returning a response of IstioConfigList

destinationPolicies: destinationPolicies
destinationRules: destinationRules
namespace: namespace
routeRules: routeRules
rules: istioRules
virtualServices: virtualServices

istioRule: object

This is used for returning a IstioRule

actions: object
match: object
name: string: The name of the istioRule

istioRules: object[]

This is used for returning an array of IstioRules

istioRule

namespace: object

It is used to describe a set of objects.

name: string

The id of the namespace.

"istio-system"

routeRule: object

This is used for returning a RouteRule

appendHeaders: object

corsPolicy: object

createdAt: string

The created time

"2018-06-20T07:39:52Z"

destination: object

httpFault: object

httpReqRetries: object

httpReqTimeout: object

l4Fault: object

match: object

mirror: object

name: string

The name of the routeRule

"details-default"

precedence: object

redirect: object

resourceVersion: string

"1507"

rewrite: object

route: object

routeWarning: string

websocketUpgrade: object

routeRules: object[]

This is used for returning an array of RouteRule

routeRule

StatusInfo: object

This is used for returning a response of Kiali Status

externalServices: object[]

An array of external services installed

externalServiceInfo

status: object

The state of Kiali A hash of key,values with versions of Kiali and state

string

warningMessages: string[]

An array of warningMessages

string

"Istio version 0.7.1 is not supported, the version should be 0.8.0"

TokenGenerated: object

This is used for returning the token

expired_at: string

The expired time for the token A string with the Datetime when the token will be expired

"2018-06-20 19:40:54.116369887 +0000 UTC m=+43224.838320603"

token: string

The authentication token A string with the authentication token for the user

"zI1NiIsIsR5cCI6IkpXVCJ9.ezJ1c2VybmFtZSI6ImFkbWluIiwiZXhwIjoxNTI5NTIzNjU0fQ.PPZvRGnR6VA4v7FmgSfQcGQr-VD"

virtualService: object

This is used for returning a VirtualService

createdAt: string: The creation date of the virtualService
gateways: object
hosts: object
http: object
name: string: The name of the virtualService
resourceVersion: string: The resource version of the virtualService
tcp: object

virtualServices: object[]

This is used for returning an array of VirtualServices

virtualService