GraphQL API Reference

<!--- 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!.

Arguments

Name	Type	Description
<a id="queryconnecttonatsk8scontextid"></a>k8scontextID	String!

Query.deployMeshsync

Check the Meshsync Status and deploy if not enabled.

Returns Status!.

Arguments

Name	Type	Description
<a id="querydeploymeshsynck8scontextid"></a>k8scontextID	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!.

Arguments

Name	Type	Description
<a id="queryfetchallresultsselector"></a>selector	PageFilter!

Query.fetchFilterCatalogContent

Query for getting Filter Catalog from remote provider.

Returns [CatalogFilter!]!.

Arguments

Name	Type	Description
<a id="queryfetchfiltercatalogcontentselector"></a>selector	CatalogSelector

Query.fetchPatternCatalogContent

Query for getting Pattern Catalog from remote provider.

Returns [CatalogPattern!]!.

Arguments

Name	Type	Description
<a id="queryfetchpatterncatalogcontentselector"></a>selector	CatalogSelector

Query.fetchPatterns

Query for fetching all patterns with selector.

Returns PatternPageResult!.

Arguments

Name	Type	Description
<a id="queryfetchpatternsselector"></a>selector	PageFilter!

Query.fetchResults

Query for fetching all results for profile ID.

Returns PerfPageResult!.

Arguments

Name	Type	Description
<a id="queryfetchresultsprofileid"></a>profileID	String!
<a id="queryfetchresultsselector"></a>selector	PageFilter!

Query.fetchTelemetryComponents

Query for telemetry components.

Returns [TelemetryComp]!.

Arguments

Name	Type	Description
<a id="queryfetchtelemetrycomponentscontexts"></a>contexts	[String!]

Query.getAvailableAddons

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

Returns [AddonList!]!.

Arguments

Name	Type	Description
<a id="querygetavailableaddonsfilter"></a>filter	ServiceMeshFilter	Select Mesh Type.

Query.getAvailableNamespaces

Query available Namesapces in your cluster.

Returns [NameSpace!]!.

Arguments

Name	Type	Description
<a id="querygetavailablenamespacesk8sclusterids"></a>k8sClusterIDs	[String!]

Query.getClusterResources

Query for getting cluster info.

Returns ClusterResources!.

Arguments

Name	Type	Description
<a id="querygetclusterresourcesk8scontextids"></a>k8scontextIDs	[String!]
<a id="querygetclusterresourcesnamespace"></a>namespace	String!

Query.getControlPlanes

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

Returns [ControlPlane!]!.

Arguments

Name	Type	Description
<a id="querygetcontrolplanesfilter"></a>filter	ServiceMeshFilter	Filter Control Plane Query.

Query.getDataPlanes

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

Returns [DataPlane!]!.

Arguments

Name	Type	Description
<a id="querygetdataplanesfilter"></a>filter	ServiceMeshFilter	Filter Control Plane Query.

Query.getKubectlDescribe

Query for getting kubectl describe details with meshkit.

Returns KctlDescribeDetails!.

Arguments

Name	Type	Description
<a id="querygetkubectldescribekind"></a>kind	String!
<a id="querygetkubectldescribename"></a>name	String!
<a id="querygetkubectldescribenamespace"></a>namespace	String!

Query.getMeshModelSummary

Query for meshmodel summary.

Returns MeshModelSummary!.

Arguments

Name	Type	Description
<a id="querygetmeshmodelsummaryselector"></a>selector	MeshModelSummarySelector!

Query.getMeshsyncStatus

Check the Meshsync Status.

Returns OperatorControllerStatus!.

Arguments

Name	Type	Description
<a id="querygetmeshsyncstatusk8scontextid"></a>k8scontextID	String!

Query.getNatsStatus

Check is Meshey Server is connected to NATS.

Returns OperatorControllerStatus!.

Arguments

Name	Type	Description
<a id="querygetnatsstatusk8scontextid"></a>k8scontextID	String!

Query.getOperatorStatus

Query status of Meshery Operator in your cluster.

Returns OperatorStatus.

Arguments

Name	Type	Description
<a id="querygetoperatorstatusk8scontextid"></a>k8scontextID	String!

Query.getPerfResult

