REST API Reference

Self-generated documentation based on Meshery’s Open API specifcation for it’s REST API. Meshery’s REST API can be explored interactively using the Swagger UI Playground.

Endpoints

/api/application/

GET Handle GET request for Application Files

Responses
200 Returns all meshery applications
Name Format Type
applications Object array
page uint64 integer
page_size uint64 integer
total_count uint64 integer

POST Handle POST request for Application Files

Responses
200 Fetches a single Meshery Application
Name Format Type
application_file Object string
created_at date-time string
id Object array
location Object object
name Object string
updated_at date-time string
user_id Object string

/api/application/deploy

POST Handle POST request for Application File Deploy

Parameters
Name Located in Description Type
Upload Yaml/Yml File formData File

Responses
200 Returns the response of the application files
Name Format Type
application_file Object string
created_at date-time string
id Object array
location Object object
name Object string
updated_at date-time string
user_id Object string

/api/application/{id}

GET Handle GET request for Meshery Application with the given id

Parameters
Name Located in Description Type
id path id for a specific String

Responses
200 Fetches a single Meshery Application
Name Format Type
application_file Object string
created_at date-time string
id Object array
location Object object
name Object string
updated_at date-time string
user_id Object string

DELETE Handle Delete for a Meshery Application File

Parameters
Name Located in Description Type
id path id for a specific String

Responses
200

/api/filter

GET Handle GET request for all filters

Responses
200 Returns all meshery filters
Name Format Type
filters Object array
page uint64 integer
page_size uint64 integer
total_count uint64 integer

POST Handle POST requests for Meshery Filters

Responses
200 Returns a single meshery filter
Name Format Type
created_at date-time string
filter_file Object string
id Object array
location Object object
name Object string
updated_at date-time string
user_id Object string

/api/filter/deploy

POST Handle POST request for Filter File Deploy

Responses
200 Returns the response of the Filter files
Name Format Type
created_at date-time string
filter_file Object string
id Object array
location Object object
name Object string
updated_at date-time string
user_id Object string

/api/filter/file/{id}

GET Handle GET request for filter file with given id

Responses
200 Returns a single meshery filter
Name Format Type
created_at date-time string
filter_file Object string
id Object array
location Object object
name Object string
updated_at date-time string
user_id Object string

/api/filter/{id}

GET Handle GET request for a Meshery Filter

Parameters
Name Located in Description Type
id path id for a specific String

Responses
200 Returns a single meshery filter
Name Format Type
created_at date-time string
filter_file Object string
id Object array
location Object object
name Object string
updated_at date-time string
user_id Object string

DELETE Handle Delete for a Meshery Filter

Parameters
Name Located in Description Type
id path id for a specific String

Responses
200

/api/pattern

GET Handle GET request for patterns

Responses
200 Returns all meshery patterns
Name Format Type
page uint64 integer
page_size uint64 integer
patterns Object array
total_count uint64 integer

POST Handle POST requests for patterns

Responses
200 Returns a single meshery pattern
Name Format Type
created_at date-time string
id Object array
location Object object
name Object string
pattern_file Object string
updated_at date-time string
user_id Object string

/api/pattern/deploy

POST Handle POST request for Pattern Deploy

Parameters
Name Located in Description Type
Upload Yaml/Yml File formData File

Responses
200

/api/pattern/{id}

GET Handle GET for a Meshery Pattern

Parameters
Name Located in Description Type
id path id for a specific String

Responses
200 Returns a single meshery pattern
Name Format Type
created_at date-time string
id Object array
location Object object
name Object string
pattern_file Object string
updated_at date-time string
user_id Object string

DELETE Handle Delete for a Meshery Pattern

Parameters
Name Located in Description Type
id path id for a specific String

Responses
200

/api/perf/profile

GET Handle GET request to run a test

Parameters
Name Located in Description Type
Query query PerformanceTestParameters contains parameters to run a performance test Object
Body body Unknown

Responses
200

/api/perf/profile/result

GET Handles GET requests for perf results

Responses
200 Returns all performance results
Name Format Type
page uint64 integer
page_size uint64 integer
results Object array
total_count uint64 integer

/api/perf/profile/result/{id}

