Definitions

IstioConfigList

This is used for returning a response of IstioConfigList

Name Description Schema
destinationPolicies
optional
Example : "[destinationpolicies](#destinationpolicies)" destinationPolicies
destinationRules
optional
Example : "[destinationrules](#destinationrules)" destinationRules
namespace
required
Example : "[namespace](#namespace)" namespace
routeRules
optional
Example : "[routerules](#routerules)" routeRules
rules
optional
Example : "[istiorules](#istiorules)" istioRules
virtualServices
optional
Example : "[virtualservices](#virtualservices)" virtualServices

StatusInfo

This is used for returning a response of Kiali Status

Name Description Schema
externalServices
required
An array of external services installed
Example : [ "[externalserviceinfo](#externalserviceinfo)" ]
< externalServiceInfo > array
status
required
The state of Kiali
A hash of key,values with versions of Kiali and state
Example : {<br> "string" : "string"<br>}
< string, string > map
warningMessages
optional
An array of warningMessages
Example : [ "string" ]
< string > array

TokenGenerated

This is used for returning the token

Name Description Schema
expired_at
required
The expired time for the token
A string with the Datetime when the token will be expired
Example : "2018-06-20 19:40:54.116369887 +0000 UTC m=+43224.838320603"
string
token
required
The authentication token
A string with the authentication token for the user
Example : "zI1NiIsIsR5cCI6IkpXVCJ9.ezJ1c2VybmFtZSI6ImFkbWluIiwiZXhwIjoxNTI5NTIzNjU0fQ.PPZvRGnR6VA4v7FmgSfQcGQr-VD"
string

destinationPolicies

This is used for returning an array of DestinationPolicies

Type : < destinationPolicy > array

destinationPolicy

This is used for returning a DestinationPolicy

Name Description Schema
circuitBreaker
optional
Example : "object" object
createdAt
required
The creation date of the destinationPolicy
Example : "string"
string
destination
optional
Example : "object" object
loadbalancing
optional
Example : "object" object
name
required
The name of the destinationPolicy
Example : "string"
string
resourceVersion
required
The resource version of the destinationPolicy
Example : "string"
string
source
optional
Example : "object" object

destinationRule

This is used for returning a DestinationRule

Name Description Schema
createdAt
required
The creation date of the destinationRule
Example : "string"
string
host
optional
Example : "object" object
name
required
The name of the destinationRule
Example : "string"
string
resourceVersion
required
The resource version of the destinationRule
Example : "string"
string
subsets
optional
Example : "object" object
trafficPolicy
optional
Example : "object" object

destinationRules

This is used for returning an array of DestinationRules

Type : < destinationRule > array

externalServiceInfo

This is used for returning a response of Kiali Status

Name Description Schema
name
required
The name of the service
Example : "Istio"
string
version
required
The installed version of the service
Example : "0.8.0"
string

istioRule

This is used for returning a IstioRule

Name Description Schema
actions
optional
Example : "object" object
match
optional
Example : "object" object
name
required
The name of the istioRule
Example : "string"
string

istioRules

This is used for returning an array of IstioRules

Type : < istioRule > array

namespace

It is used to describe a set of objects.

Name Description Schema
name
required
The id of the namespace.
Example : "istio-system"
string

routeRule

This is used for returning a RouteRule

Name Description Schema
appendHeaders
optional
Example : "object" object
corsPolicy
optional
Example : "object" object
createdAt
required
The created time
Example : "2018-06-20T07:39:52Z"
string
destination
optional
Example : "object" object
httpFault
optional
Example : "object" object
httpReqRetries
optional
Example : "object" object
httpReqTimeout
optional
Example : "object" object
l4Fault
optional
Example : "object" object
match
optional
Example : "object" object
mirror
optional
Example : "object" object
name
required
The name of the routeRule
Example : "details-default"
string
precedence
optional
Example : "object" object
redirect
optional
Example : "object" object
resourceVersion
required
Example : "1507" string
rewrite
optional
Example : "object" object
route
optional
Example : "object" object
routeWarning
optional
Example : "string" string
websocketUpgrade
optional
Example : "object" object

routeRules

This is used for returning an array of RouteRule

Type : < routeRule > array

virtualService

This is used for returning a VirtualService

Name Description Schema
createdAt
required
The creation date of the virtualService
Example : "string"
string
gateways
optional
Example : "object" object
hosts
optional
Example : "object" object
http
optional
Example : "object" object
name
required
The name of the virtualService
Example : "string"
string
resourceVersion
required
The resource version of the virtualService
Example : "string"
string
tcp
optional
Example : "object" object

virtualServices

This is used for returning an array of VirtualServices

Type : < virtualService > array