Query for performance result.

Returns MesheryResult.

Arguments

Name	Type	Description
<a id="querygetperfresultid"></a>id	ID!

Query.getPerformanceProfiles

Query for fetching all results for profile ID.

Returns PerfPageProfiles!.

Arguments

Name	Type	Description
<a id="querygetperformanceprofilesselector"></a>selector	PageFilter!

Query.resyncCluster

Query to resync the cluster discovery.

Returns Status!.

Arguments

Name	Type	Description
<a id="queryresyncclusterk8scontextid"></a>k8scontextID	String!
<a id="queryresyncclusterselector"></a>selector	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!	Name of the adapter to be deployed.
<a id="mutationchangeadapterstatustargetport"></a>targetPort	String!	The port on which adapter will be deployed.
<a id="mutationchangeadapterstatustargetstatus"></a>targetStatus	Status!	Desired status for Meshery Operator.

Returns Status!.

Mutation.changeOperatorStatus

Change the Operator Status.

Input type: OperatorStatusInput

Arguments

Name	Type	Description
<a id="mutationchangeoperatorstatuscontextid"></a>contextID	String!
<a id="mutationchangeoperatorstatustargetstatus"></a>targetStatus	Status!	Desired status for Meshery Operator.

Returns 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!]!.

Arguments

Name	Type	Description
<a id="subscriptionlistentoaddonstatefilter"></a>filter	ServiceMeshFilter	Select Mesh Type.

Subscription.listenToControlPlaneState

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

Returns [ControlPlane!]!.

Arguments

Name	Type	Description
<a id="subscriptionlistentocontrolplanestatefilter"></a>filter	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!]!.

Arguments

Name	Type	Description
<a id="subscriptionlistentodataplanestatefilter"></a>filter	ServiceMeshFilter	Filter Control Plane Query.

Subscription.listenToMeshSyncEvents

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

Returns OperatorControllerStatusPerK8sContext.

Arguments

Name	Type	Description
<a id="subscriptionlistentomeshsynceventsk8scontextids"></a>k8scontextIDs	[String!]

Subscription.listenToOperatorState

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

Returns OperatorStatusPerK8sContext.

Arguments

Name	Type	Description
<a id="subscriptionlistentooperatorstatek8scontextids"></a>k8scontextIDs	[String!]

Subscription.subscribeBrokerConnection

Listen to changes in Broker (NATS) Connection.

Returns Boolean!.

Subscription.subscribeClusterResources

Returns ClusterResources!.

Arguments

Name	Type	Description
<a id="subscriptionsubscribeclusterresourcesk8scontextids"></a>k8scontextIDs	[String!]
<a id="subscriptionsubscribeclusterresourcesnamespace"></a>namespace	String!

Subscription.subscribeConfiguration

Returns ConfigurationPage!.

Arguments

Name	Type	Description
<a id="subscriptionsubscribeconfigurationapplicationselector"></a>applicationSelector	PageFilter!
<a id="subscriptionsubscribeconfigurationfilterselector"></a>filterSelector	PageFilter!
<a id="subscriptionsubscribeconfigurationpatternselector"></a>patternSelector	PageFilter!

Subscription.subscribeK8sContext

Returns K8sContextsPage!.

Arguments

Name	Type	Description
<a id="subscriptionsubscribek8scontextselector"></a>selector	PageFilter!

Subscription.subscribeMeshModelSummary

Returns MeshModelSummary!.

Arguments

Name	Type	Description
<a id="subscriptionsubscribemeshmodelsummaryselector"></a>selector	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!.

Arguments

Name	Type	Description
<a id="subscriptionsubscribemeshsynceventsk8scontextids"></a>k8scontextIDs	[String!]

Subscription.subscribeMesheryControllersStatus

Listen to changes in the status of meshery controllers.

Returns [MesheryControllersStatusListItem!]!.

Arguments

Name	Type	Description
<a id="subscriptionsubscribemesherycontrollersstatusk8scontextids"></a>k8scontextIDs	[String!]

Subscription.subscribePerfProfiles

Listen to changes in Performance Profiles.

Returns PerfPageProfiles!.

Arguments

