Paths

GET /

Description

Endpoint to get the status of Kiali

Responses

HTTP Code Description Schema
200 HTTP status code 200 and statusInfo model in data StatusInfo
404 A NotFoundError is the error message that is generated when server could not find what was requested. Response 404
500 A Internal is the error message that means something has gone wrong Response 500
default A GenericError is the default error message that is generated. Response default

Response 404

Name Description Schema
code
optional
HTTP status code
Default : 404
Example : 404
integer (int32)
message
optional
Example : "string" string

Response 500

Name Description Schema
code
optional
HTTP status code
Default : 500
Example : 500
integer (int32)
message
optional
Example : "string" string

Response default

Name Description Schema
code
optional
HTTP status code
Default : 400
Example : 400
integer (int32)
message
optional
Example : "string" string

Consumes

  • application/json

Produces

  • application/json

Example HTTP request

Request path
/

Example HTTP response

Response 200
{
  "externalServices" : [ {
    "name" : "Istio",
    "version" : "0.8.0"
  } ],
  "status" : {
    "string" : "string"
  },
  "warningMessages" : [ "Istio version 0.7.1 is not supported, the version should be 0.8.0" ]
}
Response 404
"object"
Response 500
"object"
Response default
"object"

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

Description

Get health associated to the given app

Parameters

Type Name Description Schema Default
Path app
required
The target app string
Path namespace
required
The namespace scope string
Query rateInterval
optional
The rate interval used for fetching error rate string "10m"

Responses

HTTP Code Description Schema
200 appHealthResponse contains aggregated health from various sources, for a given app AppHealth
404 A NotFoundError is the error message that is generated when server could not find what was requested. Response 404
500 A Internal is the error message that means something has gone wrong Response 500

Response 404

Name Description Schema
code
optional
HTTP status code
Default : 404
Example : 404
integer (int32)
message
optional
Example : "string" string

Response 500

Name Description Schema
code
optional
HTTP status code
Default : 500
Example : 500
integer (int32)
message
optional
Example : "string" string

Produces

  • application/json

Example HTTP request

Request path
/api/namespaces/string/apps/string/health

Example HTTP response

Response 200
{
  "deploymentStatuses" : [ {
    "available" : 0,
    "name" : "string",
    "replicas" : 0
  } ],
  "envoy" : [ {
    "inbound" : {
      "healthy" : 0,
      "total" : 0
    },
    "outbound" : {
      "healthy" : 0,
      "total" : 0
    },
    "service" : "string"
  } ],
  "requests" : {
    "requestCount" : 0.0,
    "requestErrorCount" : 0.0
  }
}
Response 404
"object"
Response 500
"object"

GET /api/namespaces/{namespace}/health

Description

Get health for all objects in the given namespace

Parameters

Type Name Description Schema Default
Path namespace
required
The namespace scope string
Query rateInterval
optional
The rate interval used for fetching error rate string "10m"
Query type
optional
The type of health, “app” or “workload”. string "app"

Responses

HTTP Code Description Schema
200 namespaceAppHealthResponse is a map of app name x health NamespaceAppHealth
400 BadRequestError: the client request is incorrect Response 400
500 A Internal is the error message that means something has gone wrong Response 500

Response 400

Name Description Schema
code
optional
HTTP status code
Default : 400
Example : 400
integer (int32)
message
optional
Example : "string" string

Response 500

Name Description Schema
code
optional
HTTP status code
Default : 500
Example : 500
integer (int32)
message
optional
Example : "string" string

Produces

  • application/json

Example HTTP request

Request path
/api/namespaces/string/health

Example HTTP response

Response 200
{ }
Response 400
"object"
Response 500
"object"

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

Description

Get health associated to the given service

Parameters

Type Name Description Schema Default
Path namespace
required
The namespace scope string
Path service
required
The target service string
Query rateInterval
optional
The rate interval used for fetching error rate string "10m"

Responses

HTTP Code Description Schema
200 serviceHealthResponse contains aggregated health from various sources, for a given service ServiceHealth
404 A NotFoundError is the error message that is generated when server could not find what was requested. Response 404
500 A Internal is the error message that means something has gone wrong Response 500

Response 404

Name Description Schema
code
optional
HTTP status code
Default : 404
Example : 404
integer (int32)
message
optional
Example : "string" string

