Project: Meshery (Provisioning / Automation & Configuration)
File: graphql-api-reference.md

layout: default title: "GraphQL API Reference" permalink: reference/graphql-apis type: Reference abstract: 'Meshery GraphQL API Documentation and Reference' <! This documentation is auto generated by a script. Please do not edit this file directly, check compile_docs task on docs/Rakefile. > Self-generated API documentation for Meshery's GraphQL API. The API can be explored interactively using the . Documentation is generated from Meshery's GraphQL schema. Each table below documents a GraphQL type. WARNING: Fields that are deprecated are marked with {warning-solid}. <!-- vale off --> The `Query` type contains the API's top-level entry points for all executable queries. Check is Meshey Server is connected to NATS, if not connect to the NATS Server. | Name | Type | Description | | - | - | -- | | <a id="queryconnecttonatsk8scontextid"></a>`k8scontextID` | | | Check the Meshsync Status and deploy if not enabled. | Name | Type | Description | | - | - | -- | | <a id="querydeploymeshsynck8scontextid"></a>`k8scontextID` | | what to do in-order to deploy meshsync on multiple clusters/contexts. | Query for fetching all results for profile ID. | Name | Type | Description | | - | - | -- | | <a id="queryfetchallresultsselector"></a>`selector` | | | Query for getting Filter Catalog from remote provider. | Name | Type | Description | | - | - | -- | | <a id="queryfetchfiltercatalogcontentselector"></a>`selector` | | | Query for getting Pattern Catalog from remote provider. | Name | Type | Description | | - | - | -- | | <a id="queryfetchpatterncatalogcontentselector"></a>`selector` | | | Query for fetching all patterns with selector. | Name | Type | Description | | - | - | -- | | <a id="queryfetchpatternsselector"></a>`selector` | | | Query for fetching all results for profile ID. | Name | Type | Description | | - | - | -- | | <a id="queryfetchresultsprofileid"></a>`profileID` | | | | <a id="queryfetchresultsselector"></a>`selector` | | | Query for telemetry components. | Name | Type | Description | | - | - | -- | | <a id="queryfetchtelemetrycomponentscontexts"></a>`contexts` | | | Query details about Addons available (Eg. Prometheus and Grafana). | Name | Type | Description | | - | - | -- | | <a id="querygetavailableaddonsfilter"></a>`filter` | | Select Mesh Type. | Query available Namesapces in your cluster. | Name | Type | Description | | - | - | -- | | <a id="querygetavailablenamespacesk8sclusterids"></a>`k8sClusterIDs` | | | Query for getting cluster info. | Name | Type | Description | | - | - | -- | | <a id="querygetclusterresourcesk8scontextids"></a>`k8scontextIDs` | | | | <a id="querygetclusterresourcesnamespace"></a>`namespace` | | | Query Control Plane data for a Service Mesh (or all) in your cluster. | Name | Type | Description | | - | - | -- | | <a id="querygetcontrolplanesfilter"></a>`filter` | | Filter Control Plane Query. | Query Data Plane information for a Service Mesh (or all) in your cluster. | Name | Type | Description | | - | - | -- | | <a id="querygetdataplanesfilter"></a>`filter` | | Filter Control Plane Query. | Query for getting kubectl describe details with meshkit. | Name | Type | Description | | - | - | -- | | <a id="querygetkubectldescribekind"></a>`kind` | | | | <a id="querygetkubectldescribename"></a>`name` | | | | <a id="querygetkubectldescribenamespace"></a>`namespace` | | | Query for meshmodel

