HTTP API

CI/CD: The HTTP API can be used for infrastructure automation to either retrieve data, or to make changes when running in Universal mode. The CLI is built on top of the HTTP API, which you can also access with any other HTTP client like curl.

By default the API Server is listening on port 5681 (HTTP) and on 5682 (HTTPS). The endpoints available are:

  • /config
  • /versions
  • /meshes
  • /mesh-insights
  • /mesh-insights/{name}
  • /dataplanes
  • /dataplanes+insights
  • /health-checks
  • /proxytemplates
  • /traffic-logs
  • /traffic-permissions
  • /traffic-routes
  • /fault-injections
  • /service-insights
  • /retries
  • /secrets
  • /global-secrets
  • /global-secrets/{name}
  • /meshes/{name}
  • /meshes/{mesh}/dataplanes
  • /meshes/{mesh}/dataplanes/{name}
  • /meshes/{mesh}/dataplanes+insights
  • /meshes/{mesh}/dataplanes+insights/{name}
  • /meshes/{mesh}/health-checks
  • /meshes/{mesh}/health-checks/{name}
  • /meshes/{mesh}/proxytemplates
  • /meshes/{mesh}/proxytemplates/{name}
  • /meshes/{mesh}/traffic-logs
  • /meshes/{mesh}/traffic-logs/{name}
  • /meshes/{mesh}/traffic-permissions
  • /meshes/{mesh}/traffic-permissions/{name}
  • /meshes/{mesh}/traffic-routes
  • /meshes/{mesh}/traffic-routes/{name}
  • /meshes/{mesh}/fault-injections
  • /meshes/{mesh}/fault-injections/{name}
  • /meshes/{mesh}/zones
  • /meshes/{mesh}/zones/{name}
  • /meshes/{mesh}/zones+insights
  • /meshes/{mesh}/zones+insights/{name}
  • /meshes/{mesh}/external-services
  • /meshes/{mesh}/external-services/{name}
  • /meshes/{mesh}/service-insights
  • /meshes/{mesh}/service-insights/{name}
  • /meshes/{mesh}/retries
  • /meshes/{mesh}/retries/{name}
  • /meshes/{mesh}/secrets
  • /meshes/{mesh}/secrets/{name}
  • /status/zones
  • /tokens

You can use GET requests to retrieve the state of Kuma on both Universal and Kubernetes, and PUT and DELETE requests on Universal to change the state.

Every resource list in Kuma is paginated. To use pagination, you can use following query parameters:

  • size - size of the page (default - 1000, maximum value - 10000).
  • offset - offset from which the page will be listed. The offset is a string, it does not have to be a number (it depends on the environment).

A response with a pagination contains next field with URL to fetch the next page. Example:

If next field is null there is no more pages to fetch.

Control Plane configuration

Request: GET /config

Response: 200 OK with the effective configuration of the Control Plane (notice that secrets, such as database passwords, will never appear in the response)

Example:

  1. curl http://localhost:5681/config
  1. {
  2.   "adminServer": {
  3.     "apis": {
  4.       "dataplaneToken": {
  5.         "enabled": true
  6.       }
  7.     },
  8.     "local": {
  9.       "port": 5679
  10.     },
  11.     "public": {
  12.       "clientCertsDir": "/etc/kuma.io/kuma-cp/admin-api/tls/allowed-client-certs.d",
  13.       "enabled": true,
  14.       "interface": "0.0.0.0",
  15.       "port": 5684,
  16.       "tlsCertFile": "/etc/kuma.io/kuma-cp/admin-api/tls/server.cert",
  17.       "tlsKeyFile": "/etc/kuma.io/kuma-cp/admin-api/tls/server.key"
  18.     }
  19.   },
  20.   "apiServer": {
  21.     "corsAllowedDomains": [
  22.       ".*"
  23.     ],
  24.     "port": 5681,
  25.     "readOnly": false
  26.   },
  27.   "bootstrapServer": {
  28.     "params": {
  29.       "adminAccessLogPath": "/dev/null",
  30.       "adminAddress": "127.0.0.1",
  31.       "adminPort": 0,
  32.       "xdsConnectTimeout": "1s",
  33.       "xdsHost": "kuma-control-plane.internal",
  34.       "xdsPort": 5678
  35.     },
  36.     "port": 5682
  37.   },
  38.   "dataplaneTokenServer": {
  39.     "enabled": true,
  40.     "local": {
  41.       "port": 5679
  42.     },
  43.     "public": {
  44.       "clientCertsDir": "/etc/kuma.io/kuma-cp/admin-api/tls/allowed-client-certs.d",
  45.       "enabled": true,
  46.       "interface": "0.0.0.0",
  47.       "port": 5684,
  48.       "tlsCertFile": "/etc/kuma.io/kuma-cp/admin-api/tls/server.cert",
  49.       "tlsKeyFile": "/etc/kuma.io/kuma-cp/admin-api/tls/server.key"
  50.     }
  51.   },
  52.   "defaults": {
  53.     "mesh": "type: Mesh\nname: default"
  54.   },
  55.   "discovery": {
  56.     "universal": {
  57.       "pollingInterval": "1s"
  58.     }
  59.   },
  60.   "environment": "universal",
  61.   "general": {
  62.     "advertisedHostname": "kuma-control-plane.internal"
  63.   },
  64.   "guiServer": {
  65.   },
  66.   "monitoringAssignmentServer": {
  67.     "assignmentRefreshInterval": "1s",
  68.     "grpcPort": 5676
  69.   },
  70.   "reports": {
  71.     "enabled": true
  72.   },
  73.   "runtime": {
  74.     "kubernetes": {
  75.       "admissionServer": {
  76.         "address": "",
  77.         "certDir": "",
  78.         "port": 5443
  79.       }
  80.     }
  81.   },
  82.   "sdsServer": {
  83.     "grpcPort": 5677,
  84.     "tlsCertFile": "/tmp/117637813.crt",
  85.     "tlsKeyFile": "/tmp/240596112.key"
  86.   },
  87.   "store": {
  88.     "kubernetes": {
  89.       "systemNamespace": "kuma-system"
  90.     },
  91.     "postgres": {
  92.       "connectionTimeout": 5,
  93.       "dbName": "kuma",
  94.       "host": "127.0.0.1",
  95.       "password": "*****",
  96.       "port": 15432,
  97.       "user": "kuma"
  98.     },
  99.     "type": "memory"
  100.   },
  101.   "xdsServer": {
  102.     "dataplaneConfigurationRefreshInterval": "1s",
  103.     "dataplaneStatusFlushInterval": "1s",
  104.     "diagnosticsPort": 5680,
  105.     "grpcPort": 5678
  106.   }
  107. }

Supported Envoy versions

List supported Envoy versions

Request: GET /versions

Response: 200 OK with versions of Envoy supported by Kuma DPs

Example:

  1. curl http://localhost:5681/versions
  1. {
  2.   "kumaDp": {
  3.     "1.0.0": {
  4.       "envoy": "1.16.0"
  5.     },
  6.     "1.0.1": {
  7.       "envoy": "1.16.0"
  8.     },
  9.     "1.0.2": {
  10.       "envoy": "1.16.1"
  11.     },
  12.     "1.0.3": {
  13.       "envoy": "1.16.1"
  14.     },
  15.     "1.0.4": {
  16.       "envoy": "1.16.1"
  17.     },
  18.     "1.0.5": {
  19.       "envoy": "1.16.2"
  20.     },
  21.     "1.0.6": {
  22.       "envoy": "1.16.2"
  23.     },
  24.     "1.0.7": {
  25.       "envoy": "1.16.2"
  26.     },
  27.     "1.0.8": {
  28.       "envoy": "1.16.2"
  29.     }
  30.   }
  31. }

Meshes

Get Mesh

Request: GET /meshes/{name}

Response: 200 OK with Mesh entity

Example:

  1. curl http://localhost:5681/meshes/mesh-1
  1. {
  2.   "name": "mesh-1",
  3.   "type": "Mesh",
  4.   "creationTime": "2020-05-12T12:31:45.606217+02:00",
  5.   "modificationTime": "2020-05-12T12:31:45.606217+02:00",
  6.   "mtls": {
  7.     "backends": [
  8.       {
  9.         "name": "ca-1",
  10.         "type": "builtin"
  11.       },
  12.       {
  13.         "name": "ca-2",
  14.         "type": "provided",
  15.         "conf": {
  16.           "cert": {
  17.             "secret": "provided-cert"
  18.           },
  19.           "key": {
  20.             "secret": "provided-cert"
  21.           }
  22.         }
  23.       }
  24.     ],
  25.     "enabledBackend": "ca-1"
  26.   },
  27.   "tracing": {
  28.     "defaultBackend": "zipkin-1",
  29.     "backends": [
  30.       {
  31.         "name": "zipkin-1",
  32.         "type": "zipkin",
  33.         "conf": {
  34.           "url": "http://zipkin.local:9411/api/v2/spans"
  35.         }
  36.       }
  37.     ]
  38.   },
  39.   "logging": {
  40.     "backends": [
  41.       {
  42.         "name": "file-tmp",
  43.         "format": "{ \"destination\": \"%KUMA_DESTINATION_SERVICE%\", \"destinationAddress\": \"%UPSTREAM_LOCAL_ADDRESS%\", \"source\": \"%KUMA_SOURCE_SERVICE%\", \"sourceAddress\": \"%KUMA_SOURCE_ADDRESS%\", \"bytesReceived\": \"%BYTES_RECEIVED%\", \"bytesSent\": \"%BYTES_SENT%\"}",
  44.         "type": "file",
  45.         "conf": {
  46.           "path": "/tmp/access.log"
  47.         }
  48.       },
  49.       {
  50.         "name": "logstash",
  51.         "type": "tcp",
  52.         "conf": {
  53.           "address": "logstash.internal:9000"
  54.         }
  55.       }
  56.     ]
  57.   },
  58.   "metrics": {
  59.     "enabledBackend": "prometheus-1",
  60.     "backends": [
  61.       {
  62.         "name": "prometheus-1",
  63.         "type": "prometheus",
  64.         "conf": {
  65.           "port": 1234,
  66.           "path": "/metrics"
  67.         }
  68.       } 
  69.     ]
  70.   }
  71. }

