# GraphQL API Reference

> Meshery GraphQL API Documentation and Reference

---

LLMS index: [llms.txt](/llms.txt)

---

<!---
  This page is a static snapshot of the GraphQL schema reference. The previous
  Jekyll-era Rakefile that auto-generated it (docs/Rakefile, docs/Gemfile) was
  removed when the docs migrated from Jekyll to Hugo. For the most current API
  surface, use the GraphQL introspection endpoint and the Playground linked
  below; this page may be regenerated by a future Hugo-native pipeline. The
  authoritative source schema definitions live in
  https://github.com/meshery/schemas.
--->

Reference documentation for Meshery's GraphQL API. The API can be explored interactively using the GraphQL Playground at `http://localhost:9081/api/system/graphql/playground`, if you have built and are running Meshery Server from source. The authoritative source is the GraphQL schema at `server/internal/graphql/schema/schema.graphql`; this page is a static snapshot. Each table below documents a GraphQL type.

WARNING:
Fields that are deprecated are marked with **{warning-solid}**.

<!-- vale off -->

## `Query` type

The `Query` type contains the API's top-level entry points for all executable queries.

### `Query.connectToNats`

Check is Meshey Server is connected to NATS, if not connect to the NATS Server.

###### **Returns** [`Status!`](#status).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="queryconnecttonatsk8scontextid"></a>`k8scontextID` | [`String!`](#string) |  |

### `Query.deployMeshsync`

Check the Meshsync Status and deploy if not enabled.

###### **Returns** [`Status!`](#status).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="querydeploymeshsynck8scontextid"></a>`k8scontextID` | [`String!`](#string) | what to do in-order to deploy meshsync on multiple clusters/contexts. |

### `Query.fetchAllResults`

Query for fetching all results for profile ID.

###### **Returns** [`PerfPageResult!`](#perfpageresult).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="queryfetchallresultsselector"></a>`selector` | [`PageFilter!`](#pagefilter) |  |

### `Query.fetchFilterCatalogContent`

Query for getting Filter Catalog from remote provider.

###### **Returns** [`[CatalogFilter!]!`](#catalogfilter).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="queryfetchfiltercatalogcontentselector"></a>`selector` | [`CatalogSelector`](#catalogselector) |  |

### `Query.fetchPatternCatalogContent`

Query for getting Pattern Catalog from remote provider.

###### **Returns** [`[CatalogPattern!]!`](#catalogpattern).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="queryfetchpatterncatalogcontentselector"></a>`selector` | [`CatalogSelector`](#catalogselector) |  |

### `Query.fetchPatterns`

Query for fetching all patterns with selector.

###### **Returns** [`PatternPageResult!`](#patternpageresult).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="queryfetchpatternsselector"></a>`selector` | [`PageFilter!`](#pagefilter) |  |

### `Query.fetchResults`

Query for fetching all results for profile ID.

