Kiali Logo

Developer 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

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

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

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

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

Content type
application/json
Copy
Expand all Collapse all
{
  • "namespace_selector": true,
  • "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

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

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

getThreeScaleInfo

Endpoint to check if threescale adapter is present in the cluster and if user can write adapter config

Responses

200

Return if ThreeScale adapter is enabled in Istio and if user has permissions to write adapter's configuration

500

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

get /threescale
/api/threescale

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "enabled": true,
  • "permissions":
    {
    }
}

getThreeScaleHandlers

Endpoint to fetch threescale handlers generated from Kiali

Responses

200

List of ThreeScale handlers created from Kiali to be used in the adapter's configuration

500

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

get /threescale/handlers
/api/threescale/handlers

Response samples

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

postThreeScaleHandlers

Endpoint to create a new threescale handler+instance generated by Kiali

Responses

200

List of ThreeScale handlers created from Kiali to be used in the adapter's configuration

500

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

post /threescale/handlers
/api/threescale/handlers

Response samples

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

deleteThreeScaleHandler

Endpoint to delete an existing threescale handler+instance generated by Kiali

path Parameters
threescaleHandlerName
required
string

The ThreeScaleHandler name.

Responses

200

List of ThreeScale handlers created from Kiali to be used in the adapter's configuration

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

delete /threescale/handlers/{threescaleHandlerName}
/api/threescale/handlers/{threescaleHandlerName}

Response samples

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

patchThreeScaleHandler

Endpoint to update an existing threescale handler generated by Kiali

path Parameters
threescaleHandlerName
required
string

The ThreeScaleHandler name.

Responses

200

List of ThreeScale handlers created from Kiali to be used in the adapter's configuration

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

patch /threescale/handlers/{threescaleHandlerName}
/api/threescale/handlers/{threescaleHandlerName}

Response samples

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

postThreeScaleService

Endpoint to create a new threescale rule for a given service

path Parameters
namespace
required
string

The namespace name.

Responses

200

Return Threescale rule definition for a given service

500

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

post /threescale/namespaces/{namespace}/services
/api/threescale/namespaces/{namespace}/services

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "serviceName": "string",
  • "serviceNamespace": "string",
  • "threeScaleHandlerName": "string"
}

getThreeScaleService

Endpoint to get an existing threescale rule for a given service

path Parameters
namespace
required
string

The namespace name.

service
required
string

The service name.

Responses

200

Return Threescale rule definition 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 /threescale/namespaces/{namespace}/services/{service}
/api/threescale/namespaces/{namespace}/services/{service}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "serviceName": "string",
  • "serviceNamespace": "string",
  • "threeScaleHandlerName": "string"
}

deleteThreeScaleService

Endpoint to delete an existing threescale rule for a given service

path Parameters
namespace
required
string

The namespace name.

service
required
string

The service name.

Responses

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

delete /threescale/namespaces/{namespace}/services/{service}
/api/threescale/namespaces/{namespace}/services/{service}

Response samples

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

patchThreeScaleService

Endpoint to update an existing threescale rule for a given service

path Parameters
namespace
required
string

The namespace name.

service
required
string

The service name.

Responses

200

Return Threescale rule definition 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

patch /threescale/namespaces/{namespace}/services/{service}