Create/Update Mesh

Request: PUT /meshes/{name} with Mesh entity in body

Response: 201 Created when the resource is created and 200 OK when it is updated

Example:

  1. curl -XPUT http://localhost:5681/meshes/mesh-1 --data @mesh.json -H'content-type: application/json'
  1. {
  2.   "name": "mesh-1",
  3.   "type": "Mesh",
  4.   "mtls": {
  5.     "backends": [
  6.       {
  7.         "name": "ca-1",
  8.         "type": "builtin"
  9.       },
  10.       {
  11.         "name": "ca-2",
  12.         "type": "provided",
  13.         "conf": {
  14.           "cert": {
  15.             "secret": "provided-cert"
  16.           },
  17.           "key": {
  18.             "secret": "provided-cert"
  19.           }
  20.         }
  21.       }
  22.     ],
  23.     "enabledBackend": "ca-1"
  24.   },
  25.   "tracing": {
  26.     "defaultBackend": "zipkin-1",
  27.     "backends": [
  28.       {
  29.         "name": "zipkin-1",
  30.         "type": "zipkin",
  31.         "conf": {
  32.           "url": "http://zipkin.local:9411/api/v2/spans"
  33.         }
  34.       }
  35.     ]
  36.   },
  37.   "logging": {
  38.     "backends": [
  39.       {
  40.         "name": "file-tmp",
  41.         "format": "{ \"destination\": \"%KUMA_DESTINATION_SERVICE%\", \"destinationAddress\": \"%UPSTREAM_LOCAL_ADDRESS%\", \"source\": \"%KUMA_SOURCE_SERVICE%\", \"sourceAddress\": \"%KUMA_SOURCE_ADDRESS%\", \"bytesReceived\": \"%BYTES_RECEIVED%\", \"bytesSent\": \"%BYTES_SENT%\"}",
  42.         "type": "file",
  43.         "conf": {
  44.           "path": "/tmp/access.log"
  45.         }
  46.       },
  47.       {
  48.         "name": "logstash",
  49.         "type": "tcp",
  50.         "conf": {
  51.           "address": "logstash.internal:9000"
  52.         }
  53.       }
  54.     ]
  55.   },
  56.   "metrics": {
  57.     "enabledBackend": "prometheus-1",
  58.     "backends": [
  59.       {
  60.         "name": "prometheus-1",
  61.         "type": "prometheus",
  62.         "conf": {
  64.           "port": 1234,
  65.           "path": "/metrics"
  66.         }
  67.       } 
  68.     ]
  69.   }
  70. }

List Meshes

Request: GET /meshes

Response: 200 OK with body of Mesh entities

Example:

  1. curl http://localhost:5681/meshes
  1. {
  2.   "items": [
  3.     {
  4.       "name": "mesh-1",
  5.       "type": "Mesh",
  6.       "creationTime": "2020-05-12T12:31:45.606217+02:00",
  7.       "modificationTime": "2020-05-12T12:31:45.606217+02:00",
  8.       "mtls": {
  9.         "backends": [
  10.           {
  11.             "name": "ca-1",
  12.             "type": "builtin"
  13.           },
  14.           {
  15.             "name": "ca-2",
  16.             "type": "provided",
  17.             "conf": {
  18.               "cert": {
  19.                 "secret": "provided-cert"
  20.               },
  21.               "key": {
  22.                 "secret": "provided-cert"
  23.               }
  24.             }
  25.           }
  26.         ],
  27.         "enabledBackend": "ca-1"
  28.       },
  29.       "tracing": {
  30.         "defaultBackend": "zipkin-1",
  31.         "backends": [
  32.           {
  33.             "name": "zipkin-1",
  34.             "type": "zipkin",
  35.             "conf": {
  36.               "url": "http://zipkin.local:9411/api/v2/spans"
  37.             }
  38.           }
  39.         ]
  40.       },
  41.       "logging": {
  42.         "backends": [
  43.           {
  44.             "name": "file-tmp",
  45.             "format": "{ \"destination\": \"%KUMA_DESTINATION_SERVICE%\", \"destinationAddress\": \"%UPSTREAM_LOCAL_ADDRESS%\", \"source\": \"%KUMA_SOURCE_SERVICE%\", \"sourceAddress\": \"%KUMA_SOURCE_ADDRESS%\", \"bytesReceived\": \"%BYTES_RECEIVED%\", \"bytesSent\": \"%BYTES_SENT%\"}",
  46.             "type": "file",
  47.             "conf": {
  48.               "path": "/tmp/access.log"
  49.             }
  50.           },
  51.           {
  52.             "name": "logstash",
  53.             "type": "tcp",
  54.             "conf": {
  55.               "address": "logstash.internal:9000"
  56.             }
  57.           }
  58.         ]
  59.       },
  60.       "metrics": {
  61.         "enabledBackend": "prometheus-1",
  62.         "backends": [
  63.           {
  64.             "name": "prometheus-1",
  65.             "type": "prometheus",
  66.             "conf": {
  67.               "port": 1234,
  68.               "path": "/metrics"
  69.             }
  70.           } 
  71.         ]
  72.       }
  73.     }
  74.   ],
  75.   "next": "http://localhost:5681/meshes?offset=1"
  76. }

Delete Mesh

Request: DELETE /meshes/{name}

Response: 200 OK

Example:

  1. curl -XDELETE http://localhost:5681/meshes/mesh-1

Mesh Insights

Get Mesh Insights

Request: GET /mesh-insights/{name}

Response: 200 OK with MeshInsight entity

Example:

  1. curl http://localhost:5681/mesh-insights/default
  1. {
  2.  "type": "MeshInsight",
  3.  "name": "default",
  4.  "creationTime": "2020-11-17T08:10:24.886346Z",
  5.  "modificationTime": "2020-11-17T19:21:39.912878Z",
  6.  "lastSync": "2020-11-17T12:21:39.912877Z",
  7.  "dataplanes": {
  8.   "total": 1,
  9.   "offline": 1,
  10.   "partiallyDegraded": 1
  11.  },
  12.  "policies": {
  13.   "Secret": {
  14.    "total": 1
  15.   },
  16.   "TrafficPermission": {
  17.    "total": 1
  18.   },
  19.   "TrafficRoute": {
  20.    "total": 1
  21.   }
  22.  },
  23.  "dpVersions": {
  24.   "kumaDp": {
  25.    "1.0.0-rc2-119-g50e35395": {
  26.     "total": 1,
  27.     "online": 1,
  28.     "partiallyDegraded": 1
  29.    },
  30.    "1.0.4": {
  31.     "total": 1,
  32.     "online": 1,
  33.     "partiallyDegraded": 1
  34.    },
  35.    "unknown": {
  36.     "total": 1,
  37.     "online": 1,
  38.     "partiallyDegraded": 1
  39.    }
  40.   },
  41.   "envoy": {
  42.    "1.15.0": {
  43.     "total": 2,
  44.     "online": 2,
  45.     "partiallyDegraded": 1
  46.    },
  47.    "unknown": {
  48.     "total": 1,
  49.     "online": 1,
  50.     "partiallyDegraded": 1
  51.    }
  52.   }
  53.  }
  54. }

List Mesh Insights

Request: GET /mesh-insights

Response: 200 OK with body of Mesh Insight entities

Example:

  1. curl http://localhost:5681/mesh-insights
  1. {
  2.  "total": 2,
  3.  "items": [
  4.   {
  5.    "type": "MeshInsight",
  6.    "name": "default",
  7.    "creationTime": "0001-01-01T00:00:00Z",
  8.    "modificationTime": "0001-01-01T00:00:00Z",
  9.    "lastSync": "2020-11-17T12:24:11.905350Z",
  10.    "dataplanes": {
  11.     "total": 1,
  12.     "offline": 1,
  13.     "partiallyDegraded": 1
  14.    },
  15.    "policies": {
  16.     "Secret": {
  17.      "total": 1
  18.     },
  19.     "TrafficPermission": {
  20.      "total": 1
  21.     },
  22.     "TrafficRoute": {
  23.      "total": 1
  24.     }
  25.    },
  26.    "dpVersions": {
  27.     "kumaDp": {
  28.      "1.0.0-rc2-119-g50e35395": {
  29.       "total": 1,
  30.       "online": 1,
  31.       "partiallyDegraded": 1
  32.      },
  33.      "1.0.4": {
  34.       "total": 1,
  35.       "online": 1,
  36.       "partiallyDegraded": 1
  37.      },
  38.      "unknown": {
  39.       "total": 1,
  40.       "online": 1,
  41.       "partiallyDegraded": 1
  42.      }
  43.     },
  44.     "envoy": {
  45.      "1.15.0": {
  46.       "total": 2,
  47.       "online": 2,
  48.       "partiallyDegraded": 1
  49.      },
  50.      "unknown": {
  51.       "total": 1,
  52.       "online": 1,
  53.       "partiallyDegraded": 1
  54.      }
  55.     }
  56.    }
  57.   },
  58.   {
  59.    "type": "MeshInsight",
  60.    "name": "mymesh1",
  61.    "creationTime": "0001-01-01T00:00:00Z",
  62.    "modificationTime": "0001-01-01T00:00:00Z",
  63.    "lastSync": "2020-11-17T12:24:11.941534Z",
  64.    "dataplanes": {
  65.     "total": 1,
  66.     "offline": 1,
  67.     "partiallyDegraded": 1
  68.    },
  69.    "policies": {
  70.     "Secret": {
  71.      "total": 1
  72.     },
  73.     "TrafficPermission": {
  74.      "total": 1
  75.     },
  76.     "TrafficRoute": {
  77.      "total": 1
  78.     }
  79.    },
  80.    "dpVersions": {
  81.     "kumaDp": {
  82.      "1.0.0-rc2-119-g50e35395": {
  83.       "total": 1,
  84.       "online": 1,
  85.       "partiallyDegraded": 1
  86.      },
  87.      "1.0.4": {
  88.       "total": 1,
  89.       "online": 1,
  90.       "partiallyDegraded": 1
  91.      },
  92.      "unknown": {
  93.       "total": 1,
  94.       "online": 1,
  95.       "partiallyDegraded": 1
  96.      }
  97.     },
  98.     "envoy": {
  99.      "1.15.0": {
  100.       "total": 2,
  101.       "online": 2,
  102.       "partiallyDegraded": 1
  103.      },
  104.      "unknown": {
  105.       "total": 1,
  106.       "online": 1,
  107.       "partiallyDegraded": 1
  108.      }
  109.     }
  110.    }
  111.   }
  112.  ],
  113.  "next": null
  114. }

