docs/static/v0.9/reference/rest-apis/index.html
Each of Meshery’s APIs are subject to the following authentication and authorization system. Meshery requires a valid token in order to allow clients to invoke its APIs.
#Authentication Requests to any of the API endpoints must be authenticated and include a valid JWT access token in the HTTP headers. The type of authentication is determined by the selected Providers. Use of the Local Provider, "None", puts Meshery into single-user mode and uses minimal, intentionally insecure authentication.
What are authentication tokens?
Meshery authentication tokens allow users or systems to authenticate with Meshery Server via either its two clients, Meshery CLI and Meshery UI, or its two APIs: REST or GraphQL.
Meshery’s authentication token system provides secure access to Meshery’s management features.
There are two ways to get your authentication token:
#Meshery UI
Using Meshery UI, you can get a copy of your authentication token by following these steps:
Log into Meshery by selecting your identity provider of choice (typically found at http:\{meshery-server}:9081/provider)
Navigate to your user’s avatar in the upper righthand corner and select “Get Token” from the dropdown of profile section:
#Meshery CLI
Using Meshery CLI, you can get a copy of your authentication token by executing the following command:
mesheryctl system login
In order to use this command, you must have a web browser available on your system (this command cannot be executed on a headless system).
#Example using curl
Using curl, you can access Meshery's REST API by executing this command:
curl --location 'localhost:9081/api/\<endpoint\>' \ --header 'meshery-token: \<yourToken\>\ --header 'Cookie: meshery-provider=Layer5; cloud.layer5.io\_ref=/;token=\<yourToken\>
This section contains self-generated documentation derived from Meshery’s OpenAPI specification for its REST APIs.
An alternative overview
See the Meshery API Endpoints spreadsheet for an alternative overview of these endpoints.
Fetches the list of all applications saved by the current user ?updated_after=\<timestamp\> timestamp should be of the format "YYYY-MM-DD HH:MM:SS" ?order={field} orders on the passed field ?search=\<application name\> A string matching is done on the specified application name ?page={page-number} Default page number is 0 ?pagesize={pagesize} Default pagesize is 10
200-
Delete a deployed application file with the request
200
Deploy an attached application file with the request
| Name | Located in | Description | Type |
|---|---|---|---|
| Upload Yaml/Yml File | formData | File |
200-
Get the application source-content
| Name | Located in | Description | Type |
|---|---|---|---|
| Upload Yaml/Yml File | formData | File |
Get application file types
200-
Deletes a meshery application file with ID: id
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | id for a specific | String |
200-
Updates the design for the provided application
200-
Used to share designs with others
200
403
500
Used to share filters with others
200
403
500
?order={field} orders on the passed field ?page={page-number} Default page number is 0 ?pagesize={pagesize} Default pagesize is 20 ?search={environments_name} If search is non empty then a greedy search is performed ?orgID={orgid} orgID is used to retrieve environments belonging to a particular org *required* ?filter={condition}200-
Creates a new environment
201-
?order={field} orders on the passed field ?page={page-number} Default page number is 0 ?pagesize={pagesize} Default pagesize is 20 ?search={environments_name} If search is non empty then a greedy search is performed ?filter={{"assigned": true/false, "deleted_at": true/false}} defaults to assigned: false, deleted_at: false Returns all connections of environment
200-
Removes connection from environment
201-
Returns Environment connection mapping info
200-
Handle DELETE for Environment based on ID
201-
?orgID={orgid} orgID is used to retrieve environments belonging to a particular org Returns Environment info
200-
Updates a environment
200-
Listens for events across all of Meshery's components like adapters and server, streaming them to the UI via Server Side Events This API call never terminates and establishes a persistent keep-alive connection over which EventsResponses are pushed.
200
200
Bulk delete events associated with the ids.
200
Bulk update status for the events associated with the ids.
200-
Updates event status for the event associated with the id.
200-
200
Deletes event associated with the id.
200
?order={field} orders on the passed field ?search=\<filter name\> A string matching is done on the specified filter name ?page={page-number} Default page number is 0 ?pagesize={pagesize} Default pagesize is 10 ?visibility={[visibility]} Default visibility is public + private; Mulitple visibility filters can be passed as an array Eg: ?visibility=["public", "published"] will return public and published filters200-
Used to save/update a Meshery Filter
200-
?order={field} orders on the passed field ?page={page-number} Default page number is 0 ?pagesize={pagesize} Default pagesize is 10. ?search={filtername} If search is non empty then a greedy search is performed200-
Publishes filter to Meshery Catalog by setting visibility to published and setting catalog data
202-
Unpublishes filter from Meshery Catalog by setting visibility to private and removing catalog data from website
200-
Creates a local copy of a published filter with id: id
200-
Delete a deployed filter file with the request
200
Deploy an attached filter file with the request
200-
Returns the Meshery Filter file saved by the current user with the given id
200-
Deletes a meshery filter with ID: id
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | id for a specific | String |
200-
Fetches the Meshery Filter with the given id
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | id for a specific | String |
200-
?order={field} orders on the passed field ?page={page-number} Default page number is 0 ?pagesize={pagesize} Default pagesize is 20 ?search={environments_name} If search is non empty then a greedy search is performed ?filter={condition}
200-
?order={field} orders on the passed field ?page={page-number} Default page number is 0 ?pagesize={pagesize} Default pagesize is 20 ?search={username|email|first_name|last_name} If search is non empty then a greedy search is performed ?filter={condition}| Name | Located in | Description | Type |
|---|---|---|---|
| page | query | Integer | |
| pageSize | query | Integer | |
| search | query | String | |
| order | query | in: order | String |
| filter | query | in: filter | String |
200-
?order={field} orders on the passed field ?search={} If search is non empty then a greedy search is performed ?page={page-number} Default page number is 0 ?pagesize={pagesize} Default pagesize is 10 ?filter={filter} Filter connections with type or sub_type, eg /api/integrations/connections?filter=type%20platform or /api/integrations/connections?filter=sub_type%20management ?status={status} Status takes array as param to filter connections based on status, eg /api/integrations/connections?status=["connected", "deleted"] ?kind={kind} Kind takes array as param to filter connections based on kind, eg /api/integrations/connections?kind=["meshery", "kubernetes"]
200-
Creates a new connection
201-
Get all connections status
200-
Deletes existing connection
200-
Updates existing connection using ID
200-
?order={field} orders on the passed field ?search={} If search is non empty then a greedy search is performed ?page={page-number} Default page number is 0 ?pagesize={pagesize} Default pagesize is 10
200-
Updates existing connection
200-
Validate the given value with the given schema
200
Generates Meshery Components for the given payload
200
Update the ignore status of a model based on the provided parameters.
200-
Validate the given value with the given schema
200
?order={field} orders on the passed field ?sort={[asc/desc]} Default behavior is asc ?search={categoryName} If search is non empty then a greedy search is performed ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all
200-
?order={field} orders on the passed field ?sort={[asc/desc]} Default behavior is asc ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all ?search={[true/false]} If search is true then a greedy search is performed
200-
?version={version} ?trim={[true]} When trim is set to true, the underlying schemas are not returned for entities ?apiVersion={apiVersion} If apiVersion is unspecified then all models are returned ?order={field} orders on the passed field ?search={componentname} If search is non empty then a greedy search is performed ?sort={[asc/desc]} Default behavior is asc ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all ?annotations={["true"/"false"/]} If "true" components having "isAnnotation" property as true are "only" returned, If false all components except "annotations" are returned. Any other value of the query parameter results in both annoations as well as non-annotation components being returned.200-
Example: /api/meshmodels/categories/Orchestration and Management/components/Namespace Components can be further filtered through query parameter ?model={model} If model is unspecified then all models are returned ?version={version} If version is unspecified then all model versions are returned ?apiVersion={apiVersion} If apiVersion is unspecified then all components are returned ?order={field} orders on the passed field ?search={[true/false]} If search is true then a greedy search is performed ?sort={[asc/desc]} Default behavior is asc ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all ?annotations={["true"/"false"/]} If "true" components having "isAnnotation" property as true are "only" returned, If false all components except "annotations" are returned. Any other value of the query parameter results in both annoations as well as non-annotation components being returned.
200-
?version={version} If version is unspecified then all models are returned ?order={field} orders on the passed field ?search={modelname} If search is non empty then a greedy search is performed ?sort={[asc/desc]} Default behavior is asc ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all ?annotations={["true"/"false"/]} When this query parameter is "true", only models with the "isAnnotation" property set to true are returned. When this query parameter is "false", all models except those considered to be annotation models are returned. Any other value of the query parameter results in both annoations as well as non-annotation models being returned.
200-
?version={version} If version is unspecified then all models are returned ?order={field} orders on the passed field ?search={[true/false]} If search is true then a greedy search is performed ?sort={[asc/desc]} Default behavior is asc ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all
200-
Example: /api/meshmodels/categories/Orchestration and Management/models/kubernetes/components Components can be further filtered through query parameter ?version={version} ?trim={[true]} When trim is set to true, the underlying schemas are not returned for entities ?apiVersion={apiVersion} If apiVersion is unspecified then all models are returned ?order={field} orders on the passed field ?search={componentname} If search is non empty then a greedy search is performed ?sort={[asc/desc]} Default behavior is asc ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all ?annotations={["true"/"false"/]} If "true" components having "isAnnotation" property as true are "only" returned, If false all components except "annotations" are returned. Any other value of the query parameter results in both annoations as well as non-annotation components being returned.
200-
Example: /api/meshmodels/categories/Orchestration and Management/models/kubernetes/components/Namespace Components can be further filtered through query parameter ?version={version} If version is unspecified then all model versions are returned ?apiVersion={apiVersion} If apiVersion is unspecified then all components are returned ?order={field} orders on the passed field ?search={[true/false]} If search is true then a greedy search is performed ?sort={[asc/desc]} Default behavior is asc ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all ?annotations={["true"/"false"/]} If "true" components having "isAnnotation" property as true are "only" returned, If false all components except "annotations" are returned. Any other value of the query parameter results in both annoations as well as non-annotation components being returned.
200-
?version={version} ?apiVersion={apiVersion} If apiVersion is unspecified then all models are returned ?order={field} orders on the passed field ?search={componentname} If search is non empty then a greedy search is performed ?trim={[true]} When trim is set to true, the underlying schemas are not returned for entities ?sort={[asc/desc]} Default behavior is asc ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all ?annotations={["true"/"false"/]} If "true" components having "isAnnotation" property as true are "only" returned, If false all components except "annotations" are returned. Any other value of the query parameter results in both annoations as well as non-annotation components being returned.200-
Example: /api/meshmodels/components/Namespace Components can be further filtered through query parameter ?model={model} If model is unspecified then all models are returned ?version={version} If version is unspecified then all model versions are returned ?apiVersion={apiVersion} If apiVersion is unspecified then all components are returned ?order={field} orders on the passed field ?sort={[asc/desc]} Default behavior is asc ?trim={[true]} When trim is set to true, the underlying schemas are not returned for entities ?search={[true/false]} If search is true then a greedy search is performed ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all ?annotations={["true"/"false"/]} If "true" components having "isAnnotation" property as true are "only" returned, If false all components except "annotations" are returned. Any other value of the query parameter results in both annoations as well as non-annotation components being returned.
200-
?id={id} ?output_format={output_format} Can be json, yaml, or oci. Default is oci200-
?version={version} If version is unspecified then all models are returned ?order={field} orders on the passed field ?search={modelname} If search is non empty then a greedy search is performed ?sort={[asc/desc]} Default behavior is asc ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all200-
?version={version} If version is unspecified then all models are returned ?order={field} orders on the passed field ?search={[true/false]} If search is true then a greedy search is performed ?sort={[asc/desc]} Default behavior is asc ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all200-
Example: /api/meshmodels/models/kubernetes/components Components can be further filtered through query parameter ?version={version} ?trim={[true]} When trim is set to true, the underlying schemas are not returned for entities ?apiVersion={apiVersion} If apiVersion is unspecified then all models are returned ?search={componentname} If search is non empty then a greedy search is performed ?order={field} orders on the passed field ?sort={[asc/desc]} Default behavior is asc ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all ?annotations={["true"/"false"/]} If "true" components having "isAnnotation" property as true are "only" returned, If false all components except "annotations" are returned. Any other value of the query parameter results in both annoations as well as non-annotation components being returned.
200-
Example: /api/meshmodels/models/kubernetes/components/Namespace Components can be further filtered through query parameter ?version={version} If version is unspecified then all model versions are returned ?apiVersion={apiVersion} If apiVersion is unspecified then all components are returned ?order={field} orders on the passed field ?sort={[asc/desc]} Default behavior is asc ?search={[true/false]} If search is true then a greedy search is performed ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all ?annotations={["true"/"false"/]} If "true" components having "isAnnotation" property as true are "only" returned, If false all components except "annotations" are returned. Any other value of the query parameter results in both annoations as well as non-annotation components being returned. returned.
200-
Example: /api/meshmodels/models/kubernetes/policies ?order={field} orders on the passed field ?sort={[asc/desc]} Default behavior is asc ?search={[true/false]} If search is true then a greedy search is performed ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all
200-
Example: /api/meshmodels/models/kubernetes/policies/{name} ?order={field} orders on the passed field ?sort={[asc/desc]} Default behavior is asc ?search={[true/false]} If search is true then a greedy search is performed ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all
200-
Example: /api/meshmodel/model/kubernetes/relationship # Relationships can be further filtered through query parameter ?version={version} ?order={field} orders on the passed field ?sort={[asc/desc]} Default behavior is asc ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all
200-
Example: /api/meshmodels/models/kubernetes/relationships/Edge # Relationships can be further filtered through query parameter ?version={version} ?order={field} orders on the passed field ?sort={[asc/desc]} Default behavior is asc ?search={[true/false]} If search is true then a greedy search is performed ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all
200-
Register model based on their Schema Version.
200-
?page={pagenumber} Default page number is 1 ?order={field} orders on the passed field ?search={Hostname} Gets host by the name ?sort={[asc/desc]} Default behavior is asc ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all200-
?version={version} ?order={field} orders on the passed field ?sort={[asc/desc]} Default behavior is asc ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all200-
Handle POST request for evaluating relationships in the provided design file by running a set of provided evaluation queries on the design file
Returns the list of all the patterns saved by the current user This will return all the patterns with their details ?order={field} orders on the passed field ?search=\<design name\> A string matching is done on the specified design name ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 10 ?visibility={[visibility]} Default visibility is public + private; Mulitple visibility filters can be passed as an array Eg: ?visibility=["public", "published"] will return public and published designs ?metrics Returns metrics like deployment/share/clone/view/download count for desings, default is false, ?populate Add the design content to the response like pattern_file return design file content 200: mesheryPatternsResponseWrapper
Edit/update a meshery pattern
200-
?order={field} orders on the passed field ?page={page-number} Default page number is 0 ?pagesize={pagesize} Default pagesize is 10. ?search={patternname} If search is non empty then a greedy search is performed ?metrics Returns metrics like deployment/share/clone/view/download count for designs, default false, ?class={class} Filters patterns based on class ?technology={technology} Filters patterns based on technology ?type={type} Filters patterns based on type ?orgID={orgID} Filters patterns based on organization ID ?workspaceID={workspaceID} Filter patterns based on workspace ID ?userid={userid} Filters patterns based on user ID200-
Publishes pattern to Meshery Catalog by setting visibility to published and setting catalog data
202-
Unpublishes pattern from Meshery Catalog by setting visibility to private and removing catalog data from website
200-
Creates a local copy of a published pattern with id: id
200-
Delete a deployed pattern with the request
200
Deploy an attached pattern with the request
| Name | Located in | Description | Type |
|---|---|---|---|
| Upload Yaml/Yml File | formData | File |
200
?metrics Returns metrics like deployment/share/clone/view/download count for desings, default false, Fetches the pattern with the given id
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | id for a specific | String |
200-
Get the pattern source-content
200-
Handle design import
200-
Get pattern file types
200-
DeleteMultiMesheryPatternsHandler deletes patterns with the given ids
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | id for a specific | String |
200-
?metrics Returns metrics like deployment/share/clone/view/download count for desings, default false, Fetches the pattern with the given id
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | id for a specific | String |
200-
Creates a new Pattern with source-content
200-
Updates the pattern with the given payload
200-
DeleteMultiMesheryPatternsHandler deletes patterns with the given ids
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | id for a specific | String |
200-
Runs the load test with the given parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| Query | query | Unknown | |
| Body | body | Unknown |
200
?order={field} orders on the passed field ?page={page-number} Default page number is 0 ?pagesize={pagesize} Default pagesize is 10 ?search={} If search is non empty then a greedy search is performed ?from={date} Date must be in yyyy-mm-dd format ?to={date} Date must be in yyyy-mm-dd format200-
Returns an individual result from provider
200-
Update the choice of provider in system
| Name | Located in | Description | Type |
|---|---|---|---|
| provider | query | String |
200
Returns the capabilities.json for the provider
200
handles the requests to serve react components from the provider package
200
Returns the available list of providers
200-
?order={field} orders on the passed field ?page={page-number} Default page number is 0 ?pagesize={pagesize} Default pagesize is 10 ?search={status|mesh_version|mesh_name|date|id} If search is non empty then a greedy search is performed200-
Used to delete adapter configuration
| Name | Located in | Description | Type |
|---|---|---|---|
| adapter | query | String |
200
Used to persist adapter config
| Name | Located in | Description | Type |
|---|---|---|---|
| meshLocationURL | body | Unknown |
200-
Used to send operations to the adapters
| Name | Located in | Description | Type |
|---|---|---|---|
| adapter | query | String | |
| query | query | String | |
| customBody | query | String | |
| namespace | query | String | |
| deleteOp | query | String |
200
Fetches and returns all the adapters and ping adapters
| Name | Located in | Description | Type |
|---|---|---|---|
| adapter | query | String |
200-
Fetches and returns all the adapters available for deployment
200-
?order={field} orders on the passed field ?sort={[asc/desc]} Default behavior is asc ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 10. To return all results: pagesize=all ?search={tablename} If search is non empty then a greedy search is performed200-
This endpoint resets the system database to its initial state by performing the following steps: Creates an archive of the current database contents. Drops all existing tables in the database. Applies auto migration to recreate the necessary tables.
200
500
Retrieves and initiates a download for the specified file.
200
500
Retrieves the current server log level and lists all available log levels.
200- Successfully retrieved log level
Updates the server's logging level. The new level must be one of the available logging levels. Invalid log levels will result in a 400 Bad Request response.
200- Successfully updated log level
400- Invalid log level provided
Used to delete kubernetes config to System
200
Used to add kubernetes config to System
200-
?order={field} orders on the passed field ?page={page-number} Default page number is 0 ?pagesize={pagesize} Default pagesize is 10 ?search={contextname} If search is non empty then a greedy search is performed200-
Returns the context list for a given k8s config
200-
Fetches server version to simulate ping
200
Used to register Kubernetes components to Meshery from a kubeconfig file
202
400
500
Fetches Prometheus and Grafana
200-
Fetches Prometheus
200-
?apiVersion={apiVersion} If apiVersion is unspecified then all models are returned ?search={componentname} If search is non empty then a greedy search is performed ?order={field} orders on the passed field ?sort={[asc/desc]} Default behavior is asc ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all ?annotation={annotaion} annotation is a boolean value. If true then annotations are returned ?labels={labels} labels is a boolean value. If true then labels are returned ?spec={spec} spec is a boolean value. If true then spec is returned ?status={status} status is a boolean value. If true then status is returned ?clusterId={[clusterId]} clusterId is array of string values. Required. ?asDesign={bool} asDesign is a boolean value. If true then the response is returned as a design and resources are omitted
200-
?clusterId={clusterId} clusterId is id of the cluster to get resources for ( multiple supported)
200-
Used to send session data to the UI for initial sync
200-
Returns the running Meshery version
200-
Retrieves and displays the content of the specified file as plain text.
200
500
Used for importing Grafana board for Prometheus
200-
Used to persist selected board and panels
| Name | Located in | Description | Type |
|---|---|---|---|
| Body | body | Unknown |
200
Used for deleting Prometheus configuration
200
Used for fetching Prometheus configuration
200-
Used for persisting Prometheus configuration
| Name | Located in | Description | Type |
|---|---|---|---|
| prometheusURL | body | Unknown |
200
Used for fetching Grafana boards and panels
| Name | Located in | Description | Type |
|---|---|---|---|
| dashboardSearch | query | String |
200-
Used for persist Grafana boards and panel selections
200
Used for Delete Grafana configuration
200
Used for fetching Grafana configuration
200-
Used for persisting Grafana configuration
| Name | Located in | Description | Type |
|---|---|---|---|
| Body | body | Unknown |
200
Used to initiate a Grafana ping
200
Used for handling Grafana queries
200
Fetches and returns Grafana
200-
Used to ping prometheus
200
Used to prometheus queries
200
Used to fetch the static board
200-
Redirects user for auth or issues session
200
Redirects user for auth or issues session
200
Returns the list of all the performance profiles saved by the current user ?order={field} orders on the passed field ?page={page-number} Default page number is 0 ?pagesize={pagesize} Default pagesize is 10 ?search={profilename} If search is non empty then a greedy search is performed
200-
Save performance profile using the current provider's persistence mechanism
| Name | Located in | Description | Type |
|---|---|---|---|
| Body | body | Unknown |
200-
?order={field} orders on the passed field ?page={page-number} Default page number is 0 ?pagesize={pagesize} Default pagesize is 10 ?search={} If search is non empty then a greedy search is performed ?from={date} Date must be in yyyy-mm-dd format ?to={date} Date must be in yyyy-mm-dd format200-
Deletes a performance profile with the given id
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | id for a specific | String |
200-
Returns single performance profile with the given id
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | id for a specific | String |
200-
Fetches pages of results from provider for the given id ?order={field} orders on the passed field ?page={page-number} Default page number is 0 ?pagesize={pagesize} Default pagesize is 10 ?search={result_name|mesh|url} If search is non empty then a greedy search is performed
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | id for a specific | String |
200-
Runs the load test with the given parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| Body | query | Unknown |
200
Returns User Load Test Preferences
200-
Updates User Load Test Preferences
200-
Used for deleting load test preferences
| Name | Located in | Description | Type |
|---|---|---|---|
| uuid | query | String |
200
Used for fetching load test preferences
| Name | Located in | Description | Type |
|---|---|---|---|
| uuid | query | String |
200-
Used for persisting load test preferences
| Name | Located in | Description | Type |
|---|---|---|---|
| Body | body | Unknown |
200
Returns User info
200-
?order={field} orders on the passed field ?page={page-number} Default page number is 0 ?pagesize={pagesize} Default pagesize is 10200-
Save schedule using the current provider's persistence mechanism
200-
Deletes a schedule with the given id
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | id for a specific | String |
200-
Fetches and returns the schedule with the given id
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | id for a specific | String |
200-
Returns token from the actual provider in a file response: 200:
Receives token from the actual provider response: 200:
search={description} If search is non empty then a search is performed on event description ?category=[eventcategory] Returns event belonging to provided categories ?action=[eventaction] Returns events belonging to provided actions ?status={[read/unread]} Return events filtered on event status Default is unread```` ?severity=[eventseverity] Returns events belonging to provided severities ?sort={field} order the records based on passed field, defaults to updated_at ?order={[asc/desc]} Default behavior is desc ?page={page-number} Default page number is 0 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all
200-
?order={field} orders on the passed field ?page={page-number} Default page number is 0 ?pagesize={pagesize} Default pagesize is 20 ?search={name} If search is non empty then a greedy search is performed ?orgID={orgid} orgID is used to retrieve workspaces belonging to a particular org *required* ?filter={condition}
200-
Creates a new workspace
201-
Deletes a workspace
201-
?orgID={orgid} orgID is used to retrieve workspaces belonging to a particular org Returns Workspace info
200-
Updates a workspace
200-
?order={field} orders on the passed field ?page={page-number} Default page number is 0 ?pagesize={pagesize} Default pagesize is 20 ?search={name} If search is non empty then a greedy search is performed ?filter={{"assigned": true/false, "deleted_at": true/false}} defaults to assigned: false, deleted_at: false
200-
Removes a meshery design from a workspace
201-
Adds a meshery design to a workspace
201-
?order={field} orders on the passed field ?page={page-number} Default page number is 0 ?pagesize={pagesize} Default pagesize is 20 ?search={name} If search is non empty then a greedy search is performed ?orgID={orgid} orgID is used to retrieve workspaces belonging to a particular org *required* ?filter={{"assigned": true/false, "deleted_at": true/false}} defaults to assigned: false, deleted_at: false
200-
Removes an environment from a workspace
201-
Adds an environment to a workspace
201-
Servers providers UI
200
[ Previous
GraphQL API ](/v0.9/reference/graphql-apis)[ Next
Security Vulnerabilities ](/v0.9/project/security-vulnerabilities)