Kiali Logo

Developer API

Kiali (_)

Download OpenAPI specification:Download

Kiali project, observability for the Istio service mesh

kiali

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

Content type
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

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

healthz

Endpoint to get the health of Kiali

Responses

500

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

get /healthz
/api/healthz

Response samples

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

auth

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

Content type
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

Content type
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

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

logout

Endpoint to logout an user (unset the session cookie)

Responses

204

NoContent: the response is empty

get /logout
/api/logout

Response samples

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

integrations

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

Content type
application/json
Copy
Expand all Collapse all
{
  • "externalLinks":
    [
    ]
}

jaegerInfo

Get the jaeger URL and other descriptors

Responses

200

Return all the descriptor data related to Jaeger

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

Content type
application/json
Copy
Expand all Collapse all
{
  • "enabled": true,
  • "integration": true,
  • "namespaceSelector": true,
  • "url": "string",
  • "whiteListIstioSystem":
    [
    ]
}

config

getPermissions

Endpoint to get the caller permissions on new Istio Config objects

Responses

200

Return caller permissions per namespace and Istio Config type

500

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

get /istio/permissions
/api/istio/permissions

Response samples

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

istioConfigList

Endpoint to get the list of Istio Config of a namespace

path Parameters
namespace
required
string

The namespace name.

Responses

200

HTTP status code 200 and IstioConfigList model in data

500

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

get /namespaces/{namespace}/istio
/api/namespaces/{namespace}/istio

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "adapters":
    [
    ],
  • "authorizationPolicies":
    [