Dataplanes

Get Dataplane

Request: GET /meshes/{mesh}/dataplanes/{name}

Response: 200 OK with Mesh entity

Example:

  1. curl http://localhost:5681/meshes/mesh-1/dataplanes/backend-1
  1. {
  2.   "type": "Dataplane",
  3.   "name": "backend-1",
  4.   "mesh": "mesh-1",
  5.   "creationTime": "2020-05-12T12:31:45.606217+02:00",
  6.   "modificationTime": "2020-05-12T12:31:45.606217+02:00",
  7.   "networking": {
  8.     "address": "127.0.0.1",
  9.     "inbound": [
  10.       {
  11.         "port": 11011,
  12.         "servicePort": 11012,
  13.         "tags": {
  14.           "service": "backend",
  15.           "version": "2.0",
  16.           "env": "production"
  17.         }
  18.       }
  19.     ],
  20.     "outbound": [
  21.       {
  22.         "port": 33033,
  23.         "service": "database"
  24.       },
  25.       {
  26.         "port": 44044,
  27.         "service": "user"
  28.       }
  29.     ]
  30.   }
  31. }

Create/Update Dataplane

Request: PUT /meshes/{mesh}/dataplanes/{name} with Dataplane entity in body

Response: 201 Created when the resource is created and 200 OK when it is updated

Example:

  1. curl -XPUT http://localhost:5681/meshes/mesh-1/dataplanes/backend-1 --data @dataplane.json -H'content-type: application/json'
  1. {
  2.   "type": "Dataplane",
  3.   "name": "backend-1",
  4.   "mesh": "mesh-1",
  5.   "networking": {
  6.     "address": "127.0.0.1",
  7.     "inbound": [
  8.       {
  9.         "port": 11011,
  10.         "servicePort": 11012,
  11.         "tags": {
  12.           "service": "backend",
  13.           "version": "2.0",
  14.           "env": "production"
  15.         }
  16.       }
  17.     ],
  18.     "outbound": [
  19.       {
  20.         "port": 33033,
  21.         "service": "database"
  22.       },
  23.       {
  24.         "port": 44044,
  25.         "service": "user"
  26.       }
  27.     ]
  28.   }
  29. }

List Dataplanes

Request: GET /meshes/{mesh}/dataplanes

Response: 200 OK with body of Dataplane entities

Example:

  1. curl http://localhost:5681/meshes/mesh-1/dataplanes
  1. {
  2.   "items": [
  3.     {
  4.       "type": "Dataplane",
  5.       "name": "backend-1",
  6.       "mesh": "mesh-1",
  7.       "creationTime": "2020-05-12T12:31:45.606217+02:00",
  8.       "modificationTime": "2020-05-12T12:31:45.606217+02:00",
  9.       "networking": {
  10.         "address": "127.0.0.1",
  11.         "inbound": [
  12.           {
  13.             "port": 11011,
  14.             "servicePort": 11012,
  15.             "tags": {
  16.               "service": "backend",
  17.               "version": "2.0",
  18.               "env": "production"
  19.             }
  20.           }
  21.         ],
  22.         "outbound": [
  23.             "port": 33033,
  24.             "service": "database"
  25.           },
  26.           {
  27.             "port": 44044,
  28.             "service": "user"
  29.           }
  30.         ]
  31.       }
  32.     }
  33.   ],
  34.   "next": "http://localhost:5681/meshes/mesh-1/dataplanes?offset=1"
  35. }

Delete Dataplane

Request: DELETE /meshes/{mesh}/dataplanes/{name}

Response: 200 OK

Example:

  1. curl -XDELETE http://localhost:5681/meshes/mesh-1/dataplanes/backend-1

Dataplane Overviews

Get Dataplane Overview

Request: GET /meshes/{mesh}/dataplane+insights/{name}

Response: 200 OK with Dataplane entity including insight

Example:

  1. curl http://localhost:5681/meshes/default/dataplanes+insights/example
  1. {
  2.  "type": "DataplaneOverview",
  3.  "mesh": "default",
  4.  "name": "example",
  5.  "creationTime": "2020-05-12T12:31:45.606217+02:00",
  6.  "modificationTime": "2020-05-12T12:31:45.606217+02:00",
  7.  "dataplane": {
  8.   "networking": {
  9.    "address": "127.0.0.1",
  10.    "inbound": [
  11.     {
  12.      "port": 11011,
  13.      "servicePort": 11012,
  14.      "tags": {
  15.       "env": "production",
  16.       "service": "backend",
  17.       "version": "2.0"
  18.      }
  19.     }
  20.    ],
  21.    "outbound": [
  22.     {
  23.      "port": 33033,
  24.      "service": "database"
  25.     }
  26.    ]
  27.   }
  28.  },
  29.  "dataplaneInsight": {
  30.   "subscriptions": [
  31.    {
  32.     "id": "426fe0d8-f667-11e9-b081-acde48001122",
  33.     "controlPlaneInstanceId": "06070748-f667-11e9-b081-acde48001122",
  34.     "connectTime": "2019-10-24T14:04:56.820350Z",
  35.     "status": {
  36.      "lastUpdateTime": "2019-10-24T14:04:57.832482Z",
  37.      "total": {
  38.       "responsesSent": "3",
  39.       "responsesAcknowledged": "3"
  40.      },
  41.      "cds": {
  42.       "responsesSent": "1",
  43.       "responsesAcknowledged": "1"
  44.      },
  45.      "eds": {
  46.       "responsesSent": "1",
  47.       "responsesAcknowledged": "1"
  48.      },
  49.      "lds": {
  50.       "responsesSent": "1",
  51.       "responsesAcknowledged": "1"
  52.      },
  53.      "rds": {}
  54.     }
  55.    }
  56.   ]
  57.  }
  58. }

List Dataplane Overviews

Request: GET /meshes/{mesh}/dataplane+insights/

Response: 200 OK with Dataplane entities including insight

Example:

  1. curl http://localhost:5681/meshes/default/dataplanes+insights
  1. {
  2.   "items": [
  3.     {
  4.      "type": "DataplaneOverview",
  5.      "mesh": "default",
  6.      "name": "example",
  7.      "creationTime": "2020-05-12T12:31:45.606217+02:00",
  9.      "dataplane": {
  10.       "networking": {
  11.        "address": "127.0.0.1",
  12.        "inbound": [
  13.         {
  14.          "port": 11011,
  15.          "servicePort": 11012,
  16.          "tags": {
  17.           "env": "production",
  18.           "service": "backend",
  19.           "version": "2.0"
  20.          }
  21.         }
  22.        ],
  23.        "outbound": [
  24.         {
  25.          "port": 33033,
  26.          "service": "database"
  27.         }
  28.        ]
  29.       }
  30.      },
  31.      "dataplaneInsight": {
  32.       "subscriptions": [
  33.        {
  34.         "id": "426fe0d8-f667-11e9-b081-acde48001122",
  35.         "controlPlaneInstanceId": "06070748-f667-11e9-b081-acde48001122",
  36.         "connectTime": "2019-10-24T14:04:56.820350Z",
  37.         "status": {
  38.          "lastUpdateTime": "2019-10-24T14:04:57.832482Z",
  39.          "total": {
  40.           "responsesSent": "3",
  41.           "responsesAcknowledged": "3"
  42.          },
  43.          "cds": {
  44.           "responsesSent": "1",
  45.           "responsesAcknowledged": "1"
  46.          },
  47.          "eds": {
  48.           "responsesSent": "1",
  49.           "responsesAcknowledged": "1"
  50.          },
  51.          "lds": {
  52.           "responsesSent": "1",
  53.           "responsesAcknowledged": "1"
  54.          },
  55.          "rds": {}
  56.         }
  57.        }
  58.       ]
  59.      }
  60.     }
  61.   ],
  62.   "next": "http://localhost:5681/meshes/default/dataplanes+insights?offset=1"
  63. }

Health Check

Get Health Check

Request: GET /meshes/{mesh}/health-checks/{name}

Response: 200 OK with Health Check entity

Example:

  1. curl http://localhost:5681/meshes/mesh-1/health-checks/web-to-backend
  1. {
  2.  "type": "HealthCheck",
  3.  "mesh": "mesh-1",
  4.  "name": "web-to-backend",
  5.  "creationTime": "2020-05-12T12:31:45.606217+02:00",
  6.  "modificationTime": "2020-05-12T12:31:45.606217+02:00",
  7.  "sources": [
  8.   {
  9.    "match": {
  10.     "service": "web"
  11.    }
  12.   }
  13.  ],
  14.  "destinations": [
  15.   {
  16.    "match": {
  17.     "service": "backend"
  18.    }
  19.   }
  20.  ],
  21.  "conf": {
  22.   "interval": "10s",
  23.   "timeout": "2s",
  24.   "unhealthyThreshold": 3,
  25.   "healthyThreshold": 1,
  26.   "http": {
  27.    "path": "/health",
  28.    "requestHeadersToAdd": [
  29.     {
  30.      "append": false,
  31.      "header": {
  32.       "key": "Content-Type",
  33.       "value": "application/json"
  34.      }
  35.     },
  36.     {
  37.      "header": {
  38.       "key": "Accept",
  39.       "value": "application/json"
  40.      }
  41.     }
  42.    ],
  43.    "expectedStatuses": [
  44.     200,
  45.     201
  46.    ],
  47.    "useHttp1": true
  48.   }
  49.  }
  50. }

Create/Update Health Check

Request: PUT /meshes/{mesh}/health-checks/{name} with Health Check entity in body

Response: 201 Created when the resource is created and 200 OK when it is updated