###### **Returns** [`PerfPageResult!`](#perfpageresult).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="queryfetchresultsprofileid"></a>`profileID` | [`String!`](#string) |  |
| <a id="queryfetchresultsselector"></a>`selector` | [`PageFilter!`](#pagefilter) |  |

### `Query.fetchTelemetryComponents`

Query for telemetry components.

###### **Returns** [`[TelemetryComp]!`](#telemetrycomp).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="queryfetchtelemetrycomponentscontexts"></a>`contexts` | [`[String!]`](#string) |  |

### `Query.getAvailableAddons`

Query details about Addons available (Eg. Prometheus and Grafana).

###### **Returns** [`[AddonList!]!`](#addonlist).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="querygetavailableaddonsfilter"></a>`filter` | [`ServiceMeshFilter`](#servicemeshfilter) | Select Mesh Type. |

### `Query.getAvailableNamespaces`

Query available Namesapces in your cluster.

###### **Returns** [`[NameSpace!]!`](#namespace).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="querygetavailablenamespacesk8sclusterids"></a>`k8sClusterIDs` | [`[String!]`](#string) |  |

### `Query.getClusterResources`

Query for getting cluster info.

###### **Returns** [`ClusterResources!`](#clusterresources).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="querygetclusterresourcesk8scontextids"></a>`k8scontextIDs` | [`[String!]`](#string) |  |
| <a id="querygetclusterresourcesnamespace"></a>`namespace` | [`String!`](#string) |  |

### `Query.getControlPlanes`

Query Control Plane data for a Service Mesh (or all) in your cluster.

###### **Returns** [`[ControlPlane!]!`](#controlplane).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="querygetcontrolplanesfilter"></a>`filter` | [`ServiceMeshFilter`](#servicemeshfilter) | Filter Control Plane Query. |

### `Query.getDataPlanes`

Query Data Plane information for a Service Mesh (or all) in your cluster.

###### **Returns** [`[DataPlane!]!`](#dataplane).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="querygetdataplanesfilter"></a>`filter` | [`ServiceMeshFilter`](#servicemeshfilter) | Filter Control Plane Query. |

### `Query.getKubectlDescribe`

Query for getting kubectl describe details with meshkit.

###### **Returns** [`KctlDescribeDetails!`](#kctldescribedetails).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="querygetkubectldescribekind"></a>`kind` | [`String!`](#string) |  |
| <a id="querygetkubectldescribename"></a>`name` | [`String!`](#string) |  |
| <a id="querygetkubectldescribenamespace"></a>`namespace` | [`String!`](#string) |  |

### `Query.getMeshModelSummary`

Query for meshmodel summary.

###### **Returns** [`MeshModelSummary!`](#meshmodelsummary).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="querygetmeshmodelsummaryselector"></a>`selector` | [`MeshModelSummarySelector!`](#meshmodelsummaryselector) |  |

### `Query.getMeshsyncStatus`

Check the Meshsync Status.

###### **Returns** [`OperatorControllerStatus!`](#operatorcontrollerstatus).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="querygetmeshsyncstatusk8scontextid"></a>`k8scontextID` | [`String!`](#string) |  |

### `Query.getNatsStatus`

Check is Meshey Server is connected to NATS.

###### **Returns** [`OperatorControllerStatus!`](#operatorcontrollerstatus).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="querygetnatsstatusk8scontextid"></a>`k8scontextID` | [`String!`](#string) |  |

### `Query.getOperatorStatus`

Query status of Meshery Operator in your cluster.

###### **Returns** [`OperatorStatus`](#operatorstatus).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="querygetoperatorstatusk8scontextid"></a>`k8scontextID` | [`String!`](#string) |  |

### `Query.getPerfResult`

Query for performance result.

###### **Returns** [`MesheryResult`](#mesheryresult).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="querygetperfresultid"></a>`id` | [`ID!`](#id) |  |

### `Query.getPerformanceProfiles`

Query for fetching all results for profile ID.

###### **Returns** [`PerfPageProfiles!`](#perfpageprofiles).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="querygetperformanceprofilesselector"></a>`selector` | [`PageFilter!`](#pagefilter) |  |

### `Query.resyncCluster`

Query to resync the cluster discovery.

###### **Returns** [`Status!`](#status).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="queryresyncclusterk8scontextid"></a>`k8scontextID` | [`String!`](#string) |  |
| <a id="queryresyncclusterselector"></a>`selector` | [`ReSyncActions`](#resyncactions) | Selector to control several resync actions. |

## `Mutation` type

The `Mutation` type contains all the mutations you can execute.

All mutations receive their arguments in a single input object named `input`.

### `Mutation.changeAdapterStatus`

Change the Adapter Status.

###### **Input type:** `AdapterStatusInput`

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="mutationchangeadapterstatusadapter"></a>`adapter` | [`String!`](#string) | Name of the adapter to be deployed. |
| <a id="mutationchangeadapterstatustargetport"></a>`targetPort` | [`String!`](#string) | The port on which adapter will be deployed. |
| <a id="mutationchangeadapterstatustargetstatus"></a>`targetStatus` | [`Status!`](#status) | Desired status for Meshery Operator. |

###### **Returns** [`Status!`](#status).

### `Mutation.changeOperatorStatus`

Change the Operator Status.

###### **Input type:** `OperatorStatusInput`

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="mutationchangeoperatorstatuscontextid"></a>`contextID` | [`String!`](#string) |  |
| <a id="mutationchangeoperatorstatustargetstatus"></a>`targetStatus` | [`Status!`](#status) | Desired status for Meshery Operator. |

###### **Returns** [`Status!`](#status).

## `Subscription` type

The `Subscription` type contains all the Subscriptions you can listen to.

### `Subscription.listenToAddonState`

Listen to changes in status of Addons available (Eg. Prometheus and Grafana).

###### **Returns** [`[AddonList!]!`](#addonlist).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="subscriptionlistentoaddonstatefilter"></a>`filter` | [`ServiceMeshFilter`](#servicemeshfilter) | Select Mesh Type. |

### `Subscription.listenToControlPlaneState`

Listen to changes in Control Plane data for a Service Mesh (or all) in your cluster.

###### **Returns** [`[ControlPlane!]!`](#controlplane).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="subscriptionlistentocontrolplanestatefilter"></a>`filter` | [`ServiceMeshFilter`](#servicemeshfilter) | Filter Control Plane Query. |

### `Subscription.listenToDataPlaneState`

Listen to changes in Data Plane data for a Service Mesh (or all) in your cluster.

###### **Returns** [`[DataPlane!]!`](#dataplane).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="subscriptionlistentodataplanestatefilter"></a>`filter` | [`ServiceMeshFilter`](#servicemeshfilter) | Filter Control Plane Query. |

### `Subscription.listenToMeshSyncEvents`

Listen to changes in the list of available Namesapces in your cluster.

###### **Returns** [`OperatorControllerStatusPerK8sContext`](#operatorcontrollerstatusperk8scontext).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="subscriptionlistentomeshsynceventsk8scontextids"></a>`k8scontextIDs` | [`[String!]`](#string) |  |

### `Subscription.listenToOperatorState`

Listen to changes in status of Meshery Operator in your cluster.

###### **Returns** [`OperatorStatusPerK8sContext`](#operatorstatusperk8scontext).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="subscriptionlistentooperatorstatek8scontextids"></a>`k8scontextIDs` | [`[String!]`](#string) |  |

### `Subscription.subscribeBrokerConnection`

Listen to changes in Broker (NATS) Connection.

###### **Returns** [`Boolean!`](#boolean).

### `Subscription.subscribeClusterResources`

###### **Returns** [`ClusterResources!`](#clusterresources).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="subscriptionsubscribeclusterresourcesk8scontextids"></a>`k8scontextIDs` | [`[String!]`](#string) |  |
| <a id="subscriptionsubscribeclusterresourcesnamespace"></a>`namespace` | [`String!`](#string) |  |

### `Subscription.subscribeConfiguration`

###### **Returns** [`ConfigurationPage!`](#configurationpage).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="subscriptionsubscribeconfigurationapplicationselector"></a>`applicationSelector` | [`PageFilter!`](#pagefilter) |  |
| <a id="subscriptionsubscribeconfigurationfilterselector"></a>`filterSelector` | [`PageFilter!`](#pagefilter) |  |
| <a id="subscriptionsubscribeconfigurationpatternselector"></a>`patternSelector` | [`PageFilter!`](#pagefilter) |  |

### `Subscription.subscribeK8sContext`

###### **Returns** [`K8sContextsPage!`](#k8scontextspage).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="subscriptionsubscribek8scontextselector"></a>`selector` | [`PageFilter!`](#pagefilter) |  |

### `Subscription.subscribeMeshModelSummary`

###### **Returns** [`MeshModelSummary!`](#meshmodelsummary).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="subscriptionsubscribemeshmodelsummaryselector"></a>`selector` | [`MeshModelSummarySelector!`](#meshmodelsummaryselector) |  |

### `Subscription.subscribeMeshSyncEvents`

Listen to the events that MeshSync is sending through Meshery Broker.
Note: It does not listen to the changes in meshery database, but to meshsync events.

###### **Returns** [`MeshSyncEvent!`](#meshsyncevent).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="subscriptionsubscribemeshsynceventsk8scontextids"></a>`k8scontextIDs` | [`[String!]`](#string) |  |

### `Subscription.subscribeMesheryControllersStatus`

Listen to changes in the status of meshery controllers.

###### **Returns** [`[MesheryControllersStatusListItem!]!`](#mesherycontrollersstatuslistitem).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="subscriptionsubscribemesherycontrollersstatusk8scontextids"></a>`k8scontextIDs` | [`[String!]`](#string) |  |

### `Subscription.subscribePerfProfiles`

Listen to changes in Performance Profiles.

###### **Returns** [`PerfPageProfiles!`](#perfpageprofiles).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="subscriptionsubscribeperfprofilesselector"></a>`selector` | [`PageFilter!`](#pagefilter) |  |

### `Subscription.subscribePerfResults`

Listen to all results for profile ID.

###### **Returns** [`PerfPageResult!`](#perfpageresult).

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="subscriptionsubscribeperfresultsprofileid"></a>`profileID` | [`String!`](#string) |  |
| <a id="subscriptionsubscribeperfresultsselector"></a>`selector` | [`PageFilter!`](#pagefilter) |  |

## Object types

Object types represent the resources that the Meshery GraphQL API can return.
They contain _fields_. Each field has its own type, which will either be one of the
basic GraphQL [scalar types](https://graphql.org/learn/schema/#scalar-types)
(e.g.: `String` or `Boolean`) or other object types. Fields may have arguments.
Fields with arguments are exactly like top-level queries, and are listed beneath
the table of fields for each object type.

For more information, see
[Object Types and Fields](https://graphql.org/learn/schema/#object-types-and-fields)
on `graphql.org`.

### `AddonList`

Details about the Addon Component.

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="addonlistname"></a>`name` | [`String!`](#string) | Name. |
| <a id="addonlistowner"></a>`owner` | [`String!`](#string) | Owner. |

### `ApplicationPage`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="applicationpageapplications"></a>`applications` | [`[ApplicationResult]`](#applicationresult) |  |
| <a id="applicationpagepage"></a>`page` | [`Int!`](#int) |  |
| <a id="applicationpagepage_size"></a>`page_size` | [`Int!`](#int) |  |
| <a id="applicationpagetotal_count"></a>`total_count` | [`Int!`](#int) |  |

### `ApplicationResult`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="applicationresultapplication_file"></a>`application_file` | [`String!`](#string) |  |
| <a id="applicationresultcreated_at"></a>`created_at` | [`String`](#string) |  |
| <a id="applicationresultid"></a>`id` | [`ID!`](#id) |  |
| <a id="applicationresultlocation"></a>`location` | [`Location!`](#location) |  |
| <a id="applicationresultname"></a>`name` | [`String!`](#string) |  |
| <a id="applicationresulttype"></a>`type` | [`NullString!`](#nullstring) |  |
| <a id="applicationresultupdated_at"></a>`updated_at` | [`String`](#string) |  |
| <a id="applicationresultuser_id"></a>`user_id` | [`String!`](#string) |  |
| <a id="applicationresultvisibility"></a>`visibility` | [`String!`](#string) |  |

### `CatalogFilter`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="catalogfiltercatalog_data"></a>`catalog_data` | [`Map`](#map) |  |
| <a id="catalogfiltercreated_at"></a>`created_at` | [`String`](#string) |  |
| <a id="catalogfilterfilter_file"></a>`filter_file` | [`String!`](#string) |  |
| <a id="catalogfilterid"></a>`id` | [`ID!`](#id) |  |
| <a id="catalogfilterlocation"></a>`location` | [`Location!`](#location) |  |
| <a id="catalogfiltername"></a>`name` | [`String!`](#string) |  |
| <a id="catalogfilterupdated_at"></a>`updated_at` | [`String`](#string) |  |
| <a id="catalogfilteruser_id"></a>`user_id` | [`String!`](#string) |  |
| <a id="catalogfiltervisibility"></a>`visibility` | [`String!`](#string) |  |

### `CatalogPattern`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="catalogpatterncatalog_data"></a>`catalog_data` | [`Map`](#map) |  |
| <a id="catalogpatterncreated_at"></a>`created_at` | [`String`](#string) |  |
| <a id="catalogpatternid"></a>`id` | [`ID!`](#id) |  |
| <a id="catalogpatternlocation"></a>`location` | [`Location!`](#location) |  |
| <a id="catalogpatternname"></a>`name` | [`String!`](#string) |  |
| <a id="catalogpatternpattern_file"></a>`pattern_file` | [`String!`](#string) |  |
| <a id="catalogpatternupdated_at"></a>`updated_at` | [`String`](#string) |  |
| <a id="catalogpatternuser_id"></a>`user_id` | [`String!`](#string) |  |
| <a id="catalogpatternvisibility"></a>`visibility` | [`String!`](#string) |  |

### `ClusterResources`

Details about discovered workloads.

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="clusterresourcesresources"></a>`resources` | [`[Resource!]!`](#resource) |  |

### `ConfigurationPage`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="configurationpageapplications"></a>`applications` | [`ApplicationPage`](#applicationpage) |  |
| <a id="configurationpagefilters"></a>`filters` | [`FilterPage`](#filterpage) |  |
| <a id="configurationpagepatterns"></a>`patterns` | [`PatternPageResult`](#patternpageresult) |  |

### `Container`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="containercontainername"></a>`containerName` | [`String!`](#string) |  |
| <a id="containercontrolplanemembername"></a>`controlPlaneMemberName` | [`String!`](#string) |  |
| <a id="containerimage"></a>`image` | [`String!`](#string) |  |
| <a id="containerports"></a>`ports` | [`[Container_Port]`](#container_port) | args: NOT IMPLEMENTED. |
| <a id="containerresources"></a>`resources` | [`Any`](#any) | env: NOT IMPLEMENTED,. |
| <a id="containerstatus"></a>`status` | [`Container_Status`](#container_status) |  |

### `Container_Port`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="container_portcontainerport"></a>`containerPort` | [`Int!`](#int) |  |
| <a id="container_portname"></a>`name` | [`String`](#string) |  |
| <a id="container_portprotocol"></a>`protocol` | [`String!`](#string) |  |

### `Container_Status`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="container_statuscontainerid"></a>`containerID` | [`Any`](#any) |  |
| <a id="container_statuscontainerstatusname"></a>`containerStatusName` | [`String!`](#string) |  |
| <a id="container_statusimage"></a>`image` | [`String!`](#string) |  |
| <a id="container_statusimageid"></a>`imageID` | [`Any`](#any) |  |
| <a id="container_statuslaststate"></a>`lastState` | [`Any`](#any) |  |
| <a id="container_statusready"></a>`ready` | [`Boolean!`](#boolean) |  |
| <a id="container_statusrestartcount"></a>`restartCount` | [`Any`](#any) |  |
| <a id="container_statusstarted"></a>`started` | [`Boolean!`](#boolean) | image: String! imageID: String! containerID: String!. |
| <a id="container_statusstate"></a>`state` | [`Any`](#any) |  |

### `ControlPlane`

Control Plane data for a particular Mesh.

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="controlplanemembers"></a>`members` | [`[ControlPlaneMember!]!`](#controlplanemember) | Members of the Mesh. |
| <a id="controlplanename"></a>`name` | [`String!`](#string) | Service Mesh Name. |

### `ControlPlaneMember`

Member Details.

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="controlplanemembercomponent"></a>`component` | [`String!`](#string) | Component. |
| <a id="controlplanememberdata_planes"></a>`data_planes` | [`[Container!]`](#container) | DataPlanes. |
| <a id="controlplanemembername"></a>`name` | [`String!`](#string) | Name. |
| <a id="controlplanemembernamespace"></a>`namespace` | [`String!`](#string) | Namespace. |
| <a id="controlplanememberversion"></a>`version` | [`String!`](#string) | Version. |

### `DataPlane`

Data Plane for a particular Mesh.

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="dataplanename"></a>`name` | [`String!`](#string) | Service Mesh Name. |
| <a id="dataplaneproxies"></a>`proxies` | [`[Container!]!`](#container) | Members of the Mesh. |

### `Error`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="errorcode"></a>`code` | [`String!`](#string) | Error Code. |
| <a id="errordescription"></a>`description` | [`String!`](#string) | Error Details. |

### `FilterPage`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="filterpagefilters"></a>`filters` | [`[FilterResult]`](#filterresult) |  |
| <a id="filterpagepage"></a>`page` | [`Int!`](#int) |  |
| <a id="filterpagepage_size"></a>`page_size` | [`Int!`](#int) |  |
| <a id="filterpagetotal_count"></a>`total_count` | [`Int!`](#int) |  |

### `FilterResult`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="filterresultcatalog_data"></a>`catalog_data` | [`Map`](#map) |  |
| <a id="filterresultcreated_at"></a>`created_at` | [`String`](#string) |  |
| <a id="filterresultfilter_file"></a>`filter_file` | [`String!`](#string) |  |
| <a id="filterresultid"></a>`id` | [`ID!`](#id) |  |
| <a id="filterresultlocation"></a>`location` | [`Location!`](#location) |  |
| <a id="filterresultname"></a>`name` | [`String!`](#string) |  |
| <a id="filterresultupdated_at"></a>`updated_at` | [`String`](#string) |  |
| <a id="filterresultuser_id"></a>`user_id` | [`String!`](#string) |  |
| <a id="filterresultvisibility"></a>`visibility` | [`String!`](#string) |  |

### `K8sContext`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="k8scontextauth"></a>`auth` | [`Map!`](#map) |  |
| <a id="k8scontextcluster"></a>`cluster` | [`Map!`](#map) |  |
| <a id="k8scontextcreated_at"></a>`created_at` | [`String!`](#string) |  |
| <a id="k8scontextcreated_by"></a>`created_by` | [`ID!`](#id) |  |
| <a id="k8scontextdeployment_type"></a>`deployment_type` | [`String!`](#string) |  |
| <a id="k8scontextid"></a>`id` | [`String!`](#string) |  |
| <a id="k8scontextkubernetes_server_id"></a>`kubernetes_server_id` | [`ID!`](#id) |  |
| <a id="k8scontextmeshery_instance_id"></a>`meshery_instance_id` | [`ID!`](#id) |  |
| <a id="k8scontextname"></a>`name` | [`String!`](#string) |  |
| <a id="k8scontextowner"></a>`owner` | [`ID!`](#id) |  |
| <a id="k8scontextserver"></a>`server` | [`String!`](#string) |  |
| <a id="k8scontextupdated_at"></a>`updated_at` | [`String!`](#string) |  |
| <a id="k8scontextversion"></a>`version` | [`String!`](#string) |  |

### `K8sContextsPage`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="k8scontextspagecontexts"></a>`contexts` | [`[K8sContext]!`](#k8scontext) |  |
| <a id="k8scontextspagetotal_count"></a>`total_count` | [`Int!`](#int) |  |

### `KctlDescribeDetails`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="kctldescribedetailsctxid"></a>`ctxid` | [`String`](#string) |  |
| <a id="kctldescribedetailsdescribe"></a>`describe` | [`String`](#string) |  |

### `Location`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="locationbranch"></a>`branch` | [`String`](#string) |  |
| <a id="locationhost"></a>`host` | [`String`](#string) |  |
| <a id="locationpath"></a>`path` | [`String`](#string) |  |
| <a id="locationtype"></a>`type` | [`String`](#string) |  |

### `MeshModelComponent`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="meshmodelcomponentcount"></a>`count` | [`Int!`](#int) |  |
| <a id="meshmodelcomponentname"></a>`name` | [`String!`](#string) |  |

### `MeshModelRelationship`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="meshmodelrelationshipcount"></a>`count` | [`Int!`](#int) |  |
| <a id="meshmodelrelationshipname"></a>`name` | [`String!`](#string) |  |

### `MeshModelSummary`

Type MeshModelComponentsSummary define the summary of a Mesh Model.

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="meshmodelsummarycomponents"></a>`components` | [`[MeshModelComponent!]`](#meshmodelcomponent) |  |
| <a id="meshmodelsummaryrelationships"></a>`relationships` | [`[MeshModelRelationship!]`](#meshmodelrelationship) |  |

### `MeshSyncEvent`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="meshsynceventcontextid"></a>`contextId` | [`String!`](#string) |  |
| <a id="meshsynceventobject"></a>`object` | [`Any!`](#any) |  |
| <a id="meshsynceventtype"></a>`type` | [`String!`](#string) |  |

### `MesheryControllersStatusListItem`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="mesherycontrollersstatuslistitemcontextid"></a>`contextId` | [`String!`](#string) |  |
| <a id="mesherycontrollersstatuslistitemcontroller"></a>`controller` | [`MesheryController!`](#mesherycontroller) |  |
| <a id="mesherycontrollersstatuslistitemstatus"></a>`status` | [`MesheryControllerStatus!`](#mesherycontrollerstatus) |  |

### `MesheryResult`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="mesheryresultcreated_at"></a>`created_at` | [`String`](#string) |  |
| <a id="mesheryresultmesh"></a>`mesh` | [`String`](#string) |  |
| <a id="mesheryresultmeshery_id"></a>`meshery_id` | [`String`](#string) |  |
| <a id="mesheryresultname"></a>`name` | [`String`](#string) |  |
| <a id="mesheryresultperformance_profile"></a>`performance_profile` | [`String`](#string) |  |
| <a id="mesheryresultrunner_results"></a>`runner_results` | [`Map`](#map) |  |
| <a id="mesheryresultserver_board_config"></a>`server_board_config` | [`String`](#string) |  |
| <a id="mesheryresultserver_metrics"></a>`server_metrics` | [`String`](#string) |  |
| <a id="mesheryresulttest_id"></a>`test_id` | [`String`](#string) |  |
| <a id="mesheryresulttest_start_time"></a>`test_start_time` | [`String`](#string) |  |
| <a id="mesheryresultupdated_at"></a>`updated_at` | [`String`](#string) |  |
| <a id="mesheryresultuser_id"></a>`user_id` | [`String`](#string) |  |

### `NameSpace`

Type to define a k8s Namespace.

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="namespacenamespace"></a>`namespace` | [`String!`](#string) | Namespace Name. |

### `NullString`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="nullstringstring"></a>`String` | [`String!`](#string) |  |
| <a id="nullstringvalid"></a>`Valid` | [`Boolean!`](#boolean) |  |

### `OAMCapability`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="oamcapabilityhost"></a>`host` | [`String`](#string) |  |
| <a id="oamcapabilityid"></a>`id` | [`String`](#string) |  |
| <a id="oamcapabilitymetadata"></a>`metadata` | [`Any`](#any) |  |
| <a id="oamcapabilityoam_definition"></a>`oam_definition` | [`Any`](#any) |  |
| <a id="oamcapabilityoam_ref_schema"></a>`oam_ref_schema` | [`String`](#string) |  |
| <a id="oamcapabilityrestricted"></a>`restricted` | [`Boolean`](#boolean) |  |

### `OperatorControllerStatus`

Controllers of Meshery Operator.

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="operatorcontrollerstatuscontextid"></a>`contextID` | [`String!`](#string) |  |
| <a id="operatorcontrollerstatuserror"></a>`error` | [`Error`](#error) | Controller Error Log. |
| <a id="operatorcontrollerstatusname"></a>`name` | [`String!`](#string) | Controller Name. |
| <a id="operatorcontrollerstatusstatus"></a>`status` | [`Status!`](#status) | Controller Status. |
| <a id="operatorcontrollerstatusversion"></a>`version` | [`String!`](#string) | Controller Version. |

### `OperatorControllerStatusPerK8sContext`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="operatorcontrollerstatusperk8scontextoperatorcontrollerstatus"></a>`OperatorControllerStatus` | [`OperatorControllerStatus!`](#operatorcontrollerstatus) |  |
| <a id="operatorcontrollerstatusperk8scontextcontextid"></a>`contextID` | [`String!`](#string) |  |

### `OperatorStatus`

Status of Meshery Operator and its controllers.

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="operatorstatuscontextid"></a>`contextID` | [`String!`](#string) |  |
| <a id="operatorstatuscontrollers"></a>`controllers` | [`[OperatorControllerStatus!]!`](#operatorcontrollerstatus) | Details about various Controllers of Meshery Operator. |
| <a id="operatorstatuserror"></a>`error` | [`Error`](#error) | Error Logs encountered by Meshery Operator. |
| <a id="operatorstatusstatus"></a>`status` | [`Status!`](#status) | Status of Meshery Operator. |
| <a id="operatorstatusversion"></a>`version` | [`String!`](#string) | Verion of Meshery Operator. |

### `OperatorStatusPerK8sContext`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="operatorstatusperk8scontextcontextid"></a>`contextID` | [`String!`](#string) |  |
| <a id="operatorstatusperk8scontextoperatorstatus"></a>`operatorStatus` | [`OperatorStatus!`](#operatorstatus) |  |

### `PatternPageResult`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="patternpageresultpage"></a>`page` | [`Int!`](#int) |  |
| <a id="patternpageresultpage_size"></a>`page_size` | [`Int!`](#int) |  |
| <a id="patternpageresultpatterns"></a>`patterns` | [`[PatternResult]`](#patternresult) |  |
| <a id="patternpageresulttotal_count"></a>`total_count` | [`Int!`](#int) |  |

### `PatternResult`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="patternresultcansupport"></a>`canSupport` | [`Boolean!`](#boolean) |  |
| <a id="patternresultcatalog_data"></a>`catalog_data` | [`Map`](#map) |  |
| <a id="patternresultcreated_at"></a>`created_at` | [`String`](#string) |  |
| <a id="patternresulterrmsg"></a>`errmsg` | [`String`](#string) |  |
| <a id="patternresultid"></a>`id` | [`ID!`](#id) |  |
| <a id="patternresultlocation"></a>`location` | [`Location!`](#location) |  |
| <a id="patternresultname"></a>`name` | [`String!`](#string) |  |
| <a id="patternresultpattern_file"></a>`pattern_file` | [`String!`](#string) |  |
| <a id="patternresultupdated_at"></a>`updated_at` | [`String`](#string) |  |
| <a id="patternresultuser_id"></a>`user_id` | [`String!`](#string) |  |
| <a id="patternresultvisibility"></a>`visibility` | [`String!`](#string) |  |

### `PerfPageProfiles`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="perfpageprofilespage"></a>`page` | [`Int!`](#int) |  |
| <a id="perfpageprofilespage_size"></a>`page_size` | [`Int!`](#int) |  |
| <a id="perfpageprofilesprofiles"></a>`profiles` | [`[PerfProfile]`](#perfprofile) |  |
| <a id="perfpageprofilestotal_count"></a>`total_count` | [`Int!`](#int) |  |

### `PerfPageResult`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="perfpageresultpage"></a>`page` | [`Int!`](#int) |  |
| <a id="perfpageresultpage_size"></a>`page_size` | [`Int!`](#int) |  |
| <a id="perfpageresultresults"></a>`results` | [`[MesheryResult]`](#mesheryresult) |  |
| <a id="perfpageresulttotal_count"></a>`total_count` | [`Int!`](#int) |  |

### `PerfProfile`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="perfprofileconcurrent_request"></a>`concurrent_request` | [`Int!`](#int) |  |
| <a id="perfprofilecontent_type"></a>`content_type` | [`String`](#string) |  |
| <a id="perfprofilecreated_at"></a>`created_at` | [`String`](#string) |  |
| <a id="perfprofileduration"></a>`duration` | [`String!`](#string) |  |
| <a id="perfprofileendpoints"></a>`endpoints` | [`[String]`](#string) |  |
| <a id="perfprofileid"></a>`id` | [`String!`](#string) |  |
| <a id="perfprofilelast_run"></a>`last_run` | [`String`](#string) |  |
| <a id="perfprofileload_generators"></a>`load_generators` | [`[String]`](#string) |  |
| <a id="perfprofilename"></a>`name` | [`String`](#string) |  |
| <a id="perfprofileowner"></a>`owner` | [`String!`](#string) |  |
| <a id="perfprofileqps"></a>`qps` | [`Int`](#int) |  |
| <a id="perfprofilerequest_body"></a>`request_body` | [`String`](#string) |  |
| <a id="perfprofilerequest_cookies"></a>`request_cookies` | [`String`](#string) |  |
| <a id="perfprofilerequest_headers"></a>`request_headers` | [`String`](#string) |  |
| <a id="perfprofileservice_mesh"></a>`service_mesh` | [`String`](#string) |  |
| <a id="perfprofiletotal_results"></a>`total_results` | [`Int`](#int) |  |
| <a id="perfprofileupdated_at"></a>`updated_at` | [`String`](#string) |  |

### `Resource`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="resourcecount"></a>`count` | [`Int!`](#int) | Number of resouce. |
| <a id="resourcekind"></a>`kind` | [`String!`](#string) | Name of resource. |

### `TelemetryComp`

#### **Fields**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="telemetrycompname"></a>`name` | [`String!`](#string) |  |
| <a id="telemetrycompspec"></a>`spec` | [`String!`](#string) |  |
| <a id="telemetrycompstatus"></a>`status` | [`String!`](#string) |  |

## Enumeration types

Also called _Enums_, enumeration types are a special kind of scalar that
is restricted to a particular set of allowed values.

For more information, see
[Enumeration Types](https://graphql.org/learn/schema/#enumeration-types)
on `graphql.org`.

### `MeshType`

Service Mesh Types.

| Value | Description |
| ----- | ----------- |
| <a id="meshtypeall_mesh"></a>`ALL_MESH` | All meshes that Meshery supports. |
| <a id="meshtypeapp_mesh"></a>`APP_MESH` | AWS App Mesh. |
| <a id="meshtypecilium_service_mesh"></a>`CILIUM_SERVICE_MESH` | Cilium Service Mesh. |
| <a id="meshtypecitrix_service_mesh"></a>`CITRIX_SERVICE_MESH` | Citrix Service Mesh. |
| <a id="meshtypeconsul"></a>`CONSUL` | Consul by HashiCorp. |
| <a id="meshtypeinvalid_mesh"></a>`INVALID_MESH` | Invalid Mesh. |
| <a id="meshtypeistio"></a>`ISTIO` | Istio Service Mesh. |
| <a id="meshtypekuma"></a>`KUMA` | Kuma. |
| <a id="meshtypelinkerd"></a>`LINKERD` | LinkerD Service Mesh. |
| <a id="meshtypenetwork_service_mesh"></a>`NETWORK_SERVICE_MESH` | Network Service Mesh. |
| <a id="meshtypenginx_service_mesh"></a>`NGINX_SERVICE_MESH` | NGINX Service Mesh. |
| <a id="meshtypeoctarine"></a>`OCTARINE` | Octarine Mesh. |
| <a id="meshtypeopen_service_mesh"></a>`OPEN_SERVICE_MESH` | Open Service Mesh. |
| <a id="meshtypetanzu"></a>`TANZU` | VMware Tanzu Service Mesh. |
| <a id="meshtypetraefik_mesh"></a>`TRAEFIK_MESH` | Traefik Mesh. |

### `MesheryController`

| Value | Description |
| ----- | ----------- |
| <a id="mesherycontrollerbroker"></a>`BROKER` |  |
| <a id="mesherycontrollermeshsync"></a>`MESHSYNC` |  |
| <a id="mesherycontrolleroperator"></a>`OPERATOR` |  |

### `MesheryControllerStatus`

| Value | Description |
| ----- | ----------- |
| <a id="mesherycontrollerstatusdeployed"></a>`DEPLOYED` |  |
| <a id="mesherycontrollerstatusdeploying"></a>`DEPLOYING` |  |
| <a id="mesherycontrollerstatusnotdeployed"></a>`NOTDEPLOYED` |  |
| <a id="mesherycontrollerstatusunkown"></a>`UNKNOWN` |  |

### `Status`

| Value | Description |
| ----- | ----------- |
| <a id="statusconnected"></a>`CONNECTED` | Connected (Applicable only for NATS status for now). |
| <a id="statusdisabled"></a>`DISABLED` | Disabled. |
| <a id="statusenabled"></a>`ENABLED` | Enabled. |
| <a id="statusprocessing"></a>`PROCESSING` | Processing. |
| <a id="statusunknown"></a>`UNKNOWN` | Unknown. |

## Scalar types

Scalar values are atomic values, and do not have fields of their own.
Basic scalars include strings, boolean values, and numbers. This schema also
defines various custom scalar values, such as types for times and dates.

This schema includes custom scalar types for identifiers, with a specific type for
each kind of object.

For more information, read about [Scalar Types](https://graphql.org/learn/schema/#scalar-types) on `graphql.org`.

### `Any`

### `Boolean`

Represents `true` or `false` values.

### `ID`

Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) input value will be accepted as an ID.

### `Int`

Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

### `Map`

### `String`

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

### `Time`

## Input types

Types that may be used as arguments (all scalar types may also
be used as arguments).

Only general use input types are listed here. For mutation input types,
see the associated mutation type above.

For more information, read about [Scalar Types](https://graphql.org/learn/schema/#input-types) on `graphql.org`.

### `AddonStatusInput`

Input for changing Addon Status.

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="addonstatusinputk8scontextid"></a>`k8scontextID` | [`String!`](#string) | kubernetes context ID. |
| <a id="addonstatusinputselector"></a>`selector` | [`MeshType`](#meshtype) | Filter by Serice Mesh. |
| <a id="addonstatusinputtargetstatus"></a>`targetStatus` | [`Status!`](#status) | Desired Status. |

### `CatalogSelector`

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="catalogselectororder"></a>`order` | [`String!`](#string) |  |
| <a id="catalogselectorpage"></a>`page` | [`String!`](#string) |  |
| <a id="catalogselectorpagesize"></a>`page_size` | [`String!`](#string) |  |
| <a id="catalogselectorsearch"></a>`search` | [`String!`](#string) |  |

### `MeshModelSummarySelector`

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="meshmodelsummaryselectortype"></a>`type` | [`String!`](#string) |  |

### `PageFilter`

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="pagefilterfrom"></a>`from` | [`String`](#string) |  |
| <a id="pagefilterorder"></a>`order` | [`String`](#string) |  |
| <a id="pagefilterpage"></a>`page` | [`String!`](#string) |  |
| <a id="pagefilterpagesize"></a>`pageSize` | [`String!`](#string) |  |
| <a id="pagefiltersearch"></a>`search` | [`String`](#string) |  |
| <a id="pagefilterto"></a>`to` | [`String`](#string) |  |
| <a id="pagefilterupdated_after"></a>`updated_after` | [`String`](#string) |  |

### `ReSyncActions`

Type ReSyncActions define the actions involved during resync.

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="resyncactionsresync"></a>`ReSync` | [`String!`](#string) |  |
| <a id="resyncactionscleardb"></a>`clearDB` | [`String!`](#string) |  |
| <a id="resyncactionshardreset"></a>`hardReset` | [`String!`](#string) |  |

### `ServiceMeshFilter`

Filter Control Plane Query.

#### **Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |
| <a id="servicemeshfilterk8sclusterids"></a>`k8sClusterIDs` | [`[String!]`](#string) |  |
| <a id="servicemeshfiltertype"></a>`type` | [`MeshType`](#meshtype) | Filter by Service Mesh. |