Catalog

Search…
Catalog
Grey Matter Catalog is one of Grey Matter's core microservices. It provides additional metadata about meshes and services to the Grey Matter Application. Catalog can be leveraged as an API to develop further visualizations of a service mesh.
The following API documentation is adapted from v2.0 of the Catalog OpenAPI specification.
Summary
GET /summary
Returns a summary of all meshes with services and metadata included.
Response
1
{
2
  "meshes": {
3
    "greymatter_example": {
4
      "mesh_id": "greymatter_example",
5
      "configuration": {
6
        "mesh_id": "greymatter_example",
7
        "mesh_type": "greymatter",
8
        "name": "Grey Matter Mesh",
9
        "sessions": {
10
          "default": {
11
            "cluster": "edge",
12
            "url": "control.default.svc:50000",
13
            "zone": "zone-default-zone"
14
          }
15
        },
16
        "labels": {
17
          "configuration_url": "https://domain.yourcompany.org/services/control-api/latest/v1.0/",
18
          "zone_key": "zone-default-zone"
19
        },
20
        "external_links": [
21
          {
22
            "title": "Grey Matter Home Page",
23
            "url": "https://greymatter.io"
24
          }
25
        ]
26
      },
27
      "session_statuses": {
28
        "default": "OK"
29
      },
30
      "instance_counts": {
31
        "catalog": 1,
32
        "control-api": 1,
33
        "dashboard": 1,
34
        "edge": 1,
35
        "jwt-security": 1,
36
        "prometheus": 1,
37
        "slo": 1
38
      },
39
      "metadata": {
40
        "owners": [
41
          "Decipher"
42
        ],
43
        "capabilities": [
44
          "Sense",
45
          "Apps",
46
          "Security",
47
          "Mesh"
48
        ],
49
        "service_count": 6,
50
        "service_stable_count": 6,
51
        "service_warning_count": 0,
52
        "service_down_count": 0,
53
        "instance_count": 6
54
      },
55
      "services": {
56
        "catalog": {
57
          "service_id": "catalog",
58
          "mesh_id": "greymatter_example",
59
          "name": "Grey Matter Catalog",
60
          "version": "latest",
61
          "description": "The Grey Matter Catalog service interfaces with the Fabric mesh xDS interface to provide high level summaries and more easily consumable views of the current state of the mesh. It powers the Grey Matter application and any other applications that need to understand what is present in the mesh.",
62
          "owner": "Decipher",
63
          "owner_url": "https://greymatter.io",
64
          "api_endpoint": "services/catalog/latest/",
65
          "api_spec_endpoint": "/services/catalog/latest/",
66
          "capability": "Mesh",
67
          "runtime": "GO",
68
          "documentation": "/services/catalog/latest/",
69
          "prometheus_job": "catalog",
70
          "min_instances": 1,
71
          "max_instances": 1,
72
          "enable_instance_metrics": true,
73
          "enable_historical_metrics": true,
74
          "business_impact": "high",
75
          "external_links": [],
76
          "mesh_type": "greymatter",
77
          "localities": [
78
            "zone-default-zone"
79
          ],
80
          "instances": [
81
            {
82
              "instance_id": "c9e7276db631b031caf9cb7dcec0c5d9",
83
              "session": "default",
84
              "locality": "zone-default-zone",
85
              "metadata": {
86
                "start_time": 1616795106620
87
              }
88
            }
89
          ],
90
          "metadata": {
91
            "metrics_port": 8081,
92
            "protocols": [
93
              "mTLS/HTTP"
94
            ]
95
          },
96
          "status": "stable"
97
        },
98
        "control-api": {
99
          "service_id": "control-api",
100
          "mesh_id": "greymatter_example",
101
          "name": "Grey Matter Control API",
102
          "version": "1.5.4",
103
          "description": "The purpose of the Grey Matter Control API is to update the configuration of every Grey Matter Proxy in the mesh.",
104
          "owner": "Decipher",
105
          "owner_url": "https://greymatter.io",
106
          "api_endpoint": "services/control-api/latest/",
107
          "api_spec_endpoint": "/services/control-api/latest/",
108
          "capability": "Mesh",
109
          "runtime": "GO",
110
          "documentation": "/services/control-api/latest/",
111
          "prometheus_job": "control-api",
112
          "min_instances": 1,
113
          "max_instances": 1,
114
          "enable_instance_metrics": true,
115
          "enable_historical_metrics": true,
116
          "business_impact": "critical",
117
          "external_links": [],
118
          "mesh_type": "greymatter",
119
          "localities": [
120
            "zone-default-zone"
121
          ],
122
          "instances": [
123
            {
124
              "instance_id": "1e4687d8677e028f044075400f3dbc11",
125
              "session": "default",
126
              "locality": "zone-default-zone",
127
              "metadata": {
128
                "start_time": 1616181075916
129
              }
130
            }
131
          ],
132
          "metadata": {
133
            "metrics_port": 8081,
134
            "protocols": [
135
              "mTLS/HTTP"
136
            ]
137
          },
138
          "status": "stable"
139
        },
140
        "dashboard": {
141
          "service_id": "dashboard",
142
          "mesh_id": "greymatter_example",
143
          "name": "Grey Matter Dashboard",
144
          "version": "4.0.2",
145
          "description": "The Grey Matter application is a user dashboard that paints a high-level picture of the service mesh.",
146
          "owner": "Decipher",
147
          "owner_url": "https://greymatter.io",
148
          "api_endpoint": "",
149
          "api_spec_endpoint": "",
150
          "capability": "Apps",
151
          "runtime": "GO",
152
          "documentation": "",
153
          "prometheus_job": "dashboard",
154
          "min_instances": 1,
155
          "max_instances": 1,
156
          "enable_instance_metrics": true,
157
          "enable_historical_metrics": true,
158
          "business_impact": "high",
159
          "external_links": [],
160
          "mesh_type": "greymatter",
161
          "localities": [
162
            "zone-default-zone"
163
          ],
164
          "instances": [
165
            {
166
              "instance_id": "a89866a4b8cea7391cea2a899884e141",
167
              "session": "default",
168
              "locality": "zone-default-zone",
169
              "metadata": {
170
                "start_time": 1616621191628
171
              }
172
            }
173
          ],
174
          "metadata": {
175
            "metrics_port": 8081,
176
            "protocols": [
177
              "mTLS/HTTP"
178
            ]
179
          },
180
          "status": "stable"
181
        },
182
        "edge": {
183
          "service_id": "edge",
184
          "mesh_id": "greymatter_example",
185
          "name": "Grey Matter Edge",
186
          "version": "1.5.1",
187
          "description": "Grey Matter Edge handles north/south traffic flowing through the mesh.",
188
          "owner": "Decipher",
189
          "owner_url": "https://greymatter.io",
190
          "api_endpoint": "",
191
          "api_spec_endpoint": "",
192
          "capability": "Mesh",
193
          "runtime": "GO",
194
          "documentation": "",
195
          "prometheus_job": "edge",
196
          "min_instances": 1,
197
          "max_instances": 1,
198
          "enable_instance_metrics": true,
199
          "enable_historical_metrics": true,
200
          "business_impact": "critical",
201
          "external_links": [],
202
          "mesh_type": "greymatter",
203
          "localities": [
204
            "zone-default-zone"
205
          ],
206
          "instances": [
207
            {
208
              "instance_id": "9cbaf1b55d7571978ba4e75c24d695ca",
209
              "session": "default",
210
              "locality": "zone-default-zone",
211
              "metadata": {
212
                "start_time": 1616181115192
213
              }
214
            }
215
          ],
216
          "metadata": {
217
            "metrics_port": 8081,
218
            "protocols": [
219
              "mTLS/HTTP"
220
            ]
221
          },
222
          "status": "stable"
223
        },
224
        "jwt-security": {
225
          "service_id": "jwt-security",
226
          "mesh_id": "greymatter_example",
227
          "name": "Grey Matter JWT Security",
228
          "version": "1.2.0",
229
          "description": "The Grey Matter JWT security service is a JWT Token generation and retrieval service.",
230
          "owner": "Decipher",
231
          "owner_url": "https://greymatter.io",
232
          "api_endpoint": "services/jwt-security/latest/",
233
          "api_spec_endpoint": "/services/jwt-security/latest/",
234
          "capability": "Security",
235
          "runtime": "GO",
236
          "documentation": "/services/jwt-security/latest/",
237
          "prometheus_job": "jwt-security",
238
          "min_instances": 1,
239
          "max_instances": 1,
240
          "enable_instance_metrics": true,
241
          "enable_historical_metrics": true,
242
          "business_impact": "critical",
243
          "external_links": [],
244
          "mesh_type": "greymatter",
245
          "localities": [
246
            "zone-default-zone"
247
          ],
248
          "instances": [
249
            {
250
              "instance_id": "f9c04fff1aa2cb8822fe2437c7d122a3",
251
              "session": "default",
252
              "locality": "zone-default-zone",
253
              "metadata": {
254
                "start_time": 1616181058871
255
              }
256
            }
257
          ],
258
          "metadata": {
259
            "metrics_port": 8081,
260
            "protocols": [
261
              "mTLS/HTTP"
262
            ]
263
          },
264
          "status": "stable"
265
        },
266
        "slo": {
267
          "service_id": "slo",
268
          "mesh_id": "greymatter_example",
269
          "name": "Grey Matter Service Level Objectives",
270
          "version": "1.2.0",
271
          "description": "Grey Matter Service Level Objectives (SLOs) allows users to manage objectives towards service-level agreements.",
272
          "owner": "Decipher",
273
          "owner_url": "https://greymatter.io",
274
          "api_endpoint": "services/slo/latest/",
275
          "api_spec_endpoint": "/services/slo/latest/",
276
          "capability": "Sense",
277
          "runtime": "GO",
278
          "documentation": "/services/slo/latest/",
279
          "prometheus_job": "slo",
280
          "min_instances": 1,
281
          "max_instances": 1,
282
          "enable_instance_metrics": true,
283
          "enable_historical_metrics": true,
284
          "business_impact": "high",
285
          "external_links": [],
286
          "mesh_type": "greymatter",
287
          "localities": [
288
            "zone-default-zone"
289
          ],
290
          "instances": [
291
            {
292
              "instance_id": "15b63a32f239120b85302160a0f3e933",
293
              "session": "default",
294
              "locality": "zone-default-zone",
295
              "metadata": {
296
                "start_time": 1615332896931
297
              }
298
            }
299
          ],
300
          "metadata": {
301
            "metrics_port": 8081,
302
            "protocols": [
303
              "mTLS/HTTP"
304
            ]
305
          },
306
          "status": "stable"
307
        }
308
      }
309
    },
310
    "istio_example": {
311
      "mesh_id": "istio_example",
312
      "configuration": {
313
        "mesh_id": "istio_example",
314
        "mesh_type": "istio",
315
        "name": "Istio Mesh",
316
        "labels": {
317
          "group_by_k8s_service": "false"
318
        },
319
        "sessions": {
320
          "default": {
321
            "url": "istiod.istio-system.svc.cluster.local:15010"
322
          }
323
        },
324
        "external_links": [
325
          {
326
            "title": "Istio Homepage",
327
            "url": "https://istio.io"
328
          }
329
        ]
330
      },
331
      "session_statuses": {
332
        "default": "OK"
333
      },
334
      "instance_counts": {
335
        "details-v1:9080": 1,
336
        "istio-egressgateway:8080": 1,
337
        "istio-egressgateway:8443": 1,
338
        "istio-egressgateway:15443": 1,
339
        "istio-ingressgateway:8080": 1,
340
        "istio-ingressgateway:8443": 1,
341
        "istio-ingressgateway:15021": 1,
342
        "istio-ingressgateway:15443": 1,
343
        "istio-ingressgateway:31400": 1,
344
        "productpage-v1:9080": 1,
345
        "ratings-v1:9080": 1,
346
        "reviews-v1:9080": 1,
347
        "reviews-v2:9080": 1,
348
        "reviews-v3:9080": 1
349
      },
350
      "metadata": {
351
        "owners": [
352
          "Istio"
353
        ],
354
        "capabilities": [
355
          "Reviews",
356
          "Details",
357
          "Product",
358
          "Rating"
359
        ],
360
        "service_count": 6,
361
        "service_stable_count": 6,
362
        "service_warning_count": 0,
363
        "service_down_count": 0,
364
        "instance_count": 6
365
      },
366
      "services": {
367
        "details-v1:9080": {
368
          "service_id": "details-v1:9080",
369
          "mesh_id": "istio_example",
370
          "name": "Details",
371
          "version": "1.0",
372
          "description": "An Istio details service. The details microservice contains book information.",
373
          "owner": "Istio",
374
          "owner_url": "https://istio.io",
375
          "api_endpoint": "",
376
          "api_spec_endpoint": "",
377
          "capability": "Details",
378
          "runtime": "GO",
379
          "documentation": "",
380
          "prometheus_job": "details-v1:9080",
381
          "min_instances": 1,
382
          "max_instances": 1,
383
          "enable_instance_metrics": false,
384
          "enable_historical_metrics": false,
385
          "business_impact": "medium",
386
          "external_links": [
387
            {
388
              "title": "Istio Homepage",
389
              "url": "https://istio.io"
390
            }
391
          ],
392
          "mesh_type": "istio",
393
          "localities": [
394
            "us-east-1a.us-east-1"
395
          ],
396
          "instances": [
397
            {
398
              "instance_id": "94bf3c25814e892cdb99318e085d9f9d",
399
              "session": "default",
400
              "locality": "us-east-1a.us-east-1",
401
              "metadata": {
402
                "istio_cluster": "outbound|9080||details.istio-services.svc.cluster.local",
403
                "k8s_deployment": "details-v1",
404
                "k8s_namespace": "istio-services",
405
                "k8s_service": "details"
406
              }
407
            }
408
          ],
409
          "metadata": {},
410
          "status": "stable"
411
        },
412
        "productpage-v1:9080": {
413
          "service_id": "productpage-v1:9080",
414
          "mesh_id": "istio_example",
415
          "name": "Product Page",
416
          "version": "1.0",
417
          "description": "An Istio product page service. The productpage microservice calls the details and reviews microservices to populate the page.",
418
          "owner": "Istio",
419
          "owner_url": "https://istio.io",
420
          "api_endpoint": "",
421
          "api_spec_endpoint": "",
422
          "capability": "Product",
423
          "runtime": "GO",
424
          "documentation": "",
425
          "prometheus_job": "productpage-v1:9080",
426
          "min_instances": 1,
427
          "max_instances": 1,
428
          "enable_instance_metrics": false,
429
          "enable_historical_metrics": false,
430
          "business_impact": "critical",
431
          "external_links": [
432
            {
433
              "title": "Istio Homepage",
434
              "url": "https://istio.io"
435
            }
436
          ],
437
          "mesh_type": "istio",
438
          "localities": [
439
            "us-east-1b.us-east-1"
440
          ],
441
          "instances": [
442
            {
443
              "instance_id": "32d8b95f1eaaddee68b0dfb7d6a12656",
444
              "session": "default",
445
              "locality": "us-east-1b.us-east-1",
446
              "metadata": {
447
                "istio_cluster": "outbound|9080||productpage.istio-services.svc.cluster.local",
448
                "k8s_deployment": "productpage-v1",
449
                "k8s_namespace": "istio-services",
450
                "k8s_service": "productpage"
451
              }
452
            }
453
          ],
454
          "metadata": {},
455
          "status": "stable"
456
        },
457
        "ratings-v1:9080": {
458
          "service_id": "ratings-v1:9080",
459
          "mesh_id": "istio_example",
460
          "name": "Ratings",
461
          "version": "1.0",
462
          "description": "An Istio Ratings service",
463
          "owner": "Istio",
464
          "owner_url": "https://istio.io",
465
          "api_endpoint": "",
466
          "api_spec_endpoint": "",
467
          "capability": "Rating",
468
          "runtime": "GO",
469
          "documentation": "",
470
          "prometheus_job": "ratings-v1:9080",
471
          "min_instances": 1,
472
          "max_instances": 1,
473
          "enable_instance_metrics": false,
474
          "enable_historical_metrics": false,
475
          "business_impact": "low",
476
          "external_links": [
477
            {
478
              "title": "Istio Homepage",
479
              "url": "https://istio.io"
480
            }
481
          ],
482
          "mesh_type": "istio",
483
          "localities": [
484
            "us-east-1a.us-east-1"
485
          ],
486
          "instances": [
487
            {
488
              "instance_id": "1654908974fa0d29273a8c09cf1d0a92",
489
              "session": "default",
490
              "locality": "us-east-1a.us-east-1",
491
              "metadata": {
492
                "istio_cluster": "outbound|9080||ratings.istio-services.svc.cluster.local",
493
                "k8s_deployment": "ratings-v1",
494
                "k8s_namespace": "istio-services",
495
                "k8s_service": "ratings"
496
              }
497
            }
498
          ],
499
          "metadata": {},
500
          "status": "stable"
501
        },
502
        "reviews-v1:9080": {
503
          "service_id": "reviews-v1:9080",
504
          "mesh_id": "istio_example",
505
          "name": "Reviews",
506
          "version": "1.0",
507
          "description": "An Istio reviews service (v1.0). The reviews microservice contains book reviews. It also calls the ratings microservice.",
508
          "owner": "Istio",
509
          "owner_url": "https://istio.io",
510
          "api_endpoint": "",
511
          "api_spec_endpoint": "",
512
          "capability": "Reviews",
513
          "runtime": "GO",
514
          "documentation": "",
515
          "prometheus_job": "reviews-v1:9080",
516
          "min_instances": 1,
517
          "max_instances": 1,
518
          "enable_instance_metrics": false,
519
          "enable_historical_metrics": false,
520
          "business_impact": "low",
521
          "external_links": [
522
            {
523
              "title": "Istio Homepage",
524
              "url": "https://istio.io"
525
            }
526
          ],
527
          "mesh_type": "istio",
528
          "localities": [
529
            "us-east-1a.us-east-1"
530
          ],
531
          "instances": [
532
            {
533
              "instance_id": "fbe805e4865355ecb8f541d3b4fdd1ea",
534
              "session": "default",
535
              "locality": "us-east-1a.us-east-1",
536
              "metadata": {
537
                "istio_cluster": "outbound|9080||reviews.istio-services.svc.cluster.local",
538
                "k8s_deployment": "reviews-v1",
539
                "k8s_namespace": "istio-services",
540
                "k8s_service": "reviews"
541
              }
542
            }
543
          ],
544
          "metadata": {},
545
          "status": "stable"
546
        },
547
        "reviews-v2:9080": {
548
          "service_id": "reviews-v2:9080",
549
          "mesh_id": "istio_example",
550
          "name": "Reviews",
551
          "version": "2.0",
552
          "description": "An Istio reviews service (v2.0). The reviews microservice contains book reviews. It also calls the ratings microservice.",
553
          "owner": "Istio",
554
          "owner_url": "https://istio.io",
555
          "api_endpoint": "",
556
          "api_spec_endpoint": "",
557
          "capability": "Reviews",
558
          "runtime": "GO",
559
          "documentation": "",
560
          "prometheus_job": "reviews-v2:9080",
561
          "min_instances": 1,
562
          "max_instances": 1,
563
          "enable_instance_metrics": false,
564
          "enable_historical_metrics": false,
565
          "business_impact": "low",
566
          "external_links": [
567
            {
568
              "title": "Istio Homepage",
569
              "url": "https://istio.io"
570
            }
571
          ],
572
          "mesh_type": "istio",
573
          "localities": [
574
            "us-east-1b.us-east-1"
575
          ],
576
          "instances": [
577
            {
578
              "instance_id": "1520b8403eeed1f2eb479c6033100007",
579
              "session": "default",
580
              "locality": "us-east-1b.us-east-1",
581
              "metadata": {
582
                "istio_cluster": "outbound|9080||reviews.istio-services.svc.cluster.local",
583
                "k8s_deployment": "reviews-v2",
584
                "k8s_namespace": "istio-services",
585
                "k8s_service": "reviews"
586
              }
587
            }
588
          ],
589
          "metadata": {},
590
          "status": "stable"
591
        },
592
        "reviews-v3:9080": {
593
          "service_id": "reviews-v3:9080",
594
          "mesh_id": "istio_example",
595
          "name": "Reviews",
596
          "version": "3.0",
597
          "description": "An Istio reviews service (v3.0). The reviews microservice contains book reviews. It also calls the ratings microservice.",
598
          "owner": "Istio",
599
          "owner_url": "https://istio.io",
600
          "api_endpoint": "",
601
          "api_spec_endpoint": "",
602
          "capability": "Reviews",
603
          "runtime": "GO",
604
          "documentation": "",
605
          "prometheus_job": "reviews-v3:9080",
606
          "min_instances": 1,
607
          "max_instances": 1,
608
          "enable_instance_metrics": false,
609
          "enable_historical_metrics": false,
610
          "business_impact": "low",
611
          "external_links": [
612
            {
613
              "title": "Istio Homepage",
614
              "url": "https://istio.io"
615
            }
616
          ],
617
          "mesh_type": "istio",
618
          "localities": [
619
            "us-east-1b.us-east-1"
620
          ],
621
          "instances": [
622
            {
623
              "instance_id": "1e736f8850cdee6e45f25aae849f3b5a",
624
              "session": "default",
625
              "locality": "us-east-1b.us-east-1",
626
              "metadata": {
627
                "istio_cluster": "outbound|9080||reviews.istio-services.svc.cluster.local",
628
                "k8s_deployment": "reviews-v3",
629
                "k8s_namespace": "istio-services",
630
                "k8s_service": "reviews"
631
              }
632
            }
633
          ],
634
          "metadata": {},
635
          "status": "stable"
636
        }
637
      }
638
    }
639
  },
640
  "metadata": {
641
    "mesh_count": 2,
642
    "owners": [
643
      "Istio",
644
      "Decipher"
645
    ],
646
    "capabilities": [
647
      "Details",
648
      "Sense",
649
      "Mesh",
650
      "Apps",
651
      "Security",
652
      "Reviews",
653
      "Product",
654
      "Rating"
655
    ],
656
    "service_count": 12,
657
    "service_stable_count": 12,
658
    "service_warning_count": 0,
659
    "service_down_count": 0,
660
    "instance_count": 12
661
  },
662
  "authorized": true
663
}
Copied!
Services
GET /services
Returns a queried list of services.
Parameters
Name
In
Type
Required
Description
service_id
query
string
false
Query for services with specific IDs.
mesh_id
query
string
false
Query for services matching specific meshes.
mesh_type
query
string
false
Query for services matching specific mesh types.
name
query
string
false
Query for services by names.
version
query
string
false
Query for services by versions.
owner
query
string
false
Query for services by owners.
capability
query
string
false
Query for services by capabilities.
runtime
query
string
false
Query for services by runtimes.
prometheus_job
query
string
false
Query for services by Prometheus job names.
business_impact
query
string
false
Query for services by business impacts.
enable_instance_metrics
query
string
false
Query for services for which instance metrics are enabled or disabled.
enable_historical_metrics
query
string
false
Query for services for which historical metrics are enabled or disabled.
status
query
string
false
Query for services by statuses.
localities
query
string
false
Query for services by localities.
protocols
query
string
false
Query for Grey Matter services by protocols.
Enums
Parameter
Value
business_impact
low
business_impact
medium
business_impact
high
business_impact
critical
enable_instance_metrics
true
enable_instance_metrics
false
enable_historical_metrics
true
enable_historical_metrics
false
status
stable
status
warning
status
down
Response
1
[
2
  {
3
    "service_id": "control-api",
4
    "mesh_id": "greymatter_example",
5
    "name": "Grey Matter Control API",
6
    "version": "1.5.4",
7
    "description": "The purpose of the Grey Matter Control API is to update the configuration of every Grey Matter Proxy in the mesh.",
8
    "owner": "Decipher",
9
    "owner_url": "https://greymatter.io",
10
    "api_endpoint": "/services/control-api/latest/",
11
    "api_spec_endpoint": "/services/control-api/latest/",
12
    "capability": "Mesh",
13
    "runtime": "GO",
14
    "documentation": "/services/control-api/latest/",
15
    "prometheus_job": "control-api",
16
    "min_instances": 1,
17
    "max_instances": 1,
18
    "enable_instance_metrics": true,
19
    "enable_historical_metrics": true,
20
    "business_impact": "critical",
21
    "external_links": [],
22
    "mesh_type": "greymatter",
23
    "localities": [
24
      "zone-default-zone"
25
    ],
26
    "instances": [
27
      {
28
        "instance_id": "1e4687d8677e028f044075400f3dbc11",
29
        "session": "default",
30
        "locality": "zone-default-zone",
31
        "metadata": {
32
          "start_time": 1616181075916
33
        }
34
      }
35
    ],
36
    "metadata": {
37
      "metrics_port": 8081,
38
      "protocols": [
39
        "mTLS/HTTP"
40
      ]
41
    },
42
    "status": "stable"
43
  },
44
  {
45
    "service_id": "productpage-v1:9080",
46
    "mesh_id": "istio_example",
47
    "name": "Product Page",
48
    "version": "1.0",
49
    "description": "An Istio product page service. The productpage microservice calls the details and reviews microservices to populate the page.",
50
    "owner": "Istio",
51
    "owner_url": "https://istio.io",
52
    "api_endpoint": "",
53
    "api_spec_endpoint": "",
54
    "capability": "Product",
55
    "runtime": "GO",
56
    "documentation": "",
57
    "prometheus_job": "productpage-v1:9080",
58
    "min_instances": 1,
59
    "max_instances": 1,
60
    "enable_instance_metrics": false,
61
    "enable_historical_metrics": false,
62
    "business_impact": "critical",
63
    "external_links": [
64
      {
65
        "title": "Istio Homepage",
66
        "url": "https://istio.io"
67
      }
68
    ],
69
    "mesh_type": "istio",
70
    "localities": [
71
      "us-east-1b.us-east-1"
72
    ],
73
    "instances": [
74
      {
75
        "instance_id": "32d8b95f1eaaddee68b0dfb7d6a12656",
76
        "session": "default",
77
        "locality": "us-east-1b.us-east-1",
78
        "metadata": {
79
          "istio_cluster": "outbound|9080||productpage.istio-services.svc.cluster.local",
80
          "k8s_deployment": "productpage-v1",
81
          "k8s_namespace": "istio-services",
82
          "k8s_service": "productpage"
83
        }
84
      }
85
    ],
86
    "metadata": {},
87
    "status": "stable"
88
  }
89
]
Copied!
POST /services
Adds a new service.
Request Body
1
{
2
  "service_id": "control-api",
3
  "mesh_id": "greymatter_example",
4
  "name": "Grey Matter Control API",
5
  "version": "1.5.4",
6
  "description": "The purpose of the Grey Matter Control API is to update the configuration of every Grey Matter Proxy in the mesh.",
7
  "owner": "Decipher",
8
  "owner_url": "https://greymatter.io",
9
  "api_endpoint": "services/control-api/latest/",
10
  "api_spec_endpoint": "/services/control-api/latest/",
11
  "capability": "Mesh",
12
  "runtime": "GO",
13
  "documentation": "/services/control-api/latest/",
14
  "prometheus_job": "control-api",
15
  "min_instances": 1,
16
  "max_instances": 1,
17
  "enable_instance_metrics": true,
18
  "enable_historical_metrics": true,
19
  "business_impact": "low",
20
  "external_links": [
21
    {
22
      "title": "Grey Matter",
23
      "url": "https://greymatter.io"
24
    }
25
  ]
26
}
Copied!
Parameters
Name
In
Type
Required
Description
body
body
object
true
Request body for creating a service.
Response
1
{
2
  "service_id": "control-api",
3
  "mesh_id": "greymatter_example",
4
  "name": "Grey Matter Control API",
5
  "version": "1.5.4",
6
  "description": "The purpose of the Grey Matter Control API is to update the configuration of every Grey Matter Proxy in the mesh.",
7
  "owner": "Decipher",
8
  "owner_url": "https://greymatter.io",
Summary

`GET /summary`

Response

Services

`GET /services`

Parameters

Enums

Response

`POST /services`

Request Body

Parameters

Response