Example:

  1. curl -XPUT http://localhost:5681/meshes/mesh-1/health-checks/web-to-backend --data @healthcheck.json -H'content-type: application/json'
  1. {
  2.  "type": "HealthCheck",
  3.  "mesh": "mesh-1",
  4.  "name": "web-to-backend",
  5.  "sources": [
  6.   {
  7.    "match": {
  8.     "service": "web"
  9.    }
  10.   }
  11.  ],
  12.  "destinations": [
  13.   {
  14.    "match": {
  15.     "service": "backend"
  16.    }
  17.   }
  18.  ],
  19.  "conf": {
  20.   "interval": "10s",
  21.   "timeout": "2s",
  22.   "unhealthyThreshold": 3,
  23.   "healthyThreshold": 1,
  24.   "http": {
  25.    "path": "/health",
  26.    "requestHeadersToAdd": [
  27.     {
  28.      "append": false,
  29.      "header": {
  30.       "key": "Content-Type",
  31.       "value": "application/json"
  32.      }
  33.     },
  34.     {
  35.      "header": {
  36.       "key": "Accept",
  37.       "value": "application/json"
  38.      }
  39.     }
  40.    ],
  41.    "expectedStatuses": [
  42.     200,
  43.     201
  44.    ],
  45.    "useHttp1": true
  46.   }
  47.  }
  48. }

List Health Checks

Request: GET /meshes/{mesh}/health-checks

Response: 200 OK with body of Health Check entities

Example:

  1. curl http://localhost:5681/meshes/mesh-1/health-checks
  1. {
  2.  "items": [
  3.   {
  4.    "type": "HealthCheck",
  5.    "mesh": "mesh-1",
  6.    "name": "web-to-backend",
  7.    "creationTime": "2020-05-12T12:31:45.606217+02:00",
  8.    "modificationTime": "2020-05-12T12:31:45.606217+02:00",
  9.    "sources": [
  10.     {
  11.      "match": {
  12.       "service": "web"
  13.      }
  14.     }
  15.    ],
  16.    "destinations": [
  17.     {
  18.      "match": {
  19.       "service": "backend"
  20.      }
  21.     }
  22.    ],
  23.    "conf": {
  24.     "interval": "10s",
  25.     "timeout": "2s",
  26.     "unhealthyThreshold": 3,
  27.     "healthyThreshold": 1,
  28.     "http": {
  29.      "path": "/health",
  30.      "requestHeadersToAdd": [
  31.       {
  32.        "append": false,
  33.        "header": {
  34.         "key": "Content-Type",
  35.         "value": "application/json"
  36.        }
  37.       },
  38.       {
  39.        "header": {
  40.         "key": "Accept",
  41.         "value": "application/json"
  42.        }
  43.       }
  44.      ],
  45.      "expectedStatuses": [
  46.       200,
  47.       201
  48.      ],
  49.      "useHttp1": true
  50.     }
  51.    }
  52.   }
  53.  ],
  54.  "next": "http://localhost:5681/meshes/mesh-1/health-checks?offset=1"
  55. }

Delete Health Check

Request: DELETE /meshes/{mesh}/health-checks/{name}

Response: 200 OK

Example:

  1. curl -XDELETE http://localhost:5681/meshes/mesh-1/health-checks/web-to-backend

Get Proxy Template

Request: GET /meshes/{mesh}/proxytemplates/{name}

Response: 200 OK with Proxy Template entity

Example:

  1. curl http://localhost:5681/meshes/mesh-1/proxytemplates/pt-1
  1. {
  2.  "type": "ProxyTemplate",
  3.  "mesh": "mesh-1",
  4.  "name": "pt-1",
  5.  "creationTime": "2020-05-12T12:31:45.606217+02:00",
  6.  "modificationTime": "2020-05-12T12:31:45.606217+02:00",
  7.  "selectors": [
  8.   {
  9.    "match": {
  10.     "service": "backend"
  11.    }
  12.   }
  13.  ],
  14.  "conf": {
  15.   "imports": [
  16.    "default-proxy"
  17.   ],
  18.   "resources": [
  19.    {
  20.     "name": "raw-name",
  21.     "version": "raw-version",
  22.     "resource": "'@type': type.googleapis.com/envoy.api.v2.Cluster\nconnectTimeout: 5s\nloadAssignment:\n  clusterName: localhost:8443\n  endpoints:\n    - lbEndpoints:\n        - endpoint:\n            address:\n              socketAddress:\n                address: 127.0.0.1\n                portValue: 8443\nname: localhost:8443\ntype: STATIC\n"
  23.    }
  24.   ]
  25.  }
  26. }

Create/Update Proxy Template

Request: PUT /meshes/{mesh}/proxytemplates/{name} with Proxy Template entity in body

Response: 201 Created when the resource is created and 200 OK when it is updated

Example:

  1. curl -XPUT http://localhost:5681/meshes/mesh-1/proxytemplates/pt-1 --data @proxytemplate.json -H'content-type: application/json'
  1. {
  2.   "type": "ProxyTemplate",
  3.   "name": "pt-1",
  4.   "mesh": "mesh-1",
  5.   "selectors": [
  6.     {
  7.       "match": {
  8.           "service": "backend"
  9.       }
  10.     }
  11.   ],
  12.   "conf": {
  13.     "imports": [
  14.       "default-proxy"
  15.     ],
  16.     "resources": [
  17.       {
  18.         "name": "raw-name",
  19.         "version": "raw-version",
  20.         "resource": "'@type': type.googleapis.com/envoy.api.v2.Cluster\nconnectTimeout: 5s\nloadAssignment:\n  clusterName: localhost:8443\n  endpoints:\n    - lbEndpoints:\n        - endpoint:\n            address:\n              socketAddress:\n                address: 127.0.0.1\n                portValue: 8443\nname: localhost:8443\ntype: STATIC\n"
  21.       }
  22.     ]
  23.   }
  24. }

List Proxy Templates

Request: GET /meshes/{mesh}/proxytemplates

Response: 200 OK with body of Proxy Template entities

Example:

  1. curl http://localhost:5681/meshes/mesh-1/proxytemplates
  1. {
  2.  "items": [
  3.   {
  4.    "type": "ProxyTemplate",
  5.    "mesh": "mesh-1",
  6.    "name": "pt-1",
  7.    "creationTime": "2020-05-12T12:31:45.606217+02:00",
  8.    "modificationTime": "2020-05-12T12:31:45.606217+02:00",
  9.    "selectors": [
  10.     {
  11.      "match": {
  12.       "service": "backend"
  13.      }
  14.     }
  15.    ],
  16.    "conf": {
  17.     "imports": [
  18.      "default-proxy"
  19.     ],
  20.     "resources": [
  21.      {
  22.       "name": "raw-name",
  23.       "version": "raw-version",
  24.       "resource": "'@type': type.googleapis.com/envoy.api.v2.Cluster\nconnectTimeout: 5s\nloadAssignment:\n  clusterName: localhost:8443\n  endpoints:\n    - lbEndpoints:\n        - endpoint:\n            address:\n              socketAddress:\n                address: 127.0.0.1\n                portValue: 8443\nname: localhost:8443\ntype: STATIC\n"
  25.      }
  26.     ]
  27.    }
  28.   }
  29.  ],
  30.  "next": "http://localhost:5681/meshes/mesh-1/proxytemplates?offset=1"
  31. }

Delete Proxy Template

Request: DELETE /meshes/{mesh}/proxytemplates/{name}

Response: 200 OK

Example:

  1. curl -XDELETE http://localhost:5681/meshes/mesh-1/proxytemplates/pt-1

Traffic Permission

Get Traffic Permission

Request: GET /meshes/{mesh}/traffic-permissions/{name}

Response: 200 OK with Traffic Permission entity

Example:

  1. curl http://localhost:5681/meshes/mesh-1/traffic-permissions/tp-1
  1. {
  2.  "type": "TrafficPermission",
  3.  "mesh": "mesh-1",
  4.  "name": "tp-1",
  5.  "creationTime": "2020-05-12T12:31:45.606217+02:00",
  6.  "modificationTime": "2020-05-12T12:31:45.606217+02:00",
  7.  "sources": [
  8.   {
  9.    "match": {
  10.     "service": "backend"
  11.    }
  12.   }
  13.  ],
  14.  "destinations": [
  15.   {
  16.    "match": {
  17.     "service": "redis"
  18.    }
  19.   }
  20.  ]
  21. }

Response: 201 Created when the resource is created and 200 OK when it is updated

Example:

  1. {
  2.   "type": "TrafficPermission",
  3.   "name": "tp-1",
  4.   "mesh": "mesh-1",
  5.   "sources": [
  6.     {
  7.       "match": {
  8.         "service": "backend"
  9.       }
  10.     }
  11.   ],
  12.   "destinations": [
  13.     {
  14.       "match": {
  15.         "service": "redis"
  16.       }
  17.     }
  18.   ]
  19. }

List Traffic Permissions

Request: GET /meshes/{mesh}/traffic-permissions

Response: 200 OK with body of Traffic Permission entities

Example:

  1. curl http://localhost:5681/meshes/mesh-1/traffic-permissions
  1. {
  2.  "items": [
  3.   {
  4.    "type": "TrafficPermission",
  5.    "mesh": "mesh-1",
  6.    "name": "tp-1",
  7.    "creationTime": "2020-05-12T12:31:45.606217+02:00",
  8.    "modificationTime": "2020-05-12T12:31:45.606217+02:00",
  9.    "sources": [
  10.     {
  11.      "match": {
  12.       "service": "backend"
  13.      }
  14.     }
  15.    ],
  16.    "destinations": [
  17.     {
  18.      "match": {
  19.       "service": "redis"
  20.      }
  21.     }
  22.    ]
  23.   }
  24.  ],
  25.  "next": "http://localhost:5681/meshes/mesh-1/traffic-permissions?offset=1"
  26. }

Delete Traffic Permission

Request: DELETE /meshes/{mesh}/traffic-permissions/{name}

Response: 200 OK

Example:

  1. curl -XDELETE http://localhost:5681/meshes/mesh-1/traffic-permissions/pt-1

Traffic Log

Get Traffic Log

Request: GET /meshes/{mesh}/traffic-logs/{name}

Response: 200 OK with Traffic Log entity

