Meshery

Meshery 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…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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

Endpoints 75

ApplicationsAPI

  • GETHandle GET request for Application Files/api/application/Returns requests for all Meshery Applications
  • POSTHandle POST request for Application Files/api/application/Save attached Meshery Application File
  • POSTHandle POST request for Application File Deploy/api/application/deployDeploy an attached application file with the request
  • DELETEHandle DELETE request for Application File Deploy/api/application/deployDelete a deployed application file with the request
  • GETHandle GET request for Meshery Application with the given id/api/application/:idFetches the list of all applications saved by the current user
  • DELETEHandle Delete for a Meshery Application File/api/application/:idDeletes a meshery application file with ID: id

FiltersAPI

  • GETHandle GET request for all filters/api/filterReturns all the Meshery Filters saved by the current user
  • POSTHandle POST requests for Meshery Filters/api/filterUsed to save/update a Meshery Filter
  • GETHandle GET request for filter file with given id/api/filter/file/:idReturns the Meshery Filter file saved by the current user with the given id
  • GETHandle GET request for a Meshery Filter/api/filter/:idFetches the Meshery Filter with the given id
  • DELETEHandle Delete for a Meshery Filter/api/filter/:idDeletes a meshery filter with ID: id

PatternsAPI

  • GETHandles the get requests for the OAM objects/api/oam/:typeGetting list of workloads/traits/scopes {type} being of either trait, scope, workload; registration of adapter capabilities.
  • POSTHandles registering OMA objects/api/oam/:typeAdding a workload/trait/scope {type} being of either trait, scope, workload; registration of adapter capabilities.
  • GETHandle GET request for patterns/api/patternReturns the list of all the patterns saved by the current user This will return all the patterns with their details
  • POSTHandle POST requests for patterns/api/patternEdit/update a meshery pattern
  • POSTHandle POST request for Pattern Deploy/api/pattern/deployDeploy an attached pattern with the request
  • DELETEHandle DELETE request for Pattern Deploy/api/pattern/deployDelete a deployed pattern with the request
  • GETHandle GET for a Meshery Pattern/api/pattern/:idFetches the pattern with the given id
  • DELETEHandle Delete for a Meshery Pattern/api/pattern/:idDeletes a meshery pattern with ID: id

PerfAPI

  • GETHandle GET request to run a test/api/perf/profileRuns the load test with the given parameters
  • GETHandles GET requests for perf results/api/perf/profile/resultReturns pages of all the perf results from Remote Provider
  • GETHandles GET requests for perf result/api/perf/profile/result/:idReturns an individual result from provider

ProvidersAPI

  • GETHandle GET request for the choice of provider/api/provider?provider=stringUpdate the choice of provider in system
  • GETHandle GET requests for Provider/api/provider/capabilitiesReturns the capabilities.json for the provider
  • GETHandle GET request for React Components/api/provider/extensionhandles the requests to serve react components from the provider package
  • GETHandle GET request for list of providers/api/providersReturns the available list of providers
  • GETHandle GET request to provider UI/providerServers providers UI

SystemAPI

  • POSTHandle POST requests to persist adapter config/api/system/adapter/manageUsed to persist adapter config
  • DELETEHandle DELETE requests to delete adapter config/api/system/adapter/manage?adapter=stringUsed to delete adapter configuration
  • POSTHandle POST requests for Adapter Operations/api/system/adapter/operation?adapter=string&query=string&customBody=string&namespace=string&deleteOp=stringUsed to send operations to the adapters
  • GETHandle GET request for adapters/api/system/adapters?adapter=stringFetches and returns all the adapters and ping adapters
  • POSTHandle POST request for Kubernetes Config/api/system/kubernetesUsed to add kubernetes config to System
  • DELETEHandle DELETE request for Kubernetes Config/api/system/kubernetesUsed to delete kubernetes config to System
  • POSTHandle POST requests for Kubernetes Context list/api/system/kubernetes/contextsReturns the context list for a given k8s config
  • GETHandle GET request for Kubernetes ping/api/system/kubernetes/pingFetches server version to simulate ping
  • GETHandle GET request for mesh-sync grafana/api/system/meshsync/grafanaFetches Prometheus and Grafana
  • GETHandle GET request for fetching prometheus/api/system/meshsync/prometheusFetches Prometheus
  • GETHandle GET request for config sync/api/system/syncUsed to send session data to the UI for initial sync
  • GETHandle GET request for system/server version/api/system/versionReturns the running Meshery version

PrometheusAPI

  • POSTHandle POST request for Prometheus board import/api/telemetry/metrics/board_importUsed for importing Grafana board for Prometheus
  • POSTHandle POST request for Prometheus board/api/telemetry/metrics/boardsUsed to persist selected board and panels
  • GETHandle GET for Prometheus configuration/api/telemetry/metrics/configUsed for fetching Prometheus configuration
  • POSTHandle POST for Prometheus configuration/api/telemetry/metrics/configUsed for persisting Prometheus configuration
  • DELETEHandle DELETE for Prometheus configuration/api/telemetry/metrics/configUsed for deleting Prometheus configuration
  • GETHandle GET request for Prometheus Ping/api/telemetry/metrics/pingUsed to ping prometheus
  • GETHandle GET request for Prometheus Query/api/telemetry/metrics/queryUsed to prometheus queries
  • GETHandle GET request for Prometheus static board/api/telemetry/metrics/static-boardUsed to fetch the static board