Response 500

Name Description Schema
code
optional
HTTP status code
Default : 500
Example : 500
integer (int32)
message
optional
Example : "string" string

Produces

  • application/json

Example HTTP request

Request path
/api/namespaces/string/services/string/health

Example HTTP response

Response 200
{
  "envoy" : {
    "inbound" : {
      "healthy" : 0,
      "total" : 0
    },
    "outbound" : {
      "healthy" : 0,
      "total" : 0
    }
  },
  "requests" : {
    "requestCount" : 0.0,
    "requestErrorCount" : 0.0
  }
}
Response 404
"object"
Response 500
"object"

GET /api/namespaces/{namespace}/workloads/{workload}/health

Description

Get health associated to the given workload

Parameters

Type Name Description Schema Default
Path namespace
required
The namespace scope string
Path workload
required
The target workload string
Query rateInterval
optional
The rate interval used for fetching error rate string "10m"

Responses

HTTP Code Description Schema
200 workloadHealthResponse contains aggregated health from various sources, for a given workload WorkloadHealth
404 A NotFoundError is the error message that is generated when server could not find what was requested. Response 404
500 A Internal is the error message that means something has gone wrong Response 500

Response 404

Name Description Schema
code
optional
HTTP status code
Default : 404
Example : 404
integer (int32)
message
optional
Example : "string" string

Response 500

Name Description Schema
code
optional
HTTP status code
Default : 500
Example : 500
integer (int32)
message
optional
Example : "string" string

Produces

  • application/json

Example HTTP request

Request path
/api/namespaces/string/workloads/string/health

Example HTTP response

Response 200
{
  "deploymentStatus" : {
    "available" : 0,
    "name" : "string",
    "replicas" : 0
  },
  "requests" : {
    "requestCount" : 0.0,
    "requestErrorCount" : 0.0
  }
}
Response 404
"object"
Response 500
"object"

GET /namespaces/{namespace}/istio

Description

Endpoint to get the list of Istio Config of a namespace

Parameters

Type Name Description Schema
Path namespace
required
The id of the namespace. string

Responses

HTTP Code Description Schema
200 HTTP status code 200 and IstioConfigList model in data IstioConfigList
404 A NotFoundError is the error message that is generated when server could not find what was requested. Response 404
500 A Internal is the error message that means something has gone wrong Response 500
default A GenericError is the default error message that is generated. Response default

Response 404

Name Description Schema
code
optional
HTTP status code
Default : 404
Example : 404
integer (int32)
message
optional
Example : "string" string

Response 500

Name Description Schema
code
optional
HTTP status code
Default : 500
Example : 500
integer (int32)
message
optional
Example : "string" string

Response default

Name Description Schema
code
optional
HTTP status code
Default : 400
Example : 400
integer (int32)
message
optional
Example : "string" string

Consumes

  • application/json

Produces

  • application/json

Example HTTP request

Request path
/namespaces/string/istio

Example HTTP response

Response 200
{
  "destinationRules" : { },
  "gateways" : { },
  "namespace" : {
    "name" : "istio-system"
  },
  "quotaSpecBindings" : { },
  "quotaSpecs" : { },
  "rules" : { },
  "serviceEntries" : { },
  "virtualServices" : { }
}
Response 404
"object"
Response 500
"object"
Response default
"object"

GET /namespaces/{namespace}/istio/{object_type}/{object}/istio_validations

Description

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

Parameters

Type Name Description Schema
Path namespace
required
The id of the namespace. string
Path object
required
The name of the istio object string
Path object_type
required
The type of the istio object string

Responses

HTTP Code Description Schema
200 Listing all istio validations for object in the namespace TypedIstioValidations
404 A NotFoundError is the error message that is generated when server could not find what was requested. Response 404
500 A Internal is the error message that means something has gone wrong Response 500
default A GenericError is the default error message that is generated. Response default

Response 404

Name Description Schema
code
optional
HTTP status code
Default : 404
Example : 404
integer (int32)
message
optional
Example : "string" string

Response 500

Name Description Schema
code
optional
HTTP status code
Default : 500
Example : 500
integer (int32)
message
optional
Example : "string" string

Response default

Name Description Schema
code
optional
HTTP status code
Default : 400
Example : 400
integer (int32)
message
optional
Example : "string" string

