{"@context": "https://schema.org", "@type": "WebAPI", "name": "Meshery API. API", "description": "the purpose of this application is to provide an application that is using plain go code to define an API This should demonstrate all the possible comment annotations that are available to turn go code into a fully compliant swagger 2.0 spec", "provider": {"@type": "Organization", "name": "meshery.local"}, "documentation": "https://raw.githubusercontent.com/meshery/meshery/master/helpers/swagger.yaml"}
Index / APIs / meshery.local

Meshery API. API

the purpose of this application is to provide an application that is using plain go code to define an API This should demonstrate all the possible comment annotations that are available to turn go code into a fully compliant swagger 2.0 spec

Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.

Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.

base URLs: http://meshery.local

auth: a p i k e y

find it by capability: POST /search {"query":{"text":"..."}} returns these operations with their invocation detail. Connect any agent client.

Meshery API. v0.4.27

the purpose of this application is to provide an application that is using plain go code to define an API This should demonstrate all the possible comment annotations that are available to turn go code into a fully compliant swagger 2.0 spec

methodpathwhat the vendor says it does
GET/api/application/Handle GET request for Application Files Returns requests for all Meshery Applications ApplicationsAPI
POST/api/application/Handle POST request for Application Files Save attached Meshery Application File ApplicationsAPI
POST/api/application/deployHandle POST request for Application File Deploy Deploy an attached application file with the request Applicati
DELETE/api/application/deployHandle DELETE request for Application File Deploy Delete a deployed application file with the request Applicat
GET/api/application/{id}Handle GET request for Meshery Application with the given id Fetches the list of all applications saved by the
DELETE/api/application/{id}Handle Delete for a Meshery Application File Deletes a meshery application file with ID: id ApplicationsAPI
GET/api/filterHandle GET request for all filters Returns all the Meshery Filters saved by the current user FiltersAPI
POST/api/filterHandle POST requests for Meshery Filters Used to save/update a Meshery Filter FiltersAPI
GET/api/filter/file/{id}Handle GET request for filter file with given id Returns the Meshery Filter file saved by the current user wit
GET/api/filter/{id}Handle GET request for a Meshery Filter Fetches the Meshery Filter with the given id FiltersAPI
DELETE/api/filter/{id}Handle Delete for a Meshery Filter Deletes a meshery filter with ID: id FiltersAPI
GET/api/oam/{type}Handles the get requests for the OAM objects Getting list of workloads/traits/scopes {type} being of either t
POST/api/oam/{type}Handles registering OMA objects Adding a workload/trait/scope {type} being of either trait, scope, workload;
GET/api/patternHandle GET request for patterns Returns the list of all the patterns saved by the current user This will retur
POST/api/patternHandle POST requests for patterns Edit/update a meshery pattern PatternsAPI
POST/api/pattern/deployHandle POST request for Pattern Deploy Deploy an attached pattern with the request PatternsAPI
DELETE/api/pattern/deployHandle DELETE request for Pattern Deploy Delete a deployed pattern with the request PatternsAPI
GET/api/pattern/{id}Handle GET for a Meshery Pattern Fetches the pattern with the given id PatternsAPI
DELETE/api/pattern/{id}Handle Delete for a Meshery Pattern Deletes a meshery pattern with ID: id PatternsAPI
GET/api/perf/profileHandle GET request to run a test Runs the load test with the given parameters PerfAPI
GET/api/perf/profile/resultHandles GET requests for perf results Returns pages of all the perf results from Remote Provider PerfAPI
GET/api/perf/profile/result/{id}Handles GET requests for perf result Returns an individual result from provider PerfAPI
GET/api/providerHandle GET request for the choice of provider Update the choice of provider in system ProvidersAPI
GET/api/provider/capabilitiesHandle GET requests for Provider Returns the capabilities.json for the provider ProvidersAPI
GET/api/provider/extensionHandle GET request for React Components handles the requests to serve react components from the provider packa
GET/api/providersHandle GET request for list of providers Returns the available list of providers ProvidersAPI
POST/api/system/adapter/manageHandle POST requests to persist adapter config Used to persist adapter config SystemAPI
DELETE/api/system/adapter/manageHandle DELETE requests to delete adapter config Used to delete adapter configuration SystemAPI
POST/api/system/adapter/operationHandle POST requests for Adapter Operations Used to send operations to the adapters SystemAPI
GET/api/system/adaptersHandle GET request for adapters Fetches and returns all the adapters and ping adapters SystemAPI
POST/api/system/kubernetesHandle POST request for Kubernetes Config Used to add kubernetes config to System SystemAPI
DELETE/api/system/kubernetesHandle DELETE request for Kubernetes Config Used to delete kubernetes config to System SystemAPI
POST/api/system/kubernetes/contextsHandle POST requests for Kubernetes Context list Returns the context list for a given k8s config SystemAPI
GET/api/system/kubernetes/pingHandle GET request for Kubernetes ping Fetches server version to simulate ping SystemAPI
GET/api/system/meshsync/grafanaHandle GET request for mesh-sync grafana Fetches Prometheus and Grafana SystemAPI
GET/api/system/meshsync/prometheusHandle GET request for fetching prometheus Fetches Prometheus SystemAPI
GET/api/system/syncHandle GET request for config sync Used to send session data to the UI for initial sync SystemAPI
GET/api/system/versionHandle GET request for system/server version Returns the running Meshery version SystemAPI
POST/api/telemetry/metrics/board_importHandle POST request for Prometheus board import Used for importing Grafana board for Prometheus PrometheusAPI
POST/api/telemetry/metrics/boardsHandle POST request for Prometheus board Used to persist selected board and panels PrometheusAPI

and 35 more operation(s) in this specification, all searchable.

specification origin: https://raw.githubusercontent.com/meshery/meshery/master/helpers/swagger.yaml

nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.