| Name | Type | Description | | - | - | -- | | <a id="querygetmeshmodelsummaryselector"></a>`selector` | | | Check the Meshsync Status. | Name | Type | Description | | - | - | -- | | <a id="querygetmeshsyncstatusk8scontextid"></a>`k8scontextID` | | | Check is Meshey Server is connected to NATS. | Name | Type | Description | | - | - | -- | | <a id="querygetnatsstatusk8scontextid"></a>`k8scontextID` | | | Query status of Meshery Operator in your cluster. | Name | Type | Description | | - | - | -- | | <a id="querygetoperatorstatusk8scontextid"></a>`k8scontextID` | | | Query for performance result. | Name | Type | Description | | - | - | -- | | <a id="querygetperfresultid"></a>`id` | | | Query for fetching all results for profile ID. | Name | Type | Description | | - | - | -- | | <a id="querygetperformanceprofilesselector"></a>`selector` | | | Query to resync the cluster discovery. | Name | Type | Description | | - | - | -- | | <a id="queryresyncclusterk8scontextid"></a>`k8scontextID` | | | | <a id="queryresyncclusterselector"></a>`selector` | | Selector to control several resync actions. | The `Mutation` type contains all the mutations you can execute. All mutations receive their arguments in a single input object named `input`. Change the Adapter Status. | Name | Type | Description | | - | - | -- | | <a id="mutationchangeadapterstatusadapter"></a>`adapter` | | Name of the adapter to be deployed. | | <a id="mutationchangeadapterstatustargetport"></a>`targetPort` | | The port on which adapter will be deployed. | | <a id="mutationchangeadapterstatustargetstatus"></a>`targetStatus` | | Desired status for Meshery Operator. | Change the Operator Status. | Name | Type | Description | | - | - | -- | | <a id="mutationchangeoperatorstatuscontextid"></a>`contextID` | | | | <a id="mutationchangeoperatorstatustargetstatus"></a>`targetStatus` | | Desired status for Meshery Operator. | The `Subscription` type contains all the Subscriptions you can listen to. Listen to changes in status of Addons available (Eg. Prometheus and Grafana). | Name | Type | Description | | - | - | -- | | <a id="subscriptionlistentoaddonstatefilter"></a>`filter` | | Select Mesh Type. | Listen to changes in Control Plane data for a Service Mesh (or all) in your cluster. | Name | Type | Description | | - | - | -- | | <a id="subscriptionlistentocontrolplanestatefilter"></a>`filter` | | Filter Control Plane Query. | Listen to changes in Data Plane data for a Service Mesh (or all) in your cluster. | Name | Type | Description | | - | - | -- | | <a id="subscriptionlistentodataplanestatefilter"></a>`filter` | | Filter Control Plane Query. | Listen to changes in the list of available Namesapces in your cluster. | Name | Type | Description | | - | - | -- | | <a id="subscriptionlistentomeshsynceventsk8scontextids"></a>`k8scontextIDs` | | | Listen to changes in status of Meshery Operator in your cluster. | Name | Type | Description | | - | - | -- | | <a id="subscriptionlistentooperatorstatek8scontextids"></a>`k8scontextIDs` | | | Listen to changes in Broker (NATS)