GrafanaAPI

  • GETHandle GET request for Grafana boards/api/telemetry/metrics/grafana/boards?dashboardSearch=stringUsed for fetching Grafana boards and panels
  • POSTHandle POST request for Grafana boards/api/telemetry/metrics/grafana/boardsUsed for persist Grafana boards and panel selections
  • GETHandle GET request for Grafana configuration/api/telemetry/metrics/grafana/configUsed for fetching Grafana configuration
  • POSTHandle POST request for Grafana configuration/api/telemetry/metrics/grafana/configUsed for persisting Grafana configuration
  • DELETEHandle DELETE request for Grafana configuration/api/telemetry/metrics/grafana/configUsed for Delete Grafana configuration
  • GETHandle GET request for Grafana ping/api/telemetry/metrics/grafana/pingUsed to initiate a Grafana ping
  • GETHandle GET request for Grafana queries/api/telemetry/metrics/grafana/queryUsed for handling Grafana queries
  • GETHandle GET request for Grafana/api/telemetry/metrics/grafana/scanFetches and returns Grafana

UserAPI

  • GETHandlers GET request for User login/api/user/loginRedirects user for auth or issues session
  • GETHandlers GET request for User logout/api/user/logoutRedirects user for auth or issues session
  • GETHandle GET for User Load Test Preferences/api/user/prefsReturns User Load Test Preferences
  • POSTHandle GET for User Load Test Preferences/api/user/prefsUpdates User Load Test Preferences
  • GETHandle GET request for load test preferences/api/user/prefs/perf?uuid=3fa85f64-5717-4562-b3fc-2c963f66afa6Used for fetching load test preferences
  • POSTHandle POST request for load test preferences/api/user/prefs/perfUsed for persisting load test preferences
  • DELETEHandle DELETE request for load test preferences/api/user/prefs/perf?uuid=3fa85f64-5717-4562-b3fc-2c963f66afa6Used for deleting load test preferences
  • GETHandle GET request for tokens/api/user/tokenReturns token from the actual provider in a file resposese: 200:
  • POSTHandle POST request for tokens/api/user/tokenReceives token from the actual provider resposese: 200:

PerformanceAPI

  • GETHandle GET requests for performance profiles/api/user/performance/profilesReturns the list of all the performance profiles saved by the current user
  • POSTHandle POST requests for saving performance profile/api/user/performance/profilesSave performance profile using the current provider's persistence mechanism
  • GETHandles GET requests for performance results/api/user/performance/profiles/resultsReturns pages of all the performance results from Remote Provider
  • GETHandle GET requests for performance results of a profile/api/user/performance/profiles/:idReturns single performance profile with the given id
  • DELETEHandle Delete requests for performance profiles/api/user/performance/profiles/:idDeletes a performance profile with the given id
  • GETHandle GET request for results of a profile/api/user/performance/profiles/:id/resultsFetchs pages of results from Remote Provider for the given id
  • GETHandle GET request to run a performance test/api/user/performance/profiles/:id/runRuns the load test with the given parameters

SchedulesAPI

  • GETHandle GET reqeuest for Schedules/api/user/schedulesReturns the list of all the schedules saved by the current user
  • POSTHandle POST reqeuest for Schedules/api/user/schedulesSave schedule using the current provider's persistence mechanism
  • GETHandle GET reqeuest for Schedules/api/user/schedules/:idFetches and returns the schedule with the given id
  • DELETEHandle DELETE reqeuest for Schedules/api/user/schedules/:idDeletes a schedule with the given id

API details

Base URL
http://meshery.local
Authentication
An API key in the token cookie
Operations
75 operations on 51 pathsGET 43POST 20DELETE 12
Main resources
SystemAPI 12UserAPI 9GrafanaAPI 8PatternsAPI 8PrometheusAPI 8PerformanceAPI 7ApplicationsAPI 6FiltersAPI 5ProvidersAPI 5SchedulesAPI 4
Description format
OpenAPI 3.0.0, API version 0.4.27
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Meshery API. in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Meshery API. collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the token cookie. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Handle GET request for Application Files” (GET /api/application/), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Meshery 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… It is listed under Developer tools and has 75 endpoints.

Who publishes the Meshery API.?

It is listed from Meshery's public API description (an OpenAPI document), not published by Meshery on Swastik Codes. Anyone who controls meshery.io can claim the profile by adding a DNS TXT record.

What is the base URL of the Meshery API.?

Requests go to http://meshery.local. Endpoint paths are added to this base URL.

How do I authenticate with the Meshery API.?

With an API key in the token cookie.

How many endpoints does the Meshery API. have?

75 operations on 51 paths (43 GET, 20 POST, 12 DELETE). The largest groups are SystemAPI, UserAPI, GrafanaAPI, PatternsAPI.

Is forking the Meshery API. free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.