GET Handles GET requests for perf result

Responses
200 Returns Single test result
Name Format Type
ActualQPS double number
DetailsURI Object string
EndTime date-time string
EnvID Object string
Latencies Object object
MeshConfigID Object string
SMPVersion Object string
StartTime date-time string
TestID Object string

/api/provider

GET Handle GET request for the choice of provider

Parameters
Name Located in Description Type
provider query String

Responses
200

/api/provider/capabilities

/api/provider/extension

/api/providers

GET Handle GET request for list of providers

Responses
200 Returns a list of available providers

/api/system/adapter/manage

POST Handle POST requests to persist adapter config

Parameters
Name Located in Description Type
meshLocationURL body Unknown

Responses
200 Returns all the meshery adapters

DELETE Handle DELETE requests to delete adapter config

Parameters
Name Located in Description Type
adapter query String

Responses
200

/api/system/adapter/operation

POST Handle POST requests for Adapter Operations

Parameters
Name Located in Description Type
adapter query String
query query String
customBody query String
namespace query String
deleteOp query String

Responses
200

/api/system/adapters

GET Handle GET request for adapters

Parameters
Name Located in Description Type
adapter query String

Responses
200 Return all the adapters

/api/system/kubernetes

POST Handle POST request for Kubernetes Config

Responses
200 Returns saved kubernetes config
Name Format Type
clusterConfigured Object boolean
config Object array
configuredServer Object string
contextName Object string
contexts Object array
inClusterConfig Object boolean
k8sfile Object string
nodes Object array
server_version Object string

/api/system/kubernetes/contexts

POST Handle POST requests for Kubernetes Context list

Responses
200 Returns kubernetes context list

/api/system/kubernetes/ping

/api/system/meshsync/grafana

GET Handle GET request for mesh-sync grafana

Responses
200 Returns a map for v1 services

/api/system/meshsync/prometheus

GET Handle GET request for fetching prometheus

Responses
200 Returns a map for v1 services

/api/system/sync

GET Handle GET request for config sync

Responses
200 Returns User Load Test Preferencee
Name Format Type
anonymousPerfResults Object boolean
anonymousUsageStats Object boolean
grafana Object object
k8sConfig Object object
loadTestPrefs Object object
meshAdapters Object array
prometheus Object object
updated_at date-time string

/api/system/version

GET Handle GET request for system/server version

Responses
200 Returns Meshery version
Name Format Type
build Object string
commitsha Object string
latest Object string
outdated Object boolean
release_channel Object string

/api/telemetry/metrics/board_import

POST Handle POST request for Prometheus board import

Responses
200 Response for prometheus board import
Name Format Type
org_id uint64 integer
panels Object array
slug Object string
template_vars Object array
title Object string
uid Object string
uri Object string

/api/telemetry/metrics/boards

POST Handle POST request for Prometheus board

Parameters
Name Located in Description Type
Body body Unknown

Responses
200

/api/telemetry/metrics/config

GET Handle GET for Prometheus configuration

Responses
200 Returns prometheus configuration
Name Format Type
prometheusURL Object string
selectedPrometheusBoardsConfigs Object array

POST Handle POST for Prometheus configuration

Parameters
Name Located in Description Type
prometheusURL body Unknown

Responses
200

/api/telemetry/metrics/grafana/boards

GET Handle GET request for Grafana boards

Parameters
Name Located in Description Type
dashboardSearch query String

Responses
200 Returns Grafana boards and panels

POST Handle POST request for Grafana boards

Responses
200

/api/telemetry/metrics/grafana/config

GET Handle GET request for Grafana configuration

Responses
200 Returns Grafana configs
Name Format Type
grafanaAPIKey Object string
grafanaURL Object string
selectedBoardsConfigs Object array

POST Handle POST request for Grafana configuration

Parameters
Name Located in Description Type
Body body Unknown

Responses
200

/api/telemetry/metrics/grafana/ping

/api/telemetry/metrics/grafana/query

/api/telemetry/metrics/grafana/scan

GET Handle GET request for Grafana

Responses
200 Returns a map for v1 services

/api/telemetry/metrics/ping

/api/telemetry/metrics/query

/api/telemetry/metrics/static-board