Name	Type	Description
<a id="subscriptionsubscribeperfprofilesselector"></a>selector	PageFilter!

Subscription.subscribePerfResults

Listen to all results for profile ID.

Returns PerfPageResult!.

Arguments

Name	Type	Description
<a id="subscriptionsubscribeperfresultsprofileid"></a>profileID	String!
<a id="subscriptionsubscribeperfresultsselector"></a>selector	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 (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 on graphql.org.

AddonList

Details about the Addon Component.

Fields

Name	Type	Description
<a id="addonlistname"></a>name	String!	Name.
<a id="addonlistowner"></a>owner	String!	Owner.

ApplicationPage

Fields

Name	Type	Description
<a id="applicationpageapplications"></a>applications	[ApplicationResult]
<a id="applicationpagepage"></a>page	Int!
<a id="applicationpagepage_size"></a>page_size	Int!
<a id="applicationpagetotal_count"></a>total_count	Int!

ApplicationResult

Fields

Name	Type	Description
<a id="applicationresultapplication_file"></a>application_file	String!
<a id="applicationresultcreated_at"></a>created_at	String
<a id="applicationresultid"></a>id	ID!
<a id="applicationresultlocation"></a>location	Location!
<a id="applicationresultname"></a>name	String!
<a id="applicationresulttype"></a>type	NullString!
<a id="applicationresultupdated_at"></a>updated_at	String
<a id="applicationresultuser_id"></a>user_id	String!
<a id="applicationresultvisibility"></a>visibility	String!

CatalogFilter

Fields

Name	Type	Description
<a id="catalogfiltercatalog_data"></a>catalog_data	Map
<a id="catalogfiltercreated_at"></a>created_at	String
<a id="catalogfilterfilter_file"></a>filter_file	String!
<a id="catalogfilterid"></a>id	ID!
<a id="catalogfilterlocation"></a>location	Location!
<a id="catalogfiltername"></a>name	String!
<a id="catalogfilterupdated_at"></a>updated_at	String
<a id="catalogfilteruser_id"></a>user_id	String!
<a id="catalogfiltervisibility"></a>visibility	String!

CatalogPattern

Fields

Name	Type	Description
<a id="catalogpatterncatalog_data"></a>catalog_data	Map
<a id="catalogpatterncreated_at"></a>created_at	String
<a id="catalogpatternid"></a>id	ID!
<a id="catalogpatternlocation"></a>location	Location!
<a id="catalogpatternname"></a>name	String!
<a id="catalogpatternpattern_file"></a>pattern_file	String!
<a id="catalogpatternupdated_at"></a>updated_at	String
<a id="catalogpatternuser_id"></a>user_id	String!
<a id="catalogpatternvisibility"></a>visibility	String!

ClusterResources

Details about discovered workloads.

Fields

Name	Type	Description
<a id="clusterresourcesresources"></a>resources	[Resource!]!

ConfigurationPage

Fields

Name	Type	Description
<a id="configurationpageapplications"></a>applications	ApplicationPage
<a id="configurationpagefilters"></a>filters	FilterPage
<a id="configurationpagepatterns"></a>patterns	PatternPageResult

Container

Fields

Name	Type	Description
<a id="containercontainername"></a>containerName	String!
<a id="containercontrolplanemembername"></a>controlPlaneMemberName	String!
<a id="containerimage"></a>image	String!
<a id="containerports"></a>ports	[Container_Port]	args: NOT IMPLEMENTED.
<a id="containerresources"></a>resources	Any	env: NOT IMPLEMENTED,.
<a id="containerstatus"></a>status	Container_Status

Container_Port

Fields

Name	Type	Description
<a id="container_portcontainerport"></a>containerPort	Int!
<a id="container_portname"></a>name	String
<a id="container_portprotocol"></a>protocol	String!

Container_Status

Fields

Name	Type	Description
<a id="container_statuscontainerid"></a>containerID	Any
<a id="container_statuscontainerstatusname"></a>containerStatusName	String!
<a id="container_statusimage"></a>image	String!
<a id="container_statusimageid"></a>imageID	Any
<a id="container_statuslaststate"></a>lastState	Any
<a id="container_statusready"></a>ready	Boolean!
<a id="container_statusrestartcount"></a>restartCount	Any
<a id="container_statusstarted"></a>started	Boolean!	image: String! imageID: String! containerID: String!.
<a id="container_statusstate"></a>state	Any

ControlPlane

Control Plane data for a particular Mesh.

Fields

Name	Type	Description
<a id="controlplanemembers"></a>members	[ControlPlaneMember!]!	Members of the Mesh.
<a id="controlplanename"></a>name	String!	Service Mesh Name.

ControlPlaneMember

Member Details.

Fields

Name	Type	Description
<a id="controlplanemembercomponent"></a>component	String!	Component.
<a id="controlplanememberdata_planes"></a>data_planes	[Container!]	DataPlanes.
<a id="controlplanemembername"></a>name	String!	Name.
<a id="controlplanemembernamespace"></a>namespace	String!	Namespace.
<a id="controlplanememberversion"></a>version	String!	Version.

DataPlane

Data Plane for a particular Mesh.

Fields

Name	Type	Description
<a id="dataplanename"></a>name	String!	Service Mesh Name.
<a id="dataplaneproxies"></a>proxies	[Container!]!	Members of the Mesh.

Error

Fields

Name	Type	Description
<a id="errorcode"></a>code	String!	Error Code.
<a id="errordescription"></a>description	String!	Error Details.

FilterPage

Fields

Name	Type	Description
<a id="filterpagefilters"></a>filters	[FilterResult]
<a id="filterpagepage"></a>page	Int!
<a id="filterpagepage_size"></a>page_size	Int!
<a id="filterpagetotal_count"></a>total_count	Int!

FilterResult

Fields

Name	Type	Description
<a id="filterresultcatalog_data"></a>catalog_data	Map
<a id="filterresultcreated_at"></a>created_at	String
<a id="filterresultfilter_file"></a>filter_file	String!
<a id="filterresultid"></a>id	ID!
<a id="filterresultlocation"></a>location	Location!
<a id="filterresultname"></a>name	String!
<a id="filterresultupdated_at"></a>updated_at	String
<a id="filterresultuser_id"></a>user_id	String!
<a id="filterresultvisibility"></a>visibility	String!

K8sContext

Fields

Name	Type	Description
<a id="k8scontextauth"></a>auth	Map!
<a id="k8scontextcluster"></a>cluster	Map!
<a id="k8scontextcreated_at"></a>created_at	String!
<a id="k8scontextcreated_by"></a>created_by	ID!
<a id="k8scontextdeployment_type"></a>deployment_type	String!
<a id="k8scontextid"></a>id	String!
<a id="k8scontextkubernetes_server_id"></a>kubernetes_server_id	ID!
<a id="k8scontextmeshery_instance_id"></a>meshery_instance_id	ID!
<a id="k8scontextname"></a>name	String!
<a id="k8scontextowner"></a>owner	ID!
<a id="k8scontextserver"></a>server	String!
<a id="k8scontextupdated_at"></a>updated_at	String!
<a id="k8scontextversion"></a>version	String!

K8sContextsPage

Fields

Name	Type	Description
<a id="k8scontextspagecontexts"></a>contexts	[K8sContext]!
<a id="k8scontextspagetotal_count"></a>total_count	Int!

KctlDescribeDetails

Fields

Name	Type	Description
<a id="kctldescribedetailsctxid"></a>ctxid	String
<a id="kctldescribedetailsdescribe"></a>describe	String

Location

Fields

Name	Type	Description
<a id="locationbranch"></a>branch	String
<a id="locationhost"></a>host	String
<a id="locationpath"></a>path	String
<a id="locationtype"></a>type	String

MeshModelComponent

Fields

Name	Type	Description
<a id="meshmodelcomponentcount"></a>count	Int!
<a id="meshmodelcomponentname"></a>name	String!

MeshModelRelationship

Fields

Name	Type	Description
<a id="meshmodelrelationshipcount"></a>count	Int!
<a id="meshmodelrelationshipname"></a>name	String!

MeshModelSummary

Type MeshModelComponentsSummary define the summary of a Mesh Model.

Fields

Name	Type	Description
<a id="meshmodelsummarycomponents"></a>components	[MeshModelComponent!]
<a id="meshmodelsummaryrelationships"></a>relationships	[MeshModelRelationship!]

MeshSyncEvent

Fields

Name	Type	Description
<a id="meshsynceventcontextid"></a>contextId	String!
<a id="meshsynceventobject"></a>object	Any!
<a id="meshsynceventtype"></a>type	String!

MesheryControllersStatusListItem

Fields

Name	Type	Description
<a id="mesherycontrollersstatuslistitemcontextid"></a>contextId	String!
<a id="mesherycontrollersstatuslistitemcontroller"></a>controller	MesheryController!
<a id="mesherycontrollersstatuslistitemstatus"></a>status	MesheryControllerStatus!

MesheryResult

Fields

Name	Type	Description
<a id="mesheryresultcreated_at"></a>created_at	String
<a id="mesheryresultmesh"></a>mesh	String
<a id="mesheryresultmeshery_id"></a>meshery_id	String
<a id="mesheryresultname"></a>name	String
<a id="mesheryresultperformance_profile"></a>performance_profile	String
<a id="mesheryresultrunner_results"></a>runner_results	Map
<a id="mesheryresultserver_board_config"></a>server_board_config	String
<a id="mesheryresultserver_metrics"></a>server_metrics	String
<a id="mesheryresulttest_id"></a>test_id	String
<a id="mesheryresulttest_start_time"></a>test_start_time	String
<a id="mesheryresultupdated_at"></a>updated_at	String
<a id="mesheryresultuser_id"></a>user_id	String

NameSpace

Type to define a k8s Namespace.

Fields

Name	Type	Description
<a id="namespacenamespace"></a>namespace	String!	Namespace Name.

NullString

Fields

Name	Type	Description
<a id="nullstringstring"></a>String	String!
<a id="nullstringvalid"></a>Valid	Boolean!

OAMCapability

Fields

Name	Type	Description
<a id="oamcapabilityhost"></a>host	String
<a id="oamcapabilityid"></a>id	String
<a id="oamcapabilitymetadata"></a>metadata	Any
<a id="oamcapabilityoam_definition"></a>oam_definition	Any
<a id="oamcapabilityoam_ref_schema"></a>oam_ref_schema	String
<a id="oamcapabilityrestricted"></a>restricted	Boolean

OperatorControllerStatus

Controllers of Meshery Operator.

Fields

Name	Type	Description
<a id="operatorcontrollerstatuscontextid"></a>contextID	String!
<a id="operatorcontrollerstatuserror"></a>error	Error	Controller Error Log.
<a id="operatorcontrollerstatusname"></a>name	String!	Controller Name.
<a id="operatorcontrollerstatusstatus"></a>status	Status!	Controller Status.
<a id="operatorcontrollerstatusversion"></a>version	String!	Controller Version.

OperatorControllerStatusPerK8sContext

Fields

Name	Type	Description
<a id="operatorcontrollerstatusperk8scontextoperatorcontrollerstatus"></a>OperatorControllerStatus	OperatorControllerStatus!
<a id="operatorcontrollerstatusperk8scontextcontextid"></a>contextID	String!

OperatorStatus

Status of Meshery Operator and its controllers.

Fields

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

OperatorStatusPerK8sContext

Fields

Name	Type	Description
<a id="operatorstatusperk8scontextcontextid"></a>contextID	String!
<a id="operatorstatusperk8scontextoperatorstatus"></a>operatorStatus	OperatorStatus!

PatternPageResult

Fields

Name	Type	Description
<a id="patternpageresultpage"></a>page	Int!
<a id="patternpageresultpage_size"></a>page_size	Int!
<a id="patternpageresultpatterns"></a>patterns	[PatternResult]
<a id="patternpageresulttotal_count"></a>total_count	Int!

PatternResult

Fields

Name	Type	Description
<a id="patternresultcansupport"></a>canSupport	Boolean!
<a id="patternresultcatalog_data"></a>catalog_data	Map
<a id="patternresultcreated_at"></a>created_at	String
<a id="patternresulterrmsg"></a>errmsg	String
<a id="patternresultid"></a>id	ID!
<a id="patternresultlocation"></a>location	Location!
<a id="patternresultname"></a>name	String!
<a id="patternresultpattern_file"></a>pattern_file	String!
<a id="patternresultupdated_at"></a>updated_at	String
<a id="patternresultuser_id"></a>user_id	String!
<a id="patternresultvisibility"></a>visibility	String!

PerfPageProfiles

Fields

Name	Type	Description
<a id="perfpageprofilespage"></a>page	Int!
<a id="perfpageprofilespage_size"></a>page_size	Int!
<a id="perfpageprofilesprofiles"></a>profiles	[PerfProfile]
<a id="perfpageprofilestotal_count"></a>total_count	Int!

PerfPageResult

Fields

Name	Type	Description
<a id="perfpageresultpage"></a>page	Int!
<a id="perfpageresultpage_size"></a>page_size	Int!
<a id="perfpageresultresults"></a>results	[MesheryResult]
<a id="perfpageresulttotal_count"></a>total_count	Int!

PerfProfile

Fields

Name	Type	Description
<a id="perfprofileconcurrent_request"></a>concurrent_request	Int!
<a id="perfprofilecontent_type"></a>content_type	String
<a id="perfprofilecreated_at"></a>created_at	String
<a id="perfprofileduration"></a>duration	String!
<a id="perfprofileendpoints"></a>endpoints	[String]
<a id="perfprofileid"></a>id	String!
<a id="perfprofilelast_run"></a>last_run	String
<a id="perfprofileload_generators"></a>load_generators	[String]
<a id="perfprofilename"></a>name	String
<a id="perfprofileqps"></a>qps	Int
<a id="perfprofilerequest_body"></a>request_body	String
<a id="perfprofilerequest_cookies"></a>request_cookies	String
<a id="perfprofilerequest_headers"></a>request_headers	String
<a id="perfprofileservice_mesh"></a>service_mesh	String
<a id="perfprofiletotal_results"></a>total_results	Int
<a id="perfprofileupdated_at"></a>updated_at	String
<a id="perfprofileuser_id"></a>user_id	String!

Resource

Fields

Name	Type	Description
<a id="resourcecount"></a>count	Int!	Number of resouce.
<a id="resourcekind"></a>kind	String!	Name of resource.

TelemetryComp

Fields

Name	Type	Description
<a id="telemetrycompname"></a>name	String!
<a id="telemetrycompspec"></a>spec	String!
<a id="telemetrycompstatus"></a>status	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 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 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 on graphql.org.

AddonStatusInput

Input for changing Addon Status.

Arguments

Name	Type	Description
<a id="addonstatusinputk8scontextid"></a>k8scontextID	String!	kubernetes context ID.
<a id="addonstatusinputselector"></a>selector	MeshType	Filter by Serice Mesh.
<a id="addonstatusinputtargetstatus"></a>targetStatus	Status!	Desired Status.

CatalogSelector

Arguments

Name	Type	Description
<a id="catalogselectororder"></a>order	String!
<a id="catalogselectorpage"></a>page	String!
<a id="catalogselectorpagesize"></a>page_size	String!
<a id="catalogselectorsearch"></a>search	String!

MeshModelSummarySelector

Arguments

Name	Type	Description
<a id="meshmodelsummaryselectortype"></a>type	String!

PageFilter

Arguments

Name	Type	Description
<a id="pagefilterfrom"></a>from	String
<a id="pagefilterorder"></a>order	String
<a id="pagefilterpage"></a>page	String!
<a id="pagefilterpagesize"></a>pageSize	String!
<a id="pagefiltersearch"></a>search	String
<a id="pagefilterto"></a>to	String
<a id="pagefilterupdated_after"></a>updated_after	String

ReSyncActions

Type ReSyncActions define the actions involved during resync.

Arguments

Name	Type	Description
<a id="resyncactionsresync"></a>ReSync	String!
<a id="resyncactionscleardb"></a>clearDB	String!
<a id="resyncactionshardreset"></a>hardReset	String!

ServiceMeshFilter

Filter Control Plane Query.

Arguments

Name	Type	Description
<a id="servicemeshfilterk8sclusterids"></a>k8sClusterIDs	[String!]
<a id="servicemeshfiltertype"></a>type	MeshType	Filter by Service Mesh.