API

Kiali (_)

Download OpenAPI specification:Download

Kiali project, observability for the Istio service mesh

Root

Endpoint to get the status of Kiali

Responses

200

HTTP status code 200 and statusInfo model in data

500

A Internal is the error message that means something has gone wrong

get /
/api/

Response samples

application/json
Copy
Expand all Collapse all
{
  • "externalServices":
    [
    ],
  • "status":
    {
    },
  • "warningMessages":
    [
    ]
}

getConfig

Endpoint to get the config of Kiali

Responses

200

HTTP status code 200 and statusInfo model in data

500

A Internal is the error message that means something has gone wrong

get /config
/api/config

Response samples

application/json
Copy
Expand all Collapse all
{
  • "externalServices":
    [
    ],
  • "status":
    {
    },
  • "warningMessages":
    [
    ]
}

grafanaInfo

Get the grafana URL and other descriptors

Responses

200

Return all the descriptor data related to Grafana

204

Return all the descriptor data related to Grafana

404

A NotFoundError is the error message that is generated when server could not find what was requested.

406

A NotAcceptable is the error message that means request can't be accepted

500

A Internal is the error message that means something has gone wrong

get /grafana
/api/grafana

Response samples

application/json
Copy
Expand all Collapse all
{
  • "serviceDashboardPath": "string",
  • "url": "string",
  • "varNamespace": "string",
  • "varService": "string",
  • "varWorkload": "string",
  • "workloadDashboardPath": "string"
}

jaegerInfo

Get the jaeger URL and other descriptors

Responses

200

Return all the descriptor data related to Grafana

404

A NotFoundError is the error message that is generated when server could not find what was requested.

406

A NotAcceptable is the error message that means request can't be accepted

get /jaeger
/api/jaeger

Response samples

application/json
Copy
Expand all Collapse all
{
  • "url": "string"
}

getStatus

Endpoint to get the status of Kiali

Responses

200

HTTP status code 200 and statusInfo model in data

500

A Internal is the error message that means something has gone wrong

get /status
/api/status

Response samples

application/json
Copy
Expand all Collapse all
{
  • "externalServices":
    [
    ],
  • "status":
    {
    },
  • "warningMessages":
    [
    ]
}

GetToken

Endpoint to get the authentication token

Authorizations:

Responses

200

HTTP status code 200 and tokenGenerated model in data

500

A Internal is the error message that means something has gone wrong

get /token
/api/token

Response samples

application/json
Copy
Expand all Collapse all
{
  • "expired_at": "2018-06-20 19:40:54.116369887 +0000 UTC m=+43224.838320603",
  • "token": "zI1NiIsIsR5cCI6IkpXVCJ9.ezJ1c2VybmFtZSI6ImFkbWluIiwiZXhwIjoxNTI5NTIzNjU0fQ.PPZvRGnR6VA4v7FmgSfQcGQr-VD"
}

apps

appHealth

Get health associated to the given app

path Parameters
namespace
required
string

The namespace scope

app
required
string

The target app

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

Responses

200

appHealthResponse contains aggregated health from various sources, for a given app

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

get /api/namespaces/{namespace}/apps/{app}/health
/api/api/namespaces/{namespace}/apps/{app}/health

Response samples

application/json
Copy
Expand all Collapse all
{
  • "envoy":
    [
    ],
  • "requests":
    {
    },
  • "workloadStatuses":
    [
    ]
}

appMetrics

Endpoint to fetch metrics 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.

byLabelsIn[]
string
Default: "[]"

List of labels to use for grouping inbound metrics (via Prometheus 'by' clause).

byLabelsOut[]
string
Default: "[]"

List of labels to use for grouping outbound metrics (via Prometheus 'by' clause).

duration
string
Default: "1800"

Duration of the query period, in seconds.

filters[]
string
Default: "[]"

List of metrics to fetch. Fetch all metrics when empty. List entries are Kiali internal metric names.

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.

reporter
string

Istio telemetry reporter: 'source' or 'destination'

step
string
Default: "15"

Step between [graph] datapoints, in seconds.

version
string

Filters metrics by the specified version.

Responses

200

Listing all the information related to a service

400

BadRequestError: the client request is incorrect

503

A Internal is the error message that means something has gone wrong

get /api/namespaces/{namespace}/apps/{app}/metrics
/api/api/namespaces/{namespace}/apps/{app}/metrics

Response samples

application/json
Copy
Expand all Collapse all
{
  • "dest":
    {
    },
  • "source":
    {
    }
}

appList

Endpoint to get the list of apps for a namespace

path Parameters
namespace
required
string

The namespace id.

Responses

200

Listing all apps in the namespace

500

A Internal is the error message that means something has gone wrong

get /namespaces/{namespace}/apps
/api/namespaces/{namespace}/apps