Consumes

  • application/json

Produces

  • application/json

Tags

  • validations

Example HTTP request

Request path
/namespaces/string/istio/string/string/istio_validations

Example HTTP response

Response 200
{ }
Response 404
"object"
Response 500
"object"
Response default
"object"

GET /namespaces/{namespace}/istio_validations

Description

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

Parameters

Type Name Description Schema
Path namespace
required
The id of the namespace. string

Responses

HTTP Code Description Schema
200 Listing all istio validations for object in the namespace NamespaceValidations
404 A NotFoundError is the error message that is generated when server could not find what was requested. Response 404
500 A Internal is the error message that means something has gone wrong Response 500
default A GenericError is the default error message that is generated. Response default

Response 404

Name Description Schema
code
optional
HTTP status code
Default : 404
Example : 404
integer (int32)
message
optional
Example : "string" string

Response 500

Name Description Schema
code
optional
HTTP status code
Default : 500
Example : 500
integer (int32)
message
optional
Example : "string" string

Response default

Name Description Schema
code
optional
HTTP status code
Default : 400
Example : 400
integer (int32)
message
optional
Example : "string" string

Consumes

  • application/json

Produces

  • application/json

Tags

  • validations

Example HTTP request

Request path
/namespaces/string/istio_validations

Example HTTP response

Response 200
{ }
Response 404
"object"
Response 500
"object"
Response default
"object"

GET /namespaces/{namespace}/services/{service}/istio_validations

Description

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

Parameters

Type Name Description Schema
Path namespace
required
The id of the namespace. string
Path service
required
The name of the service string

Responses

HTTP Code Description Schema
200 Listing all istio validations for object in the namespace TypedIstioValidations
404 A NotFoundError is the error message that is generated when server could not find what was requested. Response 404
500 A Internal is the error message that means something has gone wrong Response 500
default A GenericError is the default error message that is generated. Response default

Response 404

Name Description Schema
code
optional
HTTP status code
Default : 404
Example : 404
integer (int32)
message
optional
Example : "string" string

Response 500

Name Description Schema
code
optional
HTTP status code
Default : 500
Example : 500
integer (int32)
message
optional
Example : "string" string

Response default

Name Description Schema
code
optional
HTTP status code
Default : 400
Example : 400
integer (int32)
message
optional
Example : "string" string

Consumes

  • application/json

Tags

  • validations

Example HTTP request

Request path
/namespaces/string/services/string/istio_validations

Example HTTP response

Response 200
{ }
Response 404
"object"
Response 500
"object"
Response default
"object"

GET /namespaces/{namespace}/workloads

Description

Endpoint to get the list of workloads for a namespace

Parameters

Type Name Description Schema
Path namespace
required
The id of the namespace. string

Responses

HTTP Code Description Schema
200 Listing all workloads in the namespace WorkloadList
404 A NotFoundError is the error message that is generated when server could not find what was requested. Response 404
500 A Internal is the error message that means something has gone wrong Response 500
default A GenericError is the default error message that is generated. Response default

Response 404

Name Description Schema
code
optional
HTTP status code
Default : 404
Example : 404
integer (int32)
message
optional
Example : "string" string

Response 500

Name Description Schema
code
optional
HTTP status code
Default : 500
Example : 500
integer (int32)
message
optional
Example : "string" string

Response default

Name Description Schema
code
optional
HTTP status code
Default : 400
Example : 400
integer (int32)
message
optional
Example : "string" string

Consumes

  • application/json

Produces

  • application/json

Example HTTP request

Request path
/namespaces/string/workloads

Example HTTP response

Response 200
{
  "namespace" : {
    "name" : "istio-system"
  },
  "workloads" : [ {
    "appLabel" : true,
    "istioSidecar" : true,
    "name" : "reviews-v1",
    "type" : "deployment",
    "versionLabel" : true
  } ]
}
Response 404
"object"
Response 500
"object"
Response default
"object"

GET /namespaces/{namespace}/workloads/{workload}

Description

Endpoint to get the workload details

Parameters

Type Name Description Schema
Path namespace
required
The id of the namespace. string
Path workload
required
The name of the workload string

Responses

HTTP Code Description Schema
200 Listing all the information related to a workload Workload
404 A NotFoundError is the error message that is generated when server could not find what was requested. Response 404
500 A Internal is the error message that means something has gone wrong Response 500
default A GenericError is the default error message that is generated. Response default