GET Handle GET request for Prometheus static board

Responses
200 Returns Prometheus static board

/api/user/login

/api/user/logout

/api/user/performance/profiles

GET Handle GET requests for performance profiles

Responses
200 Returns all the performance profiles
Name Format Type
page uint64 integer
page_size uint64 integer
profiles Object array
total_count uint64 integer

POST Handle POST requests for saving performance profile

Parameters
Name Located in Description Type
Body body Unknown

Responses
200 Returns a single performance profile
Name Format Type
concurrent_request int64 integer
content_type Object string
created_at Object object
duration Object string
endpoints Object array
id Object array
last_run Object object
load_generators Object array
name Object string
qps int64 integer
request_body Object string
request_cookies Object string
request_headers Object string
schedule Object array
service_mesh Object string
total_results int64 integer
updated_at Object object

/api/user/performance/profiles/results

GET Handles GET requests for performance results

Responses
200 Returns all performance results
Name Format Type
page uint64 integer
page_size uint64 integer
results Object array
total_count uint64 integer

/api/user/performance/profiles/{id}

GET Handle GET requests for performance results of a profile

Parameters
Name Located in Description Type
id path id for a specific String

Responses
200 Returns a single performance profile
Name Format Type
concurrent_request int64 integer
content_type Object string
created_at Object object
duration Object string
endpoints Object array
id Object array
last_run Object object
load_generators Object array
name Object string
qps int64 integer
request_body Object string
request_cookies Object string
request_headers Object string
schedule Object array
service_mesh Object string
total_results int64 integer
updated_at Object object

DELETE Handle Delete requests for performance profiles

Parameters
Name Located in Description Type
id path id for a specific String

Responses
200

/api/user/performance/profiles/{id}/results

GET Handle GET request for results of a profile

Parameters
Name Located in Description Type
id path id for a specific String

Responses
200 Returns all performance results
Name Format Type
page uint64 integer
page_size uint64 integer
results Object array
total_count uint64 integer

/api/user/performance/profiles/{id}/run

GET Handle GET request to run a performance test

Parameters
Name Located in Description Type
Body query PerformanceTestParameters contains parameters to run a performance test Object

Responses
200

/api/user/prefs

GET Handle GET for User Load Test Preferences

Responses
200 Returns User Load Test Preferencee
Name Format Type
anonymousPerfResults Object boolean
anonymousUsageStats Object boolean
grafana Object object
k8sConfig Object object
loadTestPrefs Object object
meshAdapters Object array
prometheus Object object
updated_at date-time string

POST Handle GET for User Load Test Preferences

Responses
200 Returns User Load Test Preferencee
Name Format Type
anonymousPerfResults Object boolean
anonymousUsageStats Object boolean
grafana Object object
k8sConfig Object object
loadTestPrefs Object object
meshAdapters Object array
prometheus Object object
updated_at date-time string

/api/user/prefs/perf

GET Handle GET request for load test preferences

Parameters
Name Located in Description Type
uuid query String

Responses
200 Returns load test preferences
Name Format Type
clients Object array
duration Object string
id Object string
labels Object object
name Object string
smp_version Object string

POST Handle POST request for load test preferences

Parameters
Name Located in Description Type
Body body Unknown

Responses
200

DELETE Handle DELETE request for load test preferences

Parameters
Name Located in Description Type
uuid query String

Responses
200

/api/user/schedules

GET Handle GET reqeuest for Schedules

Responses
200 Returns List of saved schedules
Name Format Type
page uint64 integer
page_size uint64 integer
schedules Object array
total_count uint64 integer

POST Handle POST reqeuest for Schedules

Responses
200 Returns a single schedules
Name Format Type
cron_expression Object string
id Object array

/api/user/schedules/{id}

GET Handle GET reqeuest for Schedules

Parameters
Name Located in Description Type
id path id for a specific String

Responses
200 Returns a single schedules
Name Format Type
cron_expression Object string
id Object array

DELETE Handle DELETE reqeuest for Schedules

Parameters
Name Located in Description Type
id path id for a specific String

Responses
200 Returns List of saved schedules
Name Format Type
page uint64 integer
page_size uint64 integer
schedules Object array
total_count uint64 integer