Response samples

application/json
Copy
Expand all Collapse all
{
  • "applications":
    [
    ],
  • "namespace":
    {
    }
}

appDetails

Endpoint to get the app details

path Parameters
app
required
string

The app name (label value).

namespace
required
string

The namespace id.

Responses

200

Detailed information of an specific app

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

get /namespaces/{namespace}/apps/{app}
/api/namespaces/{namespace}/apps/{app}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "name": "reviews",
  • "namespace":
    {
    },
  • "serviceNames":
    [
    ],
  • "workloads":
    [
    ]
}

namespaces

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

200

namespaceAppHealthResponse is a map of app name x health

400

BadRequestError: the client request is incorrect

500

A Internal is the error message that means something has gone wrong

get /api/namespaces/{namespace}/health
/api/api/namespaces/{namespace}/health

Response samples

application/json
Copy
Expand all Collapse all
{
  • "property1":
    {
    },
  • "property2":
    {
    }
}

namespaceMetrics

Endpoint to fetch metrics to be displayed, related to a namespace

path Parameters
namespace
required
string

The namespace id.

Responses

200

Listing all the information related to a service

400

BadRequestError: the client request is incorrect

503

A Internal is the error message that means something has gone wrong

get /api/namespaces/{namespace}/metrics
/api/api/namespaces/{namespace}/metrics

Response samples

application/json
Copy
Expand all Collapse all
{
  • "dest":
    {
    },
  • "source":
    {
    }
}

namespaceList

Endpoint to get the list of the available namespaces

Responses

200

List of Namespaces

500

A Internal is the error message that means something has gone wrong

get /namespaces
/api/namespaces

Response samples

application/json
Copy
Expand all Collapse all
[
  • {
    }
]

namespaceValidations

Endpoint to get the list of istio object validations for a namespace

path Parameters
namespace
required
string

The namespace id.

Responses

200

Listing all istio validations for object in the namespace

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

get /namespaces/{namespace}/istio_validations
/api/namespaces/{namespace}/istio_validations

Response samples

application/json
Copy
Expand all Collapse all
{
  • "property1":
    {
    },
  • "property2":
    {
    }
}

services

serviceHealth

Get health associated to the given service

path Parameters
namespace
required
string

The namespace scope

service
required
string

The target service

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

Responses

200

serviceHealthResponse contains aggregated health from various sources, for a given service

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

get /api/namespaces/{namespace}/services/{service}/health
/api/api/namespaces/{namespace}/services/{service}/health

Response samples

application/json
Copy
Expand all Collapse all
{
  • "envoy":
    {
    },
  • "requests":
    {
    }
}

serviceMetrics

Endpoint to fetch metrics to be displayed, related to a single service

path Parameters
namespace
required
string

The namespace id.

service
required
string

The service name.

query Parameters
avg
string
Default: "true"

Flag for fetching histogram average. Default is true.

byLabelsIn[]
string
Default: "[]"

List of labels to use for grouping inbound metrics (via Prometheus 'by' clause).

byLabelsOut[]
string
Default: "[]"

List of labels to use for grouping outbound metrics (via Prometheus 'by' clause).

duration
string
Default: "1800"

Duration of the query period, in seconds.

filters[]
string
Default: "[]"

List of metrics to fetch. Fetch all metrics when empty. List entries are Kiali internal metric names.

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.

reporter
string

Istio telemetry reporter: 'source' or 'destination'

step
string
Default: "15"

Step between [graph] datapoints, in seconds.

version
string

Filters metrics by the specified version.

Responses

200

Listing all the information related to a service

400

BadRequestError: the client request is incorrect

503

A Internal is the error message that means something has gone wrong

get /api/namespaces/{namespace}/services/{service}/metrics
/api/api/namespaces/{namespace}/services/{service}/metrics

Response samples

application/json
Copy
Expand all Collapse all
{
  • "dest":
    {
    },
  • "source":
    {
    }
}

serviceList

Endpoint to get the details of a given service

path Parameters
namespace
required
string

The namespace id.

Responses

200

Listing all services in the namespace

500

A Internal is the error message that means something has gone wrong

get /namespaces/{namespace}/services
/api/namespaces/{namespace}/services

Response samples

application/json
Copy
Expand all Collapse all
{
  • "namespace":
    {
    },
  • "services":
    [
    ]
}

serviceDetails

Endpoint to get the details of a given service

path Parameters
namespace
required
string

The namespace id.

service
required
string

The service name.

Responses

200

Listing all the information related to a workload

404

A NotFoundError is the error message that is generated when server could not find what was requested.

500

A Internal is the error message that means something has gone wrong

get /namespaces/{namespace}/services/{service}
/api/namespaces/{namespace}/services/{service}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "dependencies":
    {