Example:

  1. curl http://localhost:5681/meshes/mesh-1/traffic-logs/tl-1
  1. {
  2.  "type": "TrafficLog",
  3.  "mesh": "mesh-1",
  4.  "name": "tl-1",
  5.  "creationTime": "2020-05-12T12:31:45.606217+02:00",
  6.  "modificationTime": "2020-05-12T12:31:45.606217+02:00",
  7.  "sources": [
  8.   {
  9.    "match": {
  10.     "service": "web",
  11.     "version": "1.0"
  12.    }
  13.   }
  14.  ],
  15.  "destinations": [
  16.   {
  17.    "match": {
  18.     "service": "backend"
  19.    }
  20.   }
  21.  ],
  22.  "conf": {
  23.   "backend": "file"
  24.  }
  25. }

Create/Update Traffic Log

Request: PUT /meshes/{mesh}/traffic-logs/{name} with Traffic Log entity in body

Response: 201 Created when the resource is created and 200 OK when it is updated

Example:

  1. curl -XPUT http://localhost:5681/meshes/mesh-1/traffic-logs/tl-1 --data @trafficlog.json -H'content-type: application/json'
  1. {
  2.   "type": "TrafficLog",
  3.   "mesh": "mesh-1",
  4.   "name": "tl-1",
  5.   "sources": [
  6.     {
  7.       "match": {
  8.         "service": "web",
  9.         "version": "1.0"
  10.       }
  11.     }
  12.   ],
  13.   "destinations": [
  14.     {
  15.       "match": {
  16.         "service": "backend"
  17.       }
  18.     }
  19.   ],
  20.   "conf": {
  21.     "backend": "file"
  22.   }
  23. }

List Traffic Logs

Request: GET /meshes/{mesh}/traffic-logs

Response: 200 OK with body of Traffic Log entities

Example:

  1. curl http://localhost:5681/meshes/mesh-1/traffic-logs
  1. {
  2.  "items": [
  3.   {
  4.    "type": "TrafficLog",
  5.    "mesh": "mesh-1",
  6.    "name": "tl-1",
  7.    "creationTime": "2020-05-12T12:31:45.606217+02:00",
  8.    "modificationTime": "2020-05-12T12:31:45.606217+02:00",
  9.    "sources": [
  10.     {
  11.      "match": {
  12.       "service": "web",
  13.       "version": "1.0"
  14.      }
  15.     }
  16.    ],
  17.    "destinations": [
  18.     {
  19.      "match": {
  20.       "service": "backend"
  21.      }
  22.     }
  23.    ],
  24.    "conf": {
  25.     "backend": "file"
  26.    }
  27.   }
  28.  ],
  29.  "next": "http://localhost:5681/meshes/mesh-1/traffic-logs?offset=1"
  30. }

Delete Traffic Log

Request: DELETE /meshes/{mesh}/traffic-logs/{name}

Response: 200 OK

Example:

  1. curl -XDELETE http://localhost:5681/meshes/mesh-1/traffic-logs/tl-1

Traffic Route

Get Traffic Route

Request: GET /meshes/{mesh}/traffic-routes/{name}

Response: 200 OK with Traffic Route entity

Example:

  1. curl http://localhost:5681/meshes/mesh-1/traffic-routes/web-to-backend
  1. {
  2.  "type": "TrafficRoute",
  3.  "mesh": "mesh-1",
  4.  "name": "web-to-backend",
  5.  "creationTime": "2020-05-12T12:31:45.606217+02:00",
  6.  "modificationTime": "2020-05-12T12:31:45.606217+02:00",
  7.  "sources": [
  8.   {
  9.    "match": {
  10.     "region": "us-east-1",
  11.     "service": "web",
  12.     "version": "v10"
  13.    }
  14.   }
  15.  ],
  16.  "destinations": [
  17.   {
  18.    "match": {
  19.     "service": "backend"
  20.    }
  21.   }
  22.  ],
  23.  "conf": {
  24.   "split": [
  25.     {
  26.      "weight": 90,
  27.      "destination": {
  28.       "region": "us-east-1",
  29.       "service": "backend",
  30.       "version": "v2"
  31.      }
  32.     },
  33.     {
  34.      "weight": 10,
  35.      "destination": {
  36.       "service": "backend",
  37.       "version": "v3"
  38.      }
  39.     }
  40.    ]
  41.  }
  42. }

Create/Update Traffic Route

Request: PUT /meshes/{mesh}/traffic-routes/{name} with Traffic Route entity in body

Response: 201 Created when the resource is created and 200 OK when it is updated

Example:

  1. curl -XPUT http://localhost:5681/meshes/mesh-1/traffic-routes/web-to-backend --data @trafficroute.json -H'content-type: application/json'
  1. {
  2.  "type": "TrafficRoute",
  3.  "name": "web-to-backend",
  4.  "mesh": "mesh-1",
  5.  "sources": [
  6.   {
  7.    "match": {
  8.     "region": "us-east-1",
  9.     "service": "web",
  10.     "version": "v10"
  11.    }
  12.   }
  13.  ],
  14.  "destinations": [
  15.   {
  16.    "match": {
  17.     "service": "backend"
  18.    }
  19.   }
  20.  ],
  21.  "conf": {
  22.     "split": [
  23.     {
  24.      "weight": 90,
  25.      "destination": {
  26.       "region": "us-east-1",
  27.       "service": "backend",
  28.       "version": "v2"
  29.      }
  30.     },
  31.     {
  32.      "weight": 10,
  33.      "destination": {
  34.       "service": "backend",
  35.       "version": "v3"
  36.      }
  37.     }
  38.    ]
  39.  }
  40. }

List Traffic Routes

Request: GET /meshes/{mesh}/traffic-routes

Response: 200 OK with body of Traffic Route entities

Example:

  1. curl http://localhost:5681/meshes/mesh-1/traffic-routes
  1. {
  2.  "items": [
  3.   {
  4.    "type": "TrafficRoute",
  5.    "mesh": "mesh-1",
  6.    "name": "web-to-backend",
  7.    "creationTime": "2020-05-12T12:31:45.606217+02:00",
  8.    "modificationTime": "2020-05-12T12:31:45.606217+02:00",
  9.    "sources": [
  10.     {
  11.      "match": {
  12.       "region": "us-east-1",
  13.       "service": "web",
  14.       "version": "v10"
  15.      }
  16.     }
  17.    ],
  18.    "destinations": [
  19.     {
  20.      "match": {
  21.       "service": "backend"
  22.      }
  23.     }
  24.    ],
  25.    "conf": {
  26.     "split": [
  27.        {
  28.         "weight": 90,
  29.         "destination": {
  30.          "region": "us-east-1",
  31.          "service": "backend",
  32.          "version": "v2"
  33.         }
  34.        },
  35.        {
  36.         "weight": 10,
  37.         "destination": {
  38.          "service": "backend",
  39.          "version": "v3"
  40.         }
  41.        }
  42.     ]
  43.    }
  44.   }
  45.  ],
  46.  "next": "http://localhost:5681/meshes/mesh-1/traffic-routes?offset=1"
  47. }

Delete Traffic Route

Request: DELETE /meshes/{mesh}/traffic-routes/{name}

Response: 200 OK

Example:

  1. curl -XDELETE http://localhost:5681/meshes/mesh-1/traffic-routes/web-to-backend

Traffic Trace

Get Traffic Trace

Request: GET /meshes/{mesh}/traffic-traces/{name}

Response: 200 OK with Traffic Trace entity

Example:

  1. curl http://localhost:5681/meshes/mesh-1/traffic-traces/tt-1
  1. {
  2.  "type": "TrafficTrace",
  3.  "mesh": "mesh-1",
  4.  "name": "tt-1",
  5.  "creationTime": "2020-05-12T12:31:45.606217+02:00",
  6.  "modificationTime": "2020-05-12T12:31:45.606217+02:00",
  7.  "conf": {
  8.   "backend": "my-zipkin"
  9.  },
  10.  "selectors": [
  11.   {
  12.    "match": {
  13.     "service": "*"
  14.    }
  15.   }
  16.  ]
  17. }

Create/Update Traffic Trace

Request: PUT /meshes/{mesh}/traffic-traces/{name} with Traffic Trace entity in body

Response: 201 Created when the resource is created and 200 OK when it is updated

Example:

  1. curl -XPUT http://localhost:5681/meshes/mesh-1/traffic-traces/tt-1 --data @traffictrace.json -H'content-type: application/json'
  1. {
  2.  "type": "TrafficTrace",
  3.  "mesh": "mesh-1",
  4.  "name": "tt-1",
  5.  "conf": {
  6.   "backend": "my-zipkin"
  7.  },
  8.  "selectors": [
  9.   {
  10.    "match": {
  11.     "service": "*"
  12.    }
  13.   }
  14.  ]
  15. }

List Traffic Traces

Request: GET /meshes/{mesh}/traffic-traces

Response: 200 OK with body of Traffic Trace entities

Example:

  1. curl http://localhost:5681/meshes/mesh-1/traffic-traces
  1. {
  2.  "items": [
  3.   {
  4.    "type": "TrafficTrace",
  5.    "mesh": "mesh-1",
  6.    "name": "tt-1",
  7.    "creationTime": "2020-05-12T12:31:45.606217+02:00",
  8.    "modificationTime": "2020-05-12T12:31:45.606217+02:00",
  9.    "selectors": [
  10.     {
  11.      "match": {
  12.       "service": "*"
  13.      }
  14.     }
  15.    ],
  16.    "conf": {
  17.     "backend": "my-zipkin"
  18.    }
  19.   }
  20.  ],
  21.  "next": "http://localhost:5681/meshes/mesh-1/traffic-traces?offset=1"
  22. }

Delete Traffic Trace

Request: DELETE /meshes/{mesh}/traffic-traces/{name}

Response: 200 OK

Example:

  1. curl -XDELETE http://localhost:5681/meshes/mesh-1/traffic-traces/tt-1

Fault Injection

Get Fault Injection

Request: GET /meshes/{mesh}/fault-injections/{name}

Response: 200 OK with Fault Injection entity

Example:

  1. curl http://localhost:5681/meshes/default/fault-injections/fi1
  1. {
  2.  "type": "FaultInjection",
  3.  "mesh": "default",
  4.  "name": "fi1",
  5.  "creationTime": "2020-05-12T12:31:45.606217+02:00",
  6.  "modificationTime": "2020-05-12T12:31:45.606217+02:00",
  7.  "sources": [
  8.   {
  9.    "match": {
  10.     "protocol": "http",
  11.     "service": "frontend",
  12.     "version": "0.1"
  13.    }
  14.   }
  15.  ],
  16.  "destinations": [
  17.   {
  18.    "match": {
  19.     "protocol": "http",
  20.     "service": "backend"
  21.    }
  22.   }
  23.  ],
  24.  "conf": {
  25.   "delay": {
  26.    "percentage": 50.5,
  27.    "value": "5s"
  28.   },
  29.   "abort": {
  30.    "percentage": 50,
  31.    "httpStatus": 500
  32.   },
  33.   "responseBandwidth": {
  34.    "percentage": 50,
  35.    "limit": "50 mbps"
  36.   }
  37.  }
  38. }

Create/Update Fault Injection

Request: PUT /meshes/{mesh}/fault-injections/{name} with Fault Injection entity in body

Response: 201 Created when the resource is created and 200 OK when it is updated

Example:

  1. curl -XPUT http://localhost:5681/meshes/default/fault-injections/fi1 --data @faultinjection.json -H'content-type: application/json'
  1. {
  2.   "type": "FaultInjection",
  3.   "name": "fi1",
  4.   "sources": [
  5.     {
  6.       "match": {
  7.         "service": "frontend",
  8.         "version": "0.1",
  9.         "protocol": "http"
  10.       }
  11.     }
  12.   ],
  13.   "destinations": [
  14.     {
  15.       "match": {
  16.         "service": "backend",
  17.         "protocol": "http"
  18.       }
  19.     }
  20.   ],
  21.   "conf": {
  22.     "delay": {
  23.       "percentage": 50.5,
  24.       "value": "5s"
  25.     },
  26.     "abort": {
  27.       "httpStatus": 500,
  28.       "percentage": 50
  29.     },
  30.     "responseBandwidth": {
  31.       "limit": "50 mbps",
  32.       "percentage": 50
  33.     }
  34.   }
  35. }

List Fault Injections

Request: GET /meshes/{mesh}/fault-injections

Response: 200 OK with body of Fault Injection entities

Example:

  1. curl http://localhost:5681/meshes/default/fault-injections
  1. {
  2.  "items": [
  3.   {
  4.    "type": "FaultInjection",
  5.    "mesh": "default",
  6.    "name": "fi1",
  7.    "creationTime": "2020-05-12T12:31:45.606217+02:00",
  8.    "modificationTime": "2020-05-12T12:31:45.606217+02:00",
  9.    "sources": [
  10.     {
  11.      "match": {
  13.       "service": "frontend",
  14.       "version": "0.1"
  15.      }
  16.     }
  17.    ],
  18.    "destinations": [
  19.     {
  20.      "match": {
  21.       "protocol": "http",
  22.       "service": "backend"
  23.      }
  24.     }
  25.    ],
  26.    "conf": {
  27.     "delay": {
  28.      "percentage": 50.5,
  29.      "value": "5s"
  30.     },
  31.     "abort": {
  32.      "percentage": 50,
  33.      "httpStatus": 500
  34.     },
  35.     "responseBandwidth": {
  36.      "percentage": 50,
  37.      "limit": "50 mbps"
  38.     }
  39.    }
  40.   }
  41.  ],
  42.  "next": "http://localhost:5681/meshes/default/fault-injections?offset=1"
  43. }

Delete Fault Injection

Request: DELETE /meshes/{mesh}/fault-injections/{name}

Response: 200 OK

Example:

  1. curl -XDELETE http://localhost:5681/meshes/default/fault-injections/fi1

The CLI under the hood makes HTTP requests to this API.

Retry

Get Retry

Request: GET /meshes/{mesh}/retries/{name}

Response: 200 OK with Retry entity

Example:

  1. curl http://localhost:5681/meshes/default/retries/r1
  1. {
  2.  "type": "Retry",
  3.  "mesh": "default",
  4.  "name": "r1",
  5.  "creationTime": "2020-05-12T12:31:45.606217+02:00",
  6.  "modificationTime": "2020-05-12T12:31:45.606217+02:00",
  7.  "sources": [
  8.   {
  9.    "match": {
  10.     "protocol": "http",
  11.     "service": "frontend",
  12.     "version": "0.1"
  13.    }
  14.   }
  15.  ],
  16.  "destinations": [
  17.   {
  18.    "match": {
  19.     "protocol": "http",
  20.     "service": "backend"
  21.    }
  22.   }
  23.  ],
  24.  "conf": {
  25.   "http": {
  26.    "numRetries": 5,
  27.    "perTryTimeout": "0.2s",
  28.    "backOff": {
  29.     "baseInterval": "0.02s",
  30.     "maxInterval": "1s"
  31.    },
  32.    "retriableStatusCodes": [500, 504]
  33.   },
  34.   "grpc": {
  35.    "numRetries": 5,
  36.    "perTryTimeout": "0.3s",
  37.    "backOff": {
  38.     "baseInterval": "0.03s",
  39.     "maxInterval": "1.2s"
  40.    },
  41.    "retryOn": [
  42.     "cancelled",
  43.     "deadline_exceeded",
  44.     "internal",
  45.     "resource_exhausted",
  46.     "unavailable"
  47.    ]
  48.   },
  49.   "tcp": {
  50.    "maxConnectAttempts": 4
  51.   }
  52.  }
  53. }

Create/Update Retry

Request: PUT /meshes/{mesh}/retries/{name} with Retry entity in body

Response: 201 Created when the resource is created and 200 OK when it is updated

Example:

  1. curl -XPUT http://localhost:5681/meshes/default/retries/fi1 --data @retry.json -H'content-type: application/json'
  1. {
  2.   "type": "Retry",
  3.   "mesh": "default",
  4.   "name": "r1",
  5.   "sources": [
  6.     {
  7.       "match": {
  8.         "service": "frontend",
  9.         "version": "0.1",
  10.         "protocol": "http"
  11.       }
  12.     }
  13.   ],
  14.   "destinations": [
  15.     {
  16.       "match": {
  17.         "service": "backend",
  18.         "protocol": "http"
  19.       }
  20.     }
  21.   ],
  22.   "conf": {
  23.     "http": {
  24.      "numRetries": 5,
  25.      "perTryTimeout": "0.2s",
  26.      "backOff": {
  27.       "baseInterval": "0.02s",
  28.       "maxInterval": "1s"
  29.      },
  30.      "retriableStatusCodes": [500, 504]
  31.     },
  32.     "grpc": {
  33.      "numRetries": 5,
  34.      "perTryTimeout": "0.3s",
  35.      "backOff": {
  36.       "baseInterval": "0.03s",
  37.       "maxInterval": "1.2s"
  38.      },
  39.      "retryOn": [
  40.       "cancelled",
  41.       "deadline_exceeded",
  42.       "internal",
  43.       "resource_exhausted",
  44.       "unavailable"
  45.      ]
  46.     },
  47.     "tcp": {
  48.      "maxConnectAttempts": 4
  49.     }
  50.   }
  51. }

List Retries

Request: GET /meshes/{mesh}/retries

Response: 200 OK with body of Retry entities

Example:

  1. curl http://localhost:5681/meshes/default/retries
  1. {
  2.  "items": [
  3.   {
  4.    "type": "Retry",
  5.    "mesh": "default",
  6.    "name": "r1",
  7.    "creationTime": "2020-05-12T12:31:45.606217+02:00",
  8.    "modificationTime": "2020-05-12T12:31:45.606217+02:00",
  9.    "sources": [
  10.     {
  11.      "match": {
  12.       "protocol": "http",
  13.       "service": "frontend",
  14.       "version": "0.1"
  15.      }
  16.     }
  17.    ],
  18.    "destinations": [
  19.     {
  20.      "match": {
  21.       "protocol": "http",
  22.       "service": "backend"
  23.      }
  24.     }
  25.    ],
  26.    "conf": {
  27.     "http": {
  28.      "numRetries": 5,
  29.      "perTryTimeout": "0.2s",
  30.      "backOff": {
  31.       "baseInterval": "0.02s",
  32.       "maxInterval": "1s"
  33.      },
  34.      "retriableStatusCodes": [500, 504]
  35.     },
  36.     "grpc": {
  37.      "numRetries": 5,
  38.      "perTryTimeout": "0.3s",
  39.      "backOff": {
  40.       "baseInterval": "0.03s",
  41.       "maxInterval": "1.2s"
  42.      },
  43.      "retryOn": [
  44.       "cancelled",
  45.       "deadline_exceeded",
  46.       "internal",
  47.       "resource_exhausted",
  48.       "unavailable"
  49.      ]
  50.     },
  51.     "tcp": {
  52.      "maxConnectAttempts": 4
  53.     }
  54.    }
  55.   }
  56.  ],
  57.  "next": "http://localhost:5681/meshes/default/retries?offset=1"
  58. }

Delete Retry

Request: DELETE /meshes/{mesh}/retries/{name}

Response: 200 OK

Example:

  1. curl -XDELETE http://localhost:5681/meshes/default/retries/r1

The CLI under the hood makes HTTP requests to this API.

Timeout

Request: GET /meshes/{mesh}/timeouts/{name}

Response: 200 OK with Timeout entity

Example:

  1. curl http://localhost:5681/meshes/default/timeouts/default-timeouts-web
  1. {
  2.   "type": "Timeout",
  3.   "mesh": "default",
  4.   "name": "default-timeouts-web",
  5.   "creationTime": "2021-02-16T18:41:26.016089+07:00",
  6.   "modificationTime": "2021-02-16T18:41:26.016089+07:00",
  7.   "sources": [
  8.     {
  9.       "match": {
  10.         "kuma.io/service": "*"
  11.       }
  12.     }
  13.   ],
  14.   "destinations": [
  15.     {
  16.       "match": {
  17.         "kuma.io/service": "web"
  18.       }
  19.     }
  20.   ],
  21.   "conf": {
  22.     "connectTimeout": "10s",
  23.     "grpc": {
  24.       "streamIdleTimeout": "4s",
  25.       "maxStreamDuration": "15s"
  26.     }
  27.   }
  28. }

Create/Update Timeout

Request: PUT /meshes/{mesh}/timeouts/{name} with Timeout entity in body

Response: 201 Created when the resource is created and 200 OK when it is updated

  1. curl -XPUT http://localhost:5681/meshes/default/timeouts/fi1 --data @timeout.json -H'content-type: application/json'

List Timeouts

Request: GET /meshes/{mesh}/retries

Response: 200 OK with body of Timeout entities

Example:

  1. curl http://localhost:5681/meshes/default/timeouts
  1. {
  2.   "total": 2,
  3.   "items": [
  4.     {
  5.       "type": "Timeout",
  6.       "mesh": "default",
  7.       "name": "default-timeouts-web",
  8.       "creationTime": "2021-02-16T18:41:26.016089+07:00",
  9.       "modificationTime": "2021-02-16T18:41:26.016089+07:00",
  10.       "sources": [
  11.         {
  12.           "match": {
  13.             "kuma.io/service": "*"
  14.           }
  15.         }
  16.       ],
  17.       "destinations": [
  18.         {
  19.           "match": {
  20.             "kuma.io/service": "web"
  21.           }
  22.         }
  23.       ],
  24.       "conf": {
  25.         "connectTimeout": "10s",
  26.         "grpc": {
  27.           "streamIdleTimeout": "4s",
  28.           "maxStreamDuration": "15s"
  29.         }
  30.       }
  31.     },
  32.     {
  33.       "type": "Timeout",
  34.       "mesh": "default",
  35.       "name": "timeout-all-default",
  36.       "creationTime": "2021-02-16T14:01:53.532599+07:00",
  37.       "modificationTime": "2021-02-16T14:01:53.532599+07:00",
  38.       "sources": [
  39.         {
  40.           "match": {
  41.             "kuma.io/service": "*"
  42.           }
  43.         }
  44.       ],
  45.       "destinations": [
  46.         {
  47.           "match": {
  48.             "kuma.io/service": "*"
  49.           }
  50.         }
  51.       ],
  52.       "conf": {
  53.         "connectTimeout": "5s",
  54.         "tcp": {
  55.           "idleTimeout": "3600s"
  56.         },
  57.         "http": {
  58.           "requestTimeout": "15s",
  59.           "idleTimeout": "3600s"
  60.         },
  61.         "grpc": {
  62.           "streamIdleTimeout": "300s"
  63.         }
  64.       }
  65.     }
  66.   ],
  67.   "next": null
  68. }

Delete Timeout

Request: DELETE /meshes/{mesh}/timeouts/{name}

Response: 200 OK

Example:

  1. curl -XDELETE http://localhost:5681/meshes/default/timeouts/t1

The kumactl CLI under the hood makes HTTP requests to this API.

Get Zone

Request: GET /zones/{name}

Response: 200 OK with Zone entity

Example:

  1. curl http://localhost:5681/zones/cluster-1
  1. {
  2.  "type": "Zone",
  3.  "name": "cluster-1",
  4.  "creationTime": "2020-07-28T13:14:48Z",
  5.  "modificationTime": "2020-07-28T13:14:48Z",
  6.  "ingress": {
  7.   "address": "192.168.64.17:31172"
  8.  }
  9. }

Create/Update Zone

Request: PUT /zones/{name} with Zone entity in body

Response: 201 Created when the resource is created and 200 OK when it is updated

Example:

  1. curl -XPUT http://localhost:5681/zones/cluster-1 --data @zone.json -H'content-type: application/json'
  1. {
  2.  "type": "Zone",
  3.  "name": "cluster-1",
  4.  "ingress": {
  5.   "address": "192.168.64.17:31172"
  6.  }
  7. }

List Zones

Request: GET /zones

Response: 200 OK with body of Zone entities

Example:

  1. curl http://localhost:5681/zones
  1. {
  2.  "total": 2,
  3.  "items": [
  4.   {
  5.    "type": "Zone",
  6.    "name": "cluster-1",
  7.    "creationTime": "2020-07-28T13:14:48Z",
  8.    "modificationTime": "2020-07-28T13:14:48Z",
  9.    "ingress": {
  10.     "address": "192.168.64.17:31172"
  11.    }
  12.   },
  13.   {
  14.    "type": "Zone",
  15.    "name": "cluster-2",
  16.    "creationTime": "2020-07-28T13:14:50Z",
  17.    "modificationTime": "2020-07-28T13:14:50Z",
  18.    "ingress": {
  19.     "address": "192.168.64.18:32089"
  20.    }
  21.   }
  22.  ],
  23.  "next": null
  24. }

Delete Zone

Request: DELETE /zones/{name}

Response: 200 OK

Example:

  1. curl -XDELETE http://localhost:5681/zones/cluster-1

Zone Overview

Get Zone Overview

Request: GET /zones+insights/{name}

Response: 200 OK with Zone entity including insight

Example:

  1. curl http://localhost:5681/zones+insights/cluster-1
  1. {
  2.  "type": "ZoneOverview",
  3.  "mesh": "default",
  4.  "name": "cluster-1",
  5.  "creationTime": "2020-07-28T23:08:22.317322+07:00",
  6.  "modificationTime": "2020-07-28T23:08:22.317322+07:00",
  7.  "zone": {
  8.   "ingress": {
  9.    "address": "127.0.0.1:10000"
  10.   }
  11.  },
  12.  "zoneInsight": {
  13.   "subscriptions": [
  14.    {
  15.     "id": "466aa63b-70e8-4435-8bee-a7146e2cdf11",
  16.     "globalInstanceId": "66309679-ee95-4ea8-b17f-c715ca03bb38",
  17.     "connectTime": "2020-07-28T16:08:09.743141Z",
  18.     "disconnectTime": "2020-07-28T16:08:09.743194Z",
  19.     "status": {
  20.      "total": {}
  21.     }
  22.    },
  23.    {
  24.     "id": "f586f89c-2c4e-4f93-9a56-f0ea2ff010b7",
  25.     "globalInstanceId": "66309679-ee95-4ea8-b17f-c715ca03bb38",
  26.     "connectTime": "2020-07-28T16:08:24.760801Z",
  27.     "status": {
  28.      "lastUpdateTime": "2020-07-28T16:08:25.770774Z",
  29.      "total": {
  30.       "responsesSent": "11",
  31.       "responsesAcknowledged": "11"
  32.      },
  33.      "stat": {
  34.       "CircuitBreaker": {
  35.        "responsesSent": "1",
  36.        "responsesAcknowledged": "1"
  37.       },
  38.       "Dataplane": {
  39.        "responsesSent": "1",
  40.        "responsesAcknowledged": "1"
  41.       },
  42.       "FaultInjection": {
  43.        "responsesSent": "1",
  44.        "responsesAcknowledged": "1"
  45.       },
  46.       "HealthCheck": {
  47.        "responsesSent": "1",
  48.        "responsesAcknowledged": "1"
  49.       },
  50.       "Mesh": {
  51.        "responsesSent": "1",
  52.        "responsesAcknowledged": "1"
  53.       },
  54.       "ProxyTemplate": {
  55.        "responsesSent": "1",
  56.        "responsesAcknowledged": "1"
  57.       },
  58.       "Secret": {
  59.        "responsesSent": "1",
  60.        "responsesAcknowledged": "1"
  61.       },
  62.       "TrafficLog": {
  63.        "responsesSent": "1",
  64.        "responsesAcknowledged": "1"
  65.       },
  66.       "TrafficPermission": {
  67.        "responsesSent": "1",
  68.        "responsesAcknowledged": "1"
  69.       },
  70.       "TrafficRoute": {
  71.        "responsesSent": "1",
  72.        "responsesAcknowledged": "1"
  73.       },
  74.       "TrafficTrace": {
  75.        "responsesSent": "1",
  76.        "responsesAcknowledged": "1"
  77.       }
  78.      }
  79.     }
  80.    }
  81.   ]
  82.  }
  83. }

List Zone Overview

Request: GET /zones+insights

Response: 200 OK with Zone entities including insight

Example:

  1. curl http://localhost:5681/zones
  1. {
  2.   "total": 1,
  3.   "items": [
  4.   {
  5.    "type": "ZoneOverview",
  6.    "mesh": "default",
  7.    "name": "cluster-1",
  8.    "creationTime": "2020-07-28T23:08:22.317322+07:00",
  9.    "modificationTime": "2020-07-28T23:08:22.317322+07:00",
  10.    "zone": {
  11.     "ingress": {
  12.      "address": "127.0.0.1:10000"
  13.     }
  14.    },
  15.    "zoneInsight": {
  16.     "subscriptions": [
  17.      {
  18.       "id": "466aa63b-70e8-4435-8bee-a7146e2cdf11",
  19.       "globalInstanceId": "66309679-ee95-4ea8-b17f-c715ca03bb38",
  20.       "connectTime": "2020-07-28T16:08:09.743141Z",
  21.       "disconnectTime": "2020-07-28T16:08:09.743194Z",
  22.       "status": {
  23.        "total": {}
  24.       }
  25.      },
  26.      {
  27.       "id": "f586f89c-2c4e-4f93-9a56-f0ea2ff010b7",
  28.       "globalInstanceId": "66309679-ee95-4ea8-b17f-c715ca03bb38",
  29.       "connectTime": "2020-07-28T16:08:24.760801Z",
  30.       "status": {
  31.        "lastUpdateTime": "2020-07-28T16:08:25.770774Z",
  32.        "total": {
  33.         "responsesSent": "11",
  34.         "responsesAcknowledged": "11"
  35.        },
  36.        "stat": {
  37.         "CircuitBreaker": {
  38.          "responsesSent": "1",
  39.          "responsesAcknowledged": "1"
  40.         },
  41.         "Dataplane": {
  42.          "responsesSent": "1",
  43.          "responsesAcknowledged": "1"
  44.         },
  45.         "FaultInjection": {
  46.          "responsesSent": "1",
  47.          "responsesAcknowledged": "1"
  48.         },
  49.         "HealthCheck": {
  50.          "responsesSent": "1",
  51.          "responsesAcknowledged": "1"
  52.         },
  53.         "Mesh": {
  54.          "responsesSent": "1",
  55.          "responsesAcknowledged": "1"
  56.         },
  57.         "ProxyTemplate": {
  58.          "responsesSent": "1",
  59.          "responsesAcknowledged": "1"
  60.         },
  61.         "Secret": {
  62.          "responsesSent": "1",
  63.          "responsesAcknowledged": "1"
  64.         },
  65.         "TrafficLog": {
  66.          "responsesSent": "1",
  67.          "responsesAcknowledged": "1"
  68.         },
  69.         "TrafficPermission": {
  70.          "responsesSent": "1",
  71.          "responsesAcknowledged": "1"
  72.         },
  73.         "TrafficRoute": {
  74.          "responsesSent": "1",
  75.          "responsesAcknowledged": "1"
  76.         },
  77.         "TrafficTrace": {
  78.          "responsesSent": "1",
  79.          "responsesAcknowledged": "1"
  80.         }
  81.        }
  82.       }
  83.      }
  84.     ]
  85.    }
  86.   }
  87.   ],
  88.  "next": null
  89. }

External Services

Get External Service

Request: GET /meshes/{mesh}/external-services/{name}

Response: 200 OK with External Service entity

Example:

  1. curl localhost:5681/meshes/default/external-services/httpbin
  1. {
  2.  "type": "ExternalService",
  3.  "mesh": "default",
  4.  "name": "httpbin",
  5.  "creationTime": "2020-10-12T09:40:27.224648+03:00",
  6.  "modificationTime": "2020-10-12T09:40:27.224648+03:00",
  7.  "networking": {
  8.   "address": "httpbin.org:80",
  9.   "tls": {}
  10.  },
  11.  "tags": {
  12.   "kuma.io/protocol": "http",
  13.   "kuma.io/service": "httpbin"
  14.  }
  15. }

Create/Update External Service

Request: PUT /meshes/{mesh}/external-services/{name} with External Service entity in body

Response: 201 Created when the resource is created and 200 OK when it is updated

Example:

  1. curl -XPUT http://localhost:5681/meshes/default/external-services/es --data @es.json -H'content-type: application/json'
  1. {
  2.  "type": "ExternalService",
  3.  "mesh": "default",
  4.  "name": "es",
  5.  "networking": {
  6.   "address": "httpbin.org:80",
  7.   "tls": {}
  8.  },
  9.  "tags": {
  10.   "kuma.io/protocol": "http",
  11.   "kuma.io/service": "es"
  12.  }
  13. }

List External Services

Request: GET /external-services

Response: 200 OK with body of Zone entities

Example:

  1. curl http://localhost:5681/external-services
  1. {
  2.  "total": 2,
  3.  "items": [
  4.   {
  5.    "type": "ExternalService",
  6.    "mesh": "default",
  7.    "name": "httpbin",
  8.    "creationTime": "2020-10-12T09:40:27.224648+03:00",
  9.    "modificationTime": "2020-10-12T09:40:27.224648+03:00",
  10.    "networking": {
  11.     "address": "httpbin.org:80",
  12.     "tls": {}
  13.    },
  14.    "tags": {
  15.     "kuma.io/protocol": "http",
  16.     "kuma.io/service": "httpbin"
  17.    }
  18.   },
  19.   {
  20.    "type": "ExternalService",
  21.    "mesh": "default",
  22.    "name": "httpsbin",
  23.    "creationTime": "2020-10-12T09:41:07.275867+03:00",
  24.    "modificationTime": "2020-10-12T09:41:07.275867+03:00",
  25.    "networking": {
  26.     "address": "httpbin.org:443",
  27.     "tls": {
  28.      "enabled": true,
  29.      "caCert": {
  30.       "inline": "LS0tLS1=="
  31.      }
  32.     }
  33.    },
  34.    "tags": {
  35.     "kuma.io/protocol": "http",
  36.     "kuma.io/service": "httpsbin"
  37.    }
  38.   }
  39.  ],
  40.  "next": null
  41. }

Delete External Services

Request: DELETE /meshes/{mesh}/external-services/{name}

Response: 200 OK

Example:

  1. curl -XDELETE http://localhost:5681/meshes/default/external-services/es

Service Insights

Get Service Insight

Request: GET /meshes/{mesh}/service-insights/{name}

Response: 200 OK with Service Insight entity

Example:

  1. curl localhost:5681/meshes/default/service-insights/backend
  1. {
  2.  "type": "ServiceInsight",
  3.  "mesh": "default",
  4.  "name": "backend",
  5.  "creationTime": "2020-10-12T09:40:27.224648+03:00",
  6.  "modificationTime": "2020-10-12T09:40:27.224648+03:00",
  7.  "status": "partially_degraded",
  8.  "dataplanes": {
  9.    "online": 1,
  10.    "offline": 1,
  11.    "total": 2
  12.  }
  13. }

List Service Insights

Request: GET /service-insights

Response: 200 OK with body of Service Insights entities

Example:

  1. curl http://localhost:5681/service-insights
  1. {
  2.  "total": 2,
  3.  "items": [
  4.   {
  5.    "type": "ServiceInsight",
  6.    "mesh": "default",
  7.    "name": "backend",
  8.    "creationTime": "2020-10-12T09:40:27.224648+03:00",
  9.    "modificationTime": "2020-10-12T09:40:27.224648+03:00",
  10.    "status": "partially_degraded",
  11.    "dataplanes": {
  12.      "online": 1,
  13.      "offline": 1,
  14.      "total": 2
  15.    }
  16.   },
  17.   {
  18.    "type": "ServiceInsight",
  19.    "mesh": "default",
  20.    "name": "backend-api",
  21.    "creationTime": "2020-10-12T09:40:27.224648+03:00",
  22.    "modificationTime": "2020-10-12T09:40:27.224648+03:00",
  23.    "status": "partially_degraded", 
  24.    "dataplanes": {
  25.      "online": 1,
  26.      "offline": 1,
  27.      "total": 2
  28.    }
  29.   }
  30.  ],
  31.  "next": null
  32. }

Secrets

Get Secret

Request: GET /meshes/{mesh}/secrets/{name}

Response: 200 OK with Secret entity

Example:

  1. curl localhost:5681/meshes/default/secrets/sample-secret
  1. {
  2.   "type": "Secret",
  3.   "mesh": "default",
  4.   "name": "sample-secret",
  5.   "creationTime": "2021-02-18T18:46:42.195647+01:00",
  6.   "modificationTime": "2021-02-18T18:46:42.195647+01:00",
  7.   "data": "dGVzdAo="
  8. }

Create/Update Secret

Request: PUT /meshes/{mesh}/secrets/{name} with Secret entity in body

Response: 201 Created when the resource is created and 200 OK when it is updated

Example:

  1. curl -XPUT http://localhost:5681/meshes/default/secrets/sample-secret --data @secret.json -H'content-type: application/json'
  1. {
  2.   "type": "Secret",
  3.   "mesh": "default",
  4.   "name": "sample-secret",
  5.   "data": "dGVzdAo="
  6. }

List Secrets

Request: GET /meshes/{mesh}/secrets

Response: 200 OK with body of Secret entities

Example:

  1. curl http://localhost:5681/meshes/default/secrets
  1. {
  2.   "total": 1,
  3.   "items": [
  4.     {
  5.       "type": "Secret",
  6.       "name": "sample-secret",
  7.       "mesh": "default",
  8.       "creationTime": "2021-02-18T18:46:42.195647+01:00",
  9.       "modificationTime": "2021-02-18T18:46:42.195647+01:00",
  10.       "data": "dGVzdAo="
  11.     }
  12.   ],
  13.   "next": null
  14. }

Delete Secret

Request: DELETE /meshes/{mesh}/secrets/{name}

Response: 200 OK

Example:

  1. curl -XDELETE http://localhost:5681/meshes/default/secrets/sample-secret

Global Secrets

Get Global Secret

Request: GET /global-secrets/{name}

Response: 200 OK with Global Secret entity

Example:

  1. curl localhost:5681/sample-global-secret
  1. {
  2.   "type": "Secret",
  3.   "name": "sample-global-secret",
  4.   "creationTime": "2021-02-18T18:46:42.195647+01:00",
  5.   "modificationTime": "2021-02-18T18:46:42.195647+01:00",
  6.   "data": "dGVzdAo="
  7. }

Create/Update Global Secret

Request: PUT /global-secrets/{name} with Global Secret entity in body

Response: 201 Created when the resource is created and 200 OK when it is updated

Example:

  1. curl -XPUT http://localhost:5681/global-secrets/sample-global-secret --data @secret.json -H'content-type: application/json'
  1. {
  2.   "type": "Secret",
  3.   "name": "sample-global-secret",
  4.   "data": "dGVzdAo="
  5. }

List Global Secrets

Request: GET /global-secrets

Response: 200 OK with body of Global Secret entities

Example:

  1. curl http://localhost:5681/global-secrets
  1. {
  2.   "total": 1,
  3.   "items": [
  4.     {
  5.       "type": "Secret",
  6.       "name": "sample-global-secret",
  7.       "creationTime": "2021-02-18T18:46:42.195647+01:00",
  8.       "modificationTime": "2021-02-18T18:46:42.195647+01:00",
  9.       "data": "dGVzdAo="
  10.     }
  11.   ],
  12.   "next": null
  13. }

Delete Global Secret

Request: DELETE /global-secrets/{name}

Response: 200 OK

Example:

  1. curl -XDELETE http://localhost:5681/global-secrets/sample-global-secret

Multi-zone

These APIs are available on the Global control plane, when running in a distributed .

Zones status

Request: GET /status/zones

Response: 200 OK

Example:

  1. curl -XGET http://localhost:5681/status/zones
  1. [
  2.  {
  3.   "name": "zone-1",
  4.   "url": "grpcs://1.1.1.1:5685",
  5.   "active": true
  6.  },
  7.  {
  8.   "name": "zone-2",
  9.   "url": "grpcs://2.2.2.2:5685",
  10.   "active": false
  11.  }
  12. ]

Dataplane Proxy Tokens

Generate the data plane proxy tokens required for data plane proxy authentication.

Requires authentication to the control plane by the user.

For details, see .

Request: PUT /tokens with the following body:

  1. {
  2.   "name": "dp-echo-1",
  3.   "mesh": "default",
  4.   "tags": {
  5.     "kuma.io/service": ["backend", "backend-admin"]
  6.   }
  7. }

Example: