Kiali (_)
Download OpenAPI specification:Download
Kiali project, observability for the Istio service mesh
Root
Endpoint to get the status of Kiali
Responses
HTTP status code 200 and statusInfo model in data
A Internal is the error message that means something has gone wrong
Response samples
- 200
- 500
- "externalServices": [
- {
- "name": "Istio",
- "url": "jaeger-query-istio-system.127.0.0.1.nip.io",
- "version": "0.8.0"
- "status": {
- "property1": "string",
- "property2": "string"
- "warningMessages": [
- "Istio version 0.7.1 is not supported, the version should be 0.8.0"
getConfig
Endpoint to get the config of Kiali
Responses
HTTP status code 200 and statusInfo model in data
A Internal is the error message that means something has gone wrong
Response samples
- 200
- 500
- "externalServices": [
- {
- "name": "Istio",
- "url": "jaeger-query-istio-system.127.0.0.1.nip.io",
- "version": "0.8.0"
- "status": {
- "property1": "string",
- "property2": "string"
- "warningMessages": [
- "Istio version 0.7.1 is not supported, the version should be 0.8.0"
grafanaInfo
Get the grafana URL and other descriptors
Responses
Return all the descriptor data related to Grafana
NoContent: the response is empty
A Internal is the error message that means something has gone wrong
A Internal is the error message that means something has gone wrong
Response samples
- 200
- 204
- 500
- 503
- "serviceDashboardPath": "string",
- "url": "string",
- "varNamespace": "string",
- "varService": "string",
- "varWorkload": "string",
- "workloadDashboardPath": "string"
jaegerInfo
Get the jaeger URL and other descriptors
Responses
Return all the descriptor data related to Grafana
A NotFoundError is the error message that is generated when server could not find what was requested.
A NotAcceptable is the error message that means request can't be accepted
Response samples
- 200
- 404
- 406
- "url": "string"
getStatus
Endpoint to get the status of Kiali
Responses
HTTP status code 200 and statusInfo model in data
A Internal is the error message that means something has gone wrong
Response samples
- 200
- 500
- "externalServices": [
- {
- "name": "Istio",
- "url": "jaeger-query-istio-system.127.0.0.1.nip.io",
- "version": "0.8.0"
- "status": {
- "property1": "string",
- "property2": "string"
- "warningMessages": [
- "Istio version 0.7.1 is not supported, the version should be 0.8.0"
GetToken
Endpoint to get the authentication token
Authorizations:
Responses
HTTP status code 200 and tokenGenerated model in data
A Internal is the error message that means something has gone wrong
Response samples
- 200
- 500
- "expired_at": "2018-06-20 19:40:54.116369887 +0000 UTC m=+43224.838320603",
- "token": "zI1NiIsIsR5cCI6IkpXVCJ9.ezJ1c2VybmFtZSI6ImFkbWluIiwiZXhwIjoxNTI5NTIzNjU0fQ.PPZvRGnR6VA4v7FmgSfQcGQr-VD"
namespaceHealth
Get health for all objects in the given namespace
path Parameters
namespace required | string The namespace scope |
query Parameters
rateInterval | string Default: "10m" The rate interval used for fetching error rate |
QueryTime | string <date-time> The time to use for the prometheus query |
type | string^(app|service|workload)$ Default: "app" The type of health, "app", "service" or "workload". |
Responses
namespaceAppHealthResponse is a map of app name x health
BadRequestError: the client request is incorrect
A Internal is the error message that means something has gone wrong
Response samples
- 200
- 400
- 500
- "property1": {
- "requests": {
- "errorRatio": 0,
- "inboundErrorRatio": 0,
- "outboundErrorRatio": 0
- "workloadStatuses": [
- {
- "available": 0,
- "name": "string",
- "replicas": 0
- "property2": {
- "requests": {
- "errorRatio": 0,
- "inboundErrorRatio": 0,
- "outboundErrorRatio": 0
- "workloadStatuses": [
- {
- "available": 0,
- "name": "string",
- "replicas": 0
namespaceMetrics
Endpoint to fetch metrics to be displayed, related to a namespace
path Parameters
namespace required | string The namespace id. |
Responses
Metrics response model
BadRequestError: the client request is incorrect
A Internal is the error message that means something has gone wrong
Response samples
- 200
- 400
- 503
- "histograms": {
- "property1": {
- "property1": {
- "matrix": [
- {
- "metric": { },
- "values": [
- {
- "Timestamp": { },
- "Value": 0
- "property2": {
- "matrix": [
- {
- "metric": { },
- "values": [
- {
- "Timestamp": { },
- "Value": 0
- "property2": {
- "property1": {
- "matrix": [
- {
- "metric": { },
- "values": [
- {
- "Timestamp": { },
- "Value": 0
- "property2": {
- "matrix": [
- {
- "metric": { },
- "values": [
- {
- "Timestamp": { },
- "Value": 0
- "metrics": {
- "property1": {
- "matrix": [
- {
- "metric": { },
- "values": [
- {
- "Timestamp": { },
- "Value": 0
- "property2": {
- "matrix": [
- {
- "metric": { },
- "values": [
- {
- "Timestamp": { },
- "Value": 0
The backing JSON for a namespaces graph.
query Parameters
appenders | string Default: "run all appenders" Comma-separated list of Appenders to run. Available appenders: [deadNode, istio, responseTime, securityPolicy, serviceEntry, sidecarsCheck, unusedNode]. |
duration | string Default: "10m" Query time-range duration (Golang string duration). |
graphType | string Default: "workload" Graph type. Available graph types: [app, service, versionedApp, workload]. |
groupBy | string Default: "none" App box grouping characteristic. Available groupings: [app, none, version]. |
includeIstio | string Default: "false" Flag for including istio-system (infra) services. Ignored if namespace is istio-system. |
injectServiceNodes | string Default: "false" Flag for injecting the requested service node between source and destination nodes. |
namespaces required | string Comma-separated list of namespaces to include in the graph. The namespaces must be accessible to the client. |
queryTime | string Default: "now" Unix time (seconds) for query such that time range is [queryTime-duration..queryTime]. Default is now. |
Responses
HTTP status code 200 and cytoscapejs Config in data
BadRequestError: the client request is incorrect
A Internal is the error message that means something has gone wrong
Response samples
- 200
- 400
- 500
- "duration": 0,
- "elements": {
- "edges": [
- {
- "data": {
- "id": "string",
- "isMTLS": true,
- "isUnused": true,
- "responseTime": "string",
- "source": "string",
- "target": "string",
- "traffic": {
- "protocol": "string",
- "rates": {
- "property1": "string",
- "property2": "string"
- "nodes": [
- {
- "data": {
- "app": "string",
- "destServices": {
- "property1": true,
- "property2": true
- "hasCB": true,
- "hasMissingSC": true,
- "hasVS": true,
- "id": "string",
- "isDead": true,
- "isGroup": "string",
- "isInaccessible": true,
- "isMisconfigured": "string",
- "isOutside": true,
- "isRoot": true,
- "isServiceEntry": "string",
- "isUnused": true,
- "namespace": "string",
- "nodeType": "string",
- "parent": "string",
- "service": "string",
- "traffic": [
- {
- "protocol": "string",
- "rates": {
- "property1": "string",
- "property2": "string"
- "version": "string",
- "workload": "string"
- "graphType": "string",
- "timestamp": 0
graphApp
The backing JSON for an app node detail graph. (supported graphTypes: app | versionedApp)
path Parameters
app required | string The app name (label value). |
namespace required | string The namespace id. |
query Parameters
appenders | string Default: "run all appenders" Comma-separated list of Appenders to run. Available appenders: [deadNode, istio, responseTime, securityPolicy, serviceEntry, sidecarsCheck, unusedNode]. |
duration | string Default: "10m" Query time-range duration (Golang string duration). |
graphType | string Default: "workload" Graph type. Available graph types: [app, service, versionedApp, workload]. |
groupBy | string Default: "none" App box grouping characteristic. Available groupings: [app, none, version]. |
includeIstio | string Default: "false" Flag for including istio-system (infra) services. Ignored if namespace is istio-system. |
injectServiceNodes | string Default: "false" Flag for injecting the requested service node between source and destination nodes. |
queryTime | string Default: "now" Unix time (seconds) for query such that time range is [queryTime-duration..queryTime]. Default is now. |
Responses
HTTP status code 200 and cytoscapejs Config in data
BadRequestError: the client request is incorrect
A Internal is the error message that means something has gone wrong
Response samples
- 200
- 400
- 500
- "duration": 0,
- "elements": {
- "edges": [
- {
- "data": {
- "id": "string",
- "isMTLS": true,
- "isUnused": true,
- "responseTime": "string",
- "source": "string",
- "target": "string",
- "traffic": {
- "protocol": "string",
- "rates": {
- "property1": "string",
- "property2": "string"
- "nodes": [
- {
- "data": {
- "app": "string",
- "destServices": {
- "property1": true,
- "property2": true
- "hasCB": true,
- "hasMissingSC": true,
- "hasVS": true,
- "id": "string",
- "isDead": true,
- "isGroup": "string",
- "isInaccessible": true,
- "isMisconfigured": "string",
- "isOutside": true,
- "isRoot": true,
- "isServiceEntry": "string",
- "isUnused": true,
- "namespace": "string",
- "nodeType": "string",
- "parent": "string",
- "service": "string",
- "traffic": [
- {
- "protocol": "string",
- "rates": {
- "property1": "string",
- "property2": "string"
- "version": "string",
- "workload": "string"
- "graphType": "string",
- "timestamp": 0
graphAppVersion
The backing JSON for a versioned app node detail graph. (supported graphTypes: app | versionedApp)
path Parameters
app required | string The app name (label value). |
version required | string The app version (label value). |
namespace required | string The namespace id. |
query Parameters
appenders | string Default: "run all appenders" Comma-separated list of Appenders to run. Available appenders: [deadNode, istio, responseTime, securityPolicy, serviceEntry, sidecarsCheck, unusedNode]. |
duration | string Default: "10m" Query time-range duration (Golang string duration). |
graphType | string Default: "workload" Graph type. Available graph types: [app, service, versionedApp, workload]. |
groupBy | string Default: "none" App box grouping characteristic. Available groupings: [app, none, version]. |
includeIstio | string Default: "false" Flag for including istio-system (infra) services. Ignored if namespace is istio-system. |
injectServiceNodes | string Default: "false" Flag for injecting the requested service node between source and destination nodes. |
queryTime | string Default: "now" Unix time (seconds) for query such that time range is [queryTime-duration..queryTime]. Default is now. |
Responses
HTTP status code 200 and cytoscapejs Config in data
BadRequestError: the client request is incorrect
A Internal is the error message that means something has gone wrong
Response samples
- 200
- 400
- 500
- "duration": 0,
- "elements": {
- "edges": [
- {
- "data": {
- "id": "string",
- "isMTLS": true,
- "isUnused": true,
- "responseTime": "string",
- "source": "string",
- "target": "string",
- "traffic": {
- "protocol": "string",
- "rates": {
- "property1": "string",
- "property2": "string"
- "nodes": [
- {
- "data": {
- "app": "string",
- "destServices": {
- "property1": true,
- "property2": true
- "hasCB": true,
- "hasMissingSC": true,
- "hasVS": true,
- "id": "string",
- "isDead": true,
- "isGroup": "string",
- "isInaccessible": true,
- "isMisconfigured": "string",
- "isOutside": true,
- "isRoot": true,
- "isServiceEntry": "string",
- "isUnused": true,
- "namespace": "string",
- "nodeType": "string",
- "parent": "string",
- "service": "string",
- "traffic": [
- {
- "protocol": "string",
- "rates": {
- "property1": "string",
- "property2": "string"
- "version": "string",
- "workload": "string"
- "graphType": "string",
- "timestamp": 0
The backing JSON for a service node detail graph.
path Parameters
namespace required | string The namespace id. |
service required | string The service name. |
query Parameters
appenders | string Default: "run all appenders" Comma-separated list of Appenders to run. Available appenders: [deadNode, istio, responseTime, securityPolicy, serviceEntry, sidecarsCheck, unusedNode]. |
duration | string Default: "10m" Query time-range duration (Golang string duration). |
graphType | string Default: "workload" Graph type. Available graph types: [app, service, versionedApp, workload]. |
groupBy | string Default: "none" App box grouping characteristic. Available groupings: [app, none, version]. |
includeIstio | string Default: "false" Flag for including istio-system (infra) services. Ignored if namespace is istio-system. |
queryTime | string Default: "now" Unix time (seconds) for query such that time range is [queryTime-duration..queryTime]. Default is now. |
Responses
HTTP status code 200 and cytoscapejs Config in data
BadRequestError: the client request is incorrect
A Internal is the error message that means something has gone wrong
Response samples
- 200
- 400
- 500
- "duration": 0,
- "elements": {
- "edges": [
- {
- "data": {
- "id": "string",
- "isMTLS": true,
- "isUnused": true,
- "responseTime": "string",
- "source": "string",
- "target": "string",
- "traffic": {
- "protocol": "string",
- "rates": {
- "property1": "string",
- "property2": "string"
- "nodes": [
- {
- "data": {
- "app": "string",
- "destServices": {
- "property1": true,
- "property2": true
- "hasCB": true,
- "hasMissingSC": true,
- "hasVS": true,
- "id": "string",
- "isDead": true,
- "isGroup": "string",
- "isInaccessible": true,
- "isMisconfigured": "string",
- "isOutside": true,
- "isRoot": true,
- "isServiceEntry": "string",
- "isUnused": true,
- "namespace": "string",
- "nodeType": "string",
- "parent": "string",
- "service": "string",
- "traffic": [
- {
- "protocol": "string",
- "rates": {
- "property1": "string",
- "property2": "string"
- "version": "string",
- "workload": "string"
- "graphType": "string",
- "timestamp": 0
The backing JSON for a workload node detail graph.
path Parameters
namespace required | string The namespace id. |
workload required | string The workload name. |
query Parameters
appenders | string Default: "run all appenders" Comma-separated list of Appenders to run. Available appenders: [deadNode, istio, responseTime, securityPolicy, serviceEntry, sidecarsCheck, unusedNode]. |
duration | string Default: "10m" Query time-range duration (Golang string duration). |
graphType | string Default: "workload" Graph type. Available graph types: [app, service, versionedApp, workload]. |
groupBy | string Default: "none" App box grouping characteristic. Available groupings: [app, none, version]. |
includeIstio | string Default: "false" Flag for including istio-system (infra) services. Ignored if namespace is istio-system. |
injectServiceNodes | string Default: "false" Flag for injecting the requested service node between source and destination nodes. |
queryTime | string Default: "now" Unix time (seconds) for query such that time range is [queryTime-duration..queryTime]. Default is now. |
Responses
HTTP status code 200 and cytoscapejs Config in data
BadRequestError: the client request is incorrect
A Internal is the error message that means something has gone wrong
Response samples
- 200
- 400
- 500
- "duration": 0,
- "elements": {
- "edges": [
- {
- "data": {
- "id": "string",
- "isMTLS": true,
- "isUnused": true,
- "responseTime": "string",
- "source": "string",
- "target": "string",
- "traffic": {
- "protocol": "string",
- "rates": {
- "property1": "string",
- "property2": "string"
- "nodes": [
- {
- "data": {
- "app": "string",
- "destServices": {
- "property1": true,
- "property2": true
- "hasCB": true,
- "hasMissingSC": true,
- "hasVS": true,
- "id": "string",
- "isDead": true,
- "isGroup": "string",
- "isInaccessible": true,
- "isMisconfigured": "string",
- "isOutside": true,
- "isRoot": true,
- "isServiceEntry": "string",
- "isUnused": true,
- "namespace": "string",
- "nodeType": "string",
- "parent": "string",
- "service": "string",
- "traffic": [
- {
- "protocol": "string",
- "rates": {
- "property1": "string",
- "property2": "string"
- "version": "string",
- "workload": "string"
- "graphType": "string",
- "timestamp": 0
appList
Endpoint to get the list of apps for a namespace
path Parameters
namespace required | string The namespace id. |
Responses
Listing all apps in the namespace
A Internal is the error message that means something has gone wrong
Response samples
- 200
- 500
- "applications": [
- {
- "istioSidecar": true,
- "name": "reviews"
- "namespace": {
- "name": "istio-system"
appDetails
Endpoint to get the app details
path Parameters
app required | string The app name (label value). |
namespace required | string The namespace id. |
Responses
Detailed information of an specific app
A NotFoundError is the error message that is generated when server could not find what was requested.
A Internal is the error message that means something has gone wrong
Response samples
- 200
- 404
- 500
- "name": "reviews",
- "namespace": {
- "name": "istio-system"
- "runtimes": [
- {
- "dashboardRefs": [
- {
- "template": "string",
- "title": "string"
- "name": "string"
- "serviceNames": [
- "string"
- "workloads": [
- {
- "istioSidecar": true,
- "workloadName": "reviews-v1"
customDashboard
Endpoint to fetch custom dashboard to be displayed, based on the provided template
path Parameters
app required | string The app name (label value). |
namespace required | string The namespace id. |
template required | string The dashboard template name. |
query Parameters
avg | string Default: "true" Flag for fetching histogram average. Default is true. |
byLabels[] | string Default: "[]" List of labels to use for grouping metrics (via Prometheus 'by' clause). |
duration | string Default: "1800" Duration of the query period, in seconds. |
quantiles[] | string Default: "[]" List of quantiles to fetch. Fetch no quantiles when empty. Ex: [0.5, 0.95, 0.99]. |
rateFunc | string Default: "rate" Prometheus function used to calculate rate: 'rate' or 'irate'. |
rateInterval | string Default: "1m" Interval used for rate and histogram calculation. |
step | string Default: "15" Step between [graph] datapoints, in seconds. |
version | string Filters metrics by the specified version. |
Responses
Dashboard response model
BadRequestError: the client request is incorrect
A Internal is the error message that means something has gone wrong
Response samples
- 200
- 400
- 503
- "aggregations": [
- {
- "displayName": "string",
- "label": "string"
- "charts": [
- {
- "histogram": {
- "property1": {
- "matrix": [
- {
- "metric": { },
- "values": [
- {
- "Timestamp": { },
- "Value": 0
- "property2": {
- "matrix": [
- {
- "metric": { },
- "values": [
- {
- "Timestamp": { },
- "Value": 0
- "metric": {
- "matrix": [
- {
- "metric": { },
- "values": [
- {
- "Timestamp": { },
- "Value": 0
- "name": "string",
- "spans": 0,
- "unit": "string"
- "title": "string"
appDashboard
Endpoint to fetch dashboard to be displayed, related to a single app
path Parameters
app required | string The app name (label value). |
namespace required | string The namespace id. |
query Parameters
avg | string Default: "true" Flag for fetching histogram average. Default is true. |
byLabels[] | string Default: "[]" List of labels to use for grouping metrics (via Prometheus 'by' clause). |
direction | string Default: "outbound" Traffic direction: 'inbound' or 'outbound'. |
duration | string Default: "1800" Duration of the query period, in seconds. |
quantiles[] | string Default: "[]" List of quantiles to fetch. Fetch no quantiles when empty. Ex: [0.5, 0.95, 0.99]. |
rateFunc | string Default: "rate" Prometheus function used to calculate rate: 'rate' or 'irate'. |
rateInterval | string Default: "1m" Interval used for rate and histogram calculation. |
requestProtocol | string Default: "all protocols" Desired request protocol for the telemetry: For example, 'http' or 'grpc'. |
reporter | string Default: "source" Istio telemetry reporter: 'source' or 'destination'. |
step | string Default: "15" Step between [graph] datapoints, in seconds. |