| Name | Type | Description | | - | - | -- | | <a id="subscriptionsubscribeclusterresourcesk8scontextids"></a>`k8scontextIDs` | | | | <a id="subscriptionsubscribeclusterresourcesnamespace"></a>`namespace` | | | | Name | Type | Description | | - | - | -- | | <a id="subscriptionsubscribeconfigurationapplicationselector"></a>`applicationSelector` | | | | <a id="subscriptionsubscribeconfigurationfilterselector"></a>`filterSelector` | | | | <a id="subscriptionsubscribeconfigurationpatternselector"></a>`patternSelector` | | | | Name | Type | Description | | - | - | -- | | <a id="subscriptionsubscribek8scontextselector"></a>`selector` | | | | Name | Type | Description | | - | - | -- | | <a id="subscriptionsubscribemeshmodelsummaryselector"></a>`selector` | | | 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. | Name | Type | Description | | - | - | -- | | <a id="subscriptionsubscribemeshsynceventsk8scontextids"></a>`k8scontextIDs` | | | Listen to changes in the status of meshery controllers. | Name | Type | Description | | - | - | -- | | <a id="subscriptionsubscribemesherycontrollersstatusk8scontextids"></a>`k8scontextIDs` | | | Listen to changes in Performance Profiles. | Name | Type | Description | | - | - | -- | | <a id="subscriptionsubscribeperfprofilesselector"></a>`selector` | | | Listen to all results for profile ID. | Name | Type | Description | | - | - | -- | | <a id="subscriptionsubscribeperfresultsprofileid"></a>`profileID` | | | | <a id="subscriptionsubscribeperfresultsselector"></a>`selector` | | | 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 (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 on `graphql.org`. Deatils about the Addon Component. | Name | Type | Description | | - | - | -- | | <a id="addonlistname"></a>`name` | | Name. | | <a id="addonlistowner"></a>`owner` | | Owner. | | Name | Type | Description | | - | - | -- | | <a id="applicationpageapplications"></a>`applications` | | | | <a id="applicationpagepage"></a>`page` | | | | <a id="applicationpagepagesize"></a>`pagesize` | | | | <a id="applicationpagetotalcount"></a>`totalcount` | | | | Name | Type | Description | | - | - | -- | | <a id="applicationresultapplicationfile"></a>`applicationfile` | | | | <a id="applicationresultcreatedat"></a>`createdat` | | | | <a id="applicationresultid"></a>`id` | | | | <a id="applicationresultlocation"></a>`location` | | | | <a id="applicationresultname"></a>`name` | | | | <a id="applicationresulttype"></a>`type` | | | | <a id="applicationresultupdatedat"></a>`updatedat` | | | | <a id="applicationresultuserid"></a>`userid` | | | | <a id="applicationresultvisibility"></a>`visibility` | | | | Name | Type | Description | | - | - | -- | | <a id="catalogfiltercatalogdata"></a>`catalogdata` | | | | <a id="catalogfiltercreatedat"></a>`createdat` | | | | <a id="catalogfilterfilterfile"></a>`filterfile` | | | | <a id="catalogfilterid"></a>`id` | | | | <a id="catalogfilterlocation"></a>`location` | | | | <a id="catalogfiltername"></a>`name` | | | | <a id="catalogfilterupdatedat"></a>`updatedat` | | | | <a id="catalogfilteruserid"></a>`userid` | | | | <a id="catalogfiltervisibility"></a>`visibility` | | | | Name | Type | Description | | - | - | -- | | <a id="catalogpatterncatalogdata"></a>`catalogdata` | | | | <a id="catalogpatterncreatedat"></a>`createdat` | | | | <a id="catalogpatternid"></a>`id` | | | | <a id="catalogpatternlocation"></a>`location` | | | | <a id="catalogpatternname"></a>`name` | | | | <a id="catalogpatternpatternfile"></a>`patternfile` | | | | <a id="catalogpatternupdatedat"></a>`updatedat` | | | | <a id="catalogpatternuserid"></a>`userid` | | | | <a id="catalogpatternvisibility"></a>`visibility` | | | Details about discovered

| Name | Type | Description | | - | - | -- | | <a id="clusterresourcesresources"></a>`resources` | | | | Name | Type | Description | | - | - | -- | | <a id="configurationpageapplications"></a>`applications` | | | | <a id="configurationpagefilters"></a>`filters` | | | | <a id="configurationpagepatterns"></a>`patterns` | | | | Name | Type | Description | | - | - | -- | | <a id="containercontainername"></a>`containerName` | | | | <a id="containercontrolplanemembername"></a>`controlPlaneMemberName` | | | | <a id="containerimage"></a>`image` | | | | <a id="containerports"></a>`ports` | | args: NOT IMPLEMENTED. | | <a id="containerresources"></a>`resources` | | env: NOT IMPLEMENTED,. | | <a id="containerstatus"></a>`status` | | | | Name | Type | Description | | - | - | -- | | <a id="container_portcontainerport"></a>`containerPort` | | | | <a id="container_portname"></a>`name` | | | | <a id="container_portprotocol"></a>`protocol` | | | | Name | Type | Description | | - | - | -- | | <a id="container_statuscontainerid"></a>`containerID` | | | | <a id="container_statuscontainerstatusname"></a>`containerStatusName` | | | | <a id="container_statusimage"></a>`image` | | | | <a id="container_statusimageid"></a>`imageID` | | | | <a id="container_statuslaststate"></a>`lastState` | | | | <a id="container_statusready"></a>`ready` | | | | <a id="container_statusrestartcount"></a>`restartCount` | | | | <a id="container_statusstarted"></a>`started` | | image: String! imageID: String! containerID: String!. | | <a id="container_statusstate"></a>`state` | | | Control Plane data for a particular Mesh. | Name | Type | Description | | - | - | -- | | <a id="controlplanemembers"></a>`members` | | Members of the Mesh. | | <a id="controlplanename"></a>`name` | | Service Mesh Name. | Member Details. | Name | Type | Description | | - | - | -- | | <a id="controlplanemembercomponent"></a>`component` | | Component. | | <a id="controlplanememberdataplanes"></a>`dataplanes` | | DataPlanes. | | <a id="controlplanemembername"></a>`name` | | Name. | | <a id="controlplanemembernamespace"></a>`namespace` | | Namespace. | | <a id="controlplanememberversion"></a>`version` | | Version. | Data Plane for a particular Mesh. | Name | Type | Description | | - | - | -- | | <a id="dataplanename"></a>`name` | | Service Mesh Name. | | <a id="dataplaneproxies"></a>`proxies` | | Members of the Mesh. | | Name | Type | Description | | - | - | -- | | <a id="errorcode"></a>`code` | | Error Code. | | <a id="errordescription"></a>`description` | | Error

| | Name | Type | Description | | - | - | -- | | <a id="filterpagefilters"></a>`filters` | | | | <a id="filterpagepage"></a>`page` | | | | <a id="filterpagepagesize"></a>`pagesize` | | | | <a id="filterpagetotalcount"></a>`totalcount` | | | | Name | Type | Description | | - | - | -- | | <a id="filterresultcatalogdata"></a>`catalogdata` | | | | <a id="filterresultcreatedat"></a>`createdat` | | | | <a id="filterresultfilterfile"></a>`filterfile` | | | | <a id="filterresultid"></a>`id` | | | | <a id="filterresultlocation"></a>`location` | | | | <a id="filterresultname"></a>`name` | | | | <a id="filterresultupdatedat"></a>`updatedat` | | | | <a id="filterresultuserid"></a>`userid` | | | | <a id="filterresultvisibility"></a>`visibility` | | | | Name | Type | Description | | - | - | -- | | <a id="k8scontextauth"></a>`auth` | | | | <a id="k8scontextcluster"></a>`cluster` | | | | <a id="k8scontextcreatedat"></a>`createdat` | | | | <a id="k8scontextcreatedby"></a>`createdby` | | | | <a id="k8scontextdeploymenttype"></a>`deploymenttype` | | | | <a id="k8scontextid"></a>`id` | | | | <a id="k8scontextkubernetesserverid"></a>`kubernetesserverid` | | | | <a id="k8scontextmesheryinstanceid"></a>`mesheryinstanceid` | | | | <a id="k8scontextname"></a>`name` | | | | <a id="k8scontextowner"></a>`owner` | | | | <a id="k8scontextserver"></a>`server` | | | | <a id="k8scontextupdatedat"></a>`updatedat` | | | | <a id="k8scontextversion"></a>`version` | | | | Name | Type | Description | | - | - | -- | | <a id="k8scontextspagecontexts"></a>`contexts` | | | | <a id="k8scontextspagetotalcount"></a>`totalcount` | | | | Name | Type | Description | | - | - | -- | | <a id="kctldescribedetailsctxid"></a>`ctxid` | | | | <a id="kctldescribedetailsdescribe"></a>`describe` | | | | Name | Type | Description | | - | - | -- | | <a id="locationbranch"></a>`branch` | | | | <a id="locationhost"></a>`host` | | | | <a id="locationpath"></a>`path` | | | | <a id="locationtype"></a>`type` | | | | Name | Type | Description | | - | - | -- | | <a id="meshmodelcomponentcount"></a>`count` | | | | <a id="meshmodelcomponentname"></a>`name` | | | | Name | Type | Description | | - | - | -- | | <a id="meshmodelrelationshipcount"></a>`count` | | | | <a id="meshmodelrelationshipname"></a>`name` | | | Type MeshModelComponentsSummary define the summary of a Mesh Model. | Name | Type | Description | | - | - | -- | | <a id="meshmodelsummarycomponents"></a>`components` | | | | <a id="meshmodelsummaryrelationships"></a>`relationships` | | | | Name | Type | Description | | - | - | -- | | <a id="meshsynceventcontextid"></a>`contextId` | | | | <a id="meshsynceventobject"></a>`object` | | | | <a id="meshsynceventtype"></a>`type` | | | | Name | Type | Description | | - | - | -- | | <a id="mesherycontrollersstatuslistitemcontextid"></a>`contextId` | | | | <a id="mesherycontrollersstatuslistitemcontroller"></a>`controller` | | | | <a id="mesherycontrollersstatuslistitemstatus"></a>`status` | | | | Name | Type | Description | | - | - | -- | | <a id="mesheryresultcreatedat"></a>`createdat` | | | | <a id="mesheryresultmesh"></a>`mesh` | | | | <a id="mesheryresultmesheryid"></a>`mesheryid` | | | | <a id="mesheryresultname"></a>`name` | | | | <a id="mesheryresultperformanceprofile"></a>`performanceprofile` | | | | <a id="mesheryresultrunnerresults"></a>`runnerresults` | | | | <a id="mesheryresultserverboardconfig"></a>`serverboardconfig` | | | | <a id="mesheryresultservermetrics"></a>`servermetrics` | | | | <a id="mesheryresulttestid"></a>`testid` | | | | <a id="mesheryresultteststarttime"></a>`teststarttime` | | | | <a id="mesheryresultupdatedat"></a>`updatedat` | | | | <a id="mesheryresultuserid"></a>`userid` | | | Type to define a k8s Namespace. | Name | Type | Description | | - | - | -- | | <a id="namespacenamespace"></a>`namespace` | | Namespace Name. | | Name | Type | Description | | - | - | -- | | <a id="nullstringstring"></a>`String` | | | | <a id="nullstringvalid"></a>`Valid` | | | | Name | Type | Description | | - | - | -- | | <a id="oamcapabilityhost"></a>`host` | | | | <a id="oamcapabilityid"></a>`id` | | | | <a id="oamcapabilitymetadata"></a>`metadata` | | | | <a id="oamcapabilityoamdefinition"></a>`oamdefinition` | | | | <a id="oamcapabilityoamrefschema"></a>`oamrefschema` | | | | <a id="oamcapabilityrestricted"></a>`restricted` | | | Controllers of Meshery Operator. | Name | Type | Description | | - | - | -- | | <a id="operatorcontrollerstatuscontextid"></a>`contextID` | | | | <a id="operatorcontrollerstatuserror"></a>`error` | | Controller Error Log. | | <a id="operatorcontrollerstatusname"></a>`name` | | Controller Name. | | <a id="operatorcontrollerstatusstatus"></a>`status` | | Controller Status. | | <a id="operatorcontrollerstatusversion"></a>`version` | | Controller Verison. | | Name | Type | Description | | - | - | -- | | <a id="operatorcontrollerstatusperk8scontextoperatorcontrollerstatus"></a>`OperatorControllerStatus` | | | | <a id="operatorcontrollerstatusperk8scontextcontextid"></a>`contextID` | | | Status of Meshery Operator and its controllers. | Name | Type | Description | | - | - | -- | | <a id="operatorstatuscontextid"></a>`contextID` | | | | <a id="operatorstatuscontrollers"></a>`controllers` | | Details about various Controllers of Meshery Operator. | | <a id="operatorstatuserror"></a>`error` | | Error Logs encountered by Meshery Operator. | | <a id="operatorstatusstatus"></a>`status` | | Status of Meshery

| | <a id="operatorstatusversion"></a>`version` | | Verion of Meshery Operator. | | Name | Type | Description | | - | - | -- | | <a id="operatorstatusperk8scontextcontextid"></a>`contextID` | | | | <a id="operatorstatusperk8scontextoperatorstatus"></a>`operatorStatus` | | | | Name | Type | Description | | - | - | -- | | <a id="patternpageresultpage"></a>`page` | | | | <a id="patternpageresultpagesize"></a>`pagesize` | | | | <a id="patternpageresultpatterns"></a>`patterns` | | | | <a id="patternpageresulttotalcount"></a>`totalcount` | | | | Name | Type | Description | | - | - | -- | | <a id="patternresultcansupport"></a>`canSupport` | | | | <a id="patternresultcatalogdata"></a>`catalogdata` | | | | <a id="patternresultcreatedat"></a>`createdat` | | | | <a id="patternresulterrmsg"></a>`errmsg` | | | | <a id="patternresultid"></a>`id` | | | | <a id="patternresultlocation"></a>`location` | | | | <a id="patternresultname"></a>`name` | | | | <a id="patternresultpatternfile"></a>`patternfile` | | | | <a id="patternresultupdatedat"></a>`updatedat` | | | | <a id="patternresultuserid"></a>`userid` | | | | <a id="patternresultvisibility"></a>`visibility` | | | | Name | Type | Description | | - | - | -- | | <a id="perfpageprofilespage"></a>`page` | | | | <a id="perfpageprofilespagesize"></a>`pagesize` | | | | <a id="perfpageprofilesprofiles"></a>`profiles` | | | | <a id="perfpageprofilestotalcount"></a>`totalcount` | | | | Name | Type | Description | | - | - | -- | | <a id="perfpageresultpage"></a>`page` | | | | <a id="perfpageresultpagesize"></a>`pagesize` | | | | <a id="perfpageresultresults"></a>`results` | | | | <a id="perfpageresulttotalcount"></a>`totalcount` | | | | Name | Type | Description | | - | - | -- | | <a id="perfprofileconcurrentrequest"></a>`concurrentrequest` | | | | <a id="perfprofilecontenttype"></a>`contenttype` | | | | <a id="perfprofilecreatedat"></a>`createdat` | | | | <a id="perfprofileduration"></a>`duration` | | | | <a id="perfprofileendpoints"></a>`endpoints` | | | | <a id="perfprofileid"></a>`id` | | | | <a id="perfprofilelastrun"></a>`lastrun` | | | | <a id="perfprofileloadgenerators"></a>`loadgenerators` | | | | <a id="perfprofilename"></a>`name` | | | | <a id="perfprofileqps"></a>`qps` | | | | <a id="perfprofilerequestbody"></a>`requestbody` | | | | <a id="perfprofilerequestcookies"></a>`requestcookies` | | | | <a id="perfprofilerequestheaders"></a>`requestheaders` | | | | <a id="perfprofileservicemesh"></a>`servicemesh` | | | | <a id="perfprofiletotalresults"></a>`totalresults` | | | | <a id="perfprofileupdatedat"></a>`updatedat` | | | | <a id="perfprofileuserid"></a>`userid` | | | | Name | Type | Description | | - | - | -- | | <a id="resourcecount"></a>`count` | | Number of resouce. | | <a id="resourcekind"></a>`kind` | | Name of resource. | | Name | Type | Description | | - | - | -- | | <a id="telemetrycompname"></a>`name` | | | | <a id="telemetrycompspec"></a>`spec` | | | | <a id="telemetrycompstatus"></a>`status` | | | 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 on `graphql.org`. Service Mesh Types. | Value | Description | | -- | -- | | <a id="meshtypeallmesh"></a>`ALLMESH` | All meshes that Meshery supports. | | <a id="meshtypeappmesh"></a>`APPMESH` | AWS App Mesh. | | <a id="meshtypeciliumservicemesh"></a>`CILIUMSERVICEMESH` | Cilium Service Mesh. | | <a id="meshtypecitrixservicemesh"></a>`CITRIXSERVICEMESH` | Citrix Service Mesh. | | <a id="meshtypeconsul"></a>`CONSUL` | Consul by HashiCorp. | | <a id="meshtypeinvalidmesh"></a>`INVALIDMESH` | 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="meshtypenetworkservicemesh"></a>`NETWORKSERVICEMESH` | Network Service Mesh. | | <a id="meshtypenginxservicemesh"></a>`NGINXSERVICEMESH` | NGINX Service Mesh. | | <a id="meshtypeoctarine"></a>`OCTARINE` | Octarine Mesh. | | <a id="meshtypeopenservicemesh"></a>`OPENSERVICEMESH` | Open Service

| | <a id="meshtypetanzu"></a>`TANZU` | VMware Tanzu Service Mesh. | | <a id="meshtypetraefikmesh"></a>`TRAEFIKMESH` | Traefik Mesh. | | Value | Description | | -- | -- | | <a id="mesherycontrollerbroker"></a>`BROKER` | | | <a id="mesherycontrollermeshsync"></a>`MESHSYNC` | | | <a id="mesherycontrolleroperator"></a>`OPERATOR` | | | Value | Description | | -- | -- | | <a id="mesherycontrollerstatusdeployed"></a>`DEPLOYED` | | | <a id="mesherycontrollerstatusdeploying"></a>`DEPLOYING` | | | <a id="mesherycontrollerstatusnotdeployed"></a>`NOTDEPLOYED` | | | <a id="mesherycontrollerstatusunkown"></a>`UNKOWN` | | | 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 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 on `graphql.org`. Represents `true` or `false` values. 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. Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. 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 on `graphql.org`. Input for changing Addon Status. | Name | Type | Description | | - | - | -- | | <a id="addonstatusinputk8scontextid"></a>`k8scontextID` | | kubernetes context ID. | | <a id="addonstatusinputselector"></a>`selector` | | Filter by Serice Mesh. | | <a id="addonstatusinputtargetstatus"></a>`targetStatus` | | Desired Status. | | Name | Type | Description | | - | - | -- | | <a id="catalogselectororder"></a>`order` | | | | <a id="catalogselectorpage"></a>`page` | | | | <a id="catalogselectorpagesize"></a>`page_size` | | | | <a id="catalogselectorsearch"></a>`search` | | | | Name | Type | Description | | - | - | -- | | <a id="meshmodelsummaryselectortype"></a>`type` | | | | Name | Type | Description | | - | - | -- | | <a id="pagefilterfrom"></a>`from` | | | | <a id="pagefilterorder"></a>`order` | | | | <a id="pagefilterpage"></a>`page` | | | | <a id="pagefilterpagesize"></a>`pageSize` | | | | <a id="pagefiltersearch"></a>`search` | | | | <a id="pagefilterto"></a>`to` | | | | <a id="pagefilterupdatedafter"></a>`updatedafter` | | | Type ReSyncActions define the actions involved during resync. | Name | Type | Description | | - | - | -- | | <a id="resyncactionsresync"></a>`ReSync` | | | | <a id="resyncactionscleardb"></a>`clearDB` | | | | <a id="resyncactionshardreset"></a>`hardReset` | | | Filter Control Plane Query. | Name | Type | Description | | - | - | -- | | <a id="servicemeshfilterk8sclusterids"></a>`k8sClusterIDs` | | | | <a id="servicemeshfiltertype"></a>`type` | | Filter by Service Mesh. |