Response 404

Name Description Schema
code
optional
HTTP status code
Default : 404
Example : 404
integer (int32)
message
optional
Example : "string" string

Response 500

Name Description Schema
code
optional
HTTP status code
Default : 500
Example : 500
integer (int32)
message
optional
Example : "string" string

Response default

Name Description Schema
code
optional
HTTP status code
Default : 400
Example : 400
integer (int32)
message
optional
Example : "string" string

Consumes

  • application/json

Produces

  • application/json

Example HTTP request

Request path
/namespaces/string/workloads/string

Example HTTP response

Response 200
{
  "autoscaler" : {
    "createdAt" : "string",
    "currentCPUUtilizationPercentage" : 0,
    "currentReplicas" : 0,
    "desiredReplicas" : 0,
    "labels" : {
      "string" : "string"
    },
    "lastScaleTime" : "string",
    "maxReplicas" : 0,
    "minReplicas" : 0,
    "name" : "string",
    "observedGeneration" : 0,
    "targetCPUUtilizationPercentage" : 0
  },
  "availableReplicas" : 1,
  "createdAt" : "2018-07-31T12:24:17Z",
  "labels" : {
    "string" : "string"
  },
  "name" : "reviews",
  "pods" : { },
  "replicas" : 2,
  "resourceVersion" : "192892127",
  "services" : { },
  "templateAnnotations" : {
    "string" : "string"
  },
  "unavailableReplicas" : 1
}
Response 404
"object"
Response 500
"object"
Response default
"object"

GET /status

Description

Endpoint to get the status of Kiali

Responses

HTTP Code Description Schema
200 HTTP status code 200 and statusInfo model in data StatusInfo
404 A NotFoundError is the error message that is generated when server could not find what was requested. Response 404
500 A Internal is the error message that means something has gone wrong Response 500
default A GenericError is the default error message that is generated. Response default

Response 404

Name Description Schema
code
optional
HTTP status code
Default : 404
Example : 404
integer (int32)
message
optional
Example : "string" string

Response 500

Name Description Schema
code
optional
HTTP status code
Default : 500
Example : 500
integer (int32)
message
optional
Example : "string" string

Response default

Name Description Schema
code
optional
HTTP status code
Default : 400
Example : 400
integer (int32)
message
optional
Example : "string" string

Consumes

  • application/json

Produces

  • application/json

Example HTTP request

Request path
/status

Example HTTP response

Response 200
{
  "externalServices" : [ {
    "name" : "Istio",
    "version" : "0.8.0"
  } ],
  "status" : {
    "string" : "string"
  },
  "warningMessages" : [ "Istio version 0.7.1 is not supported, the version should be 0.8.0" ]
}
Response 404
"object"
Response 500
"object"
Response default
"object"

GET /token

Description

Endpoint to get the authentication token

Responses

HTTP Code Description Schema
200 HTTP status code 200 and tokenGenerated model in data TokenGenerated
404 A NotFoundError is the error message that is generated when server could not find what was requested. Response 404
500 A Internal is the error message that means something has gone wrong Response 500
default A GenericError is the default error message that is generated. Response default

Response 404

Name Description Schema
code
optional
HTTP status code
Default : 404
Example : 404
integer (int32)
message
optional
Example : "string" string

Response 500

Name Description Schema
code
optional
HTTP status code
Default : 500
Example : 500
integer (int32)
message
optional
Example : "string" string

Response default

Name Description Schema
code
optional
HTTP status code
Default : 400
Example : 400
integer (int32)
message
optional
Example : "string" string

Consumes

  • application/json

Produces

  • application/json

Security

Type Name Scopes
Unknown authorization user,password

Example HTTP request

Request path
/token

Example HTTP response

Response 200
{
  "expired_at" : "2018-06-20 19:40:54.116369887 +0000 UTC m=+43224.838320603",
  "token" : "zI1NiIsIsR5cCI6IkpXVCJ9.ezJ1c2VybmFtZSI6ImFkbWluIiwiZXhwIjoxNTI5NTIzNjU0fQ.PPZvRGnR6VA4v7FmgSfQcGQr-VD"
}
Response 404
"object"
Response 500
"object"
Response default
"object"