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":
    [
    ]
}

AuthenticationInfo

Endpoint to get login info, such as strategy, authorization endpoints for OAuth providers and so on.

Responses

200

Return the information necessary to handle login

500

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

get /auth/info
/api/auth/info

Response samples

application/json
Copy
Expand all Collapse all
{
  • "code": 500,
  • "message": "string"
}

Authenticate

Endpoint to authenticate the user

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 /authenticate
/api/authenticate

Response samples

application/json
Copy
Expand all Collapse all
{
  • "expiresOn": "Thu, 07 Mar 2019 17:50:26 +0000",
  • "token": "zI1NiIsIsR5cCI6IkpXVCJ9.ezJ1c2VybmFtZSI6ImFkbWluIiwiZXhwIjoxNTI5NTIzNjU0fQ.PPZvRGnR6VA4v7FmgSfQcGQr-VD",
  • "username": "admin"
}

OpenshiftCheckToken

Endpoint to check if a token from Openshift is working correctly

Responses

200

HTTP status code 200 and tokenGenerated model in data

500

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

post /authenticate
/api/authenticate

Response samples

application/json
Copy
Expand all Collapse all
{
  • "expiresOn": "Thu, 07 Mar 2019 17:50:26 +0000",
  • "token": "zI1NiIsIsR5cCI6IkpXVCJ9.ezJ1c2VybmFtZSI6ImFkbWluIiwiZXhwIjoxNTI5NTIzNjU0fQ.PPZvRGnR6VA4v7FmgSfQcGQr-VD",
  • "username": "admin"
}

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

NoContent: the response is empty

500

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

503

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"
}

Logout

Endpoint to logout an user (unset the session cookie)

Responses

204

NoContent: the response is empty

get /logout
/api/logout

Response samples

application/json
Copy
Expand all Collapse all
{
  • "code": 204,
  • "message": "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":
    [
    ]
}

namespaces

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
[
  • {
    }
]

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 /namespaces/{namespace}/health
/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 name.

Responses

200

Metrics response model

400

BadRequestError: the client request is incorrect

503

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

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

Response samples

application/json
Copy
Expand all Collapse all
{
  • "histograms":
    {
    },
  • "metrics":
    {