Clusters and infrastructure

GraphQL schema reference · API guide · SDKs

Clusters, the marketplace, subscriptions and invites, edge enrollment, nodes, services, and orchestrators.

Types used by more than one domain are on Shared types.

Queries

Query.cluster

Fetch a single cluster by ID.

cluster(
  id: ID!
): Cluster

Returns: Cluster (Cluster)

Arguments

id: ID! — The cluster ID.

SDK

Operation	Selects	TypeScript	Go	Python
GetCluster	`cluster`	`GetClusterDocument`	`GetCluster`	`get_cluster`
GetClusterNodesConnection	`cluster.nodesConnection`	`GetClusterNodesConnectionDocument`	`GetClusterNodesConnection`	`get_cluster_nodes_connection`

Query.clusterInvites

Deprecated: Use clusterInvitesConnection instead

List invites for a cluster.

clusterInvites(
  clusterId: ID!
): [ClusterInvite!]!

Returns: [ClusterInvite!]! (ClusterInvite)

Arguments

clusterId: ID!

SDK: none; deprecated fields get no generated operation. Use the replacement the deprecation names, or send a GraphQL document through the SDK’s raw client.

Query.clusterInvitesConnection

List invites for a cluster (paginated).

clusterInvitesConnection(
  page: ConnectionInput
  clusterId: ID!
): ClusterInviteConnection!

Returns: ClusterInviteConnection! (ClusterInviteConnection)

Arguments

page: ConnectionInput (ConnectionInput) — Pagination options.
clusterId: ID! — The cluster ID.

SDK

Operation	TypeScript	Go	Python
GetClusterInvitesConnection	`GetClusterInvitesConnectionDocument`	`GetClusterInvitesConnection`	`get_cluster_invites_connection`

Query.clustersAccess

Deprecated: Use clustersAccessConnection instead

List clusters the tenant has access to.

clustersAccess(
  first: Int = 50
  after: String
): [ClusterAccess!]

Returns: [ClusterAccess!] (ClusterAccess)

Arguments

first: Int (default 50)
after: String

SDK: none; deprecated fields get no generated operation. Use the replacement the deprecation names, or send a GraphQL document through the SDK’s raw client.

Query.clustersAccessConnection

List clusters the tenant has access to (paginated).

clustersAccessConnection(
  page: ConnectionInput
): ClusterAccessConnection!

Returns: ClusterAccessConnection! (ClusterAccessConnection)

Arguments

page: ConnectionInput (ConnectionInput)

SDK

Operation	TypeScript	Go	Python
GetClustersAccessConnection	`GetClustersAccessConnectionDocument`	`GetClustersAccessConnection`	`get_clusters_access_connection`

Query.clustersAvailable

Deprecated: Use clustersAvailableConnection instead

List available clusters for subscription.

clustersAvailable(
  first: Int = 50
  after: String
): [AvailableCluster!]

Returns: [AvailableCluster!] (AvailableCluster)

Arguments

first: Int (default 50)
after: String

SDK: none; deprecated fields get no generated operation. Use the replacement the deprecation names, or send a GraphQL document through the SDK’s raw client.

Query.clustersAvailableConnection

List available clusters for subscription (paginated).

clustersAvailableConnection(
  page: ConnectionInput
): AvailableClusterConnection!

Returns: AvailableClusterConnection! (AvailableClusterConnection)

Arguments

page: ConnectionInput (ConnectionInput)

SDK

Operation	TypeScript	Go	Python
GetClustersAvailableConnection	`GetClustersAvailableConnectionDocument`	`GetClustersAvailableConnection`	`get_clusters_available_connection`

Query.clustersConnection

List clusters the tenant has access to.

clustersConnection(
  page: ConnectionInput
): ClustersConnection!

Returns: ClustersConnection! (ClustersConnection)

Arguments

page: ConnectionInput (ConnectionInput) — Pagination options.

SDK

Operation	TypeScript	Go	Python
GetClustersConnection	`GetClustersConnectionDocument`	`GetClustersConnection`	`get_clusters_connection`

Query.discoverServicesConnection

Discover service instances by type.

discoverServicesConnection(
  page: ConnectionInput
  type: String!
  clusterId: String
): ServiceInstancesConnection!

Returns: ServiceInstancesConnection! (ServiceInstancesConnection)

Arguments

page: ConnectionInput (ConnectionInput) — Pagination options.
type: String! — Service type to discover (e.g., mistserver, foghorn).
clusterId: String — Filter by cluster ID.

SDK

Operation	TypeScript	Go	Python
GetDiscoverServicesConnection	`GetDiscoverServicesConnectionDocument`	`GetDiscoverServicesConnection`	`get_discover_services_connection`

Query.marketplaceCluster

Get details for a specific marketplace cluster.

marketplaceCluster(
  clusterId: String!
): MarketplaceCluster

Returns: MarketplaceCluster (MarketplaceCluster)

Arguments

clusterId: String! — The cluster ID.

SDK

Operation	TypeScript	Go	Python
GetMarketplaceCluster	`GetMarketplaceClusterDocument`	`GetMarketplaceCluster`	`get_marketplace_cluster`

Query.marketplaceClusters

Deprecated: Use marketplaceClustersConnection instead

List clusters available in the marketplace.

marketplaceClusters(
  first: Int = 50
  after: String
): [MarketplaceCluster!]!

Returns: [MarketplaceCluster!]! (MarketplaceCluster)

Arguments

first: Int (default 50)
after: String

SDK: none; deprecated fields get no generated operation. Use the replacement the deprecation names, or send a GraphQL document through the SDK’s raw client.

Query.marketplaceClustersConnection

List clusters available in the marketplace (paginated).

marketplaceClustersConnection(
  page: ConnectionInput
): MarketplaceClusterConnection!

Returns: MarketplaceClusterConnection! (MarketplaceClusterConnection)

Arguments

page: ConnectionInput (ConnectionInput) — Pagination options.

SDK

Operation	TypeScript	Go	Python
GetMarketplaceClustersConnection	`GetMarketplaceClustersConnectionDocument`	`GetMarketplaceClustersConnection`	`get_marketplace_clusters_connection`

Query.myClusterInvites

Deprecated: Use myClusterInvitesConnection instead

List cluster invites sent to the current tenant.

myClusterInvites: [ClusterInvite!]!

Returns: [ClusterInvite!]! (ClusterInvite)

SDK: none; deprecated fields get no generated operation. Use the replacement the deprecation names, or send a GraphQL document through the SDK’s raw client.

Query.myClusterInvitesConnection

List cluster invites sent to the current tenant (paginated).

myClusterInvitesConnection(
  page: ConnectionInput
): ClusterInviteConnection!

Returns: ClusterInviteConnection! (ClusterInviteConnection)

Arguments

page: ConnectionInput (ConnectionInput)

SDK

Operation	TypeScript	Go	Python
GetMyClusterInvitesConnection	`GetMyClusterInvitesConnectionDocument`	`GetMyClusterInvitesConnection`	`get_my_cluster_invites_connection`

Query.mySubscriptions

Deprecated: Use mySubscriptionsConnection instead

List clusters the tenant is subscribed to.

mySubscriptions(
  first: Int = 50
  after: String
): [Cluster!]!

Returns: [Cluster!]! (Cluster)

Arguments

first: Int (default 50)
after: String

SDK: none; deprecated fields get no generated operation. Use the replacement the deprecation names, or send a GraphQL document through the SDK’s raw client.

Query.mySubscriptionsConnection

List clusters the tenant is subscribed to (paginated).

mySubscriptionsConnection(
  page: ConnectionInput
): MySubscriptionsConnection!

Returns: MySubscriptionsConnection! (MySubscriptionsConnection)

Arguments

page: ConnectionInput (ConnectionInput)

SDK

Operation	TypeScript	Go	Python
GetMySubscriptionsConnection	`GetMySubscriptionsConnectionDocument`	`GetMySubscriptionsConnection`	`get_my_subscriptions_connection`

Query.nodesConnection

List nodes (edge servers) with optional filters.

nodesConnection(
  page: ConnectionInput
  clusterId: String
  status: NodeStatus
  type: String
): NodesConnection!

Returns: NodesConnection! (NodesConnection)

Arguments

page: ConnectionInput (ConnectionInput) — Pagination options.
clusterId: String — Filter by cluster ID.
status: NodeStatus (NodeStatus) — Filter by node status.
type: String — Filter by node type.

SDK

Operation	TypeScript	Go	Python
GetNodesConnection	`GetNodesConnectionDocument`	`GetNodesConnection`	`get_nodes_connection`

Query.orchestrator

Fetch a public orchestrator with every known instance and per-(gateway, instance) vantage. Side-panel data source for the federation map.

orchestrator(
  orchAddr: String!
): OrchestratorWithDetails

Returns: OrchestratorWithDetails (OrchestratorWithDetails)

Arguments

orchAddr: String! — The orchestrator’s eth address (hex).

SDK

Operation	TypeScript	Go	Python
GetOrchestrator	`GetOrchestratorDocument`	`GetOrchestrator`	`get_orchestrator`

Query.orchestratorInstances

List public per-instance rows. Each carries its own price/capabilities/hardware — usually consistent across an orch’s pool but not guaranteed. Use the optional orchAddr filter to scope to one orch.

orchestratorInstances(
  orchAddr: String
): [OrchestratorInstance!]!

Returns: [OrchestratorInstance!]! (OrchestratorInstance)

Arguments

orchAddr: String

SDK

Operation	TypeScript	Go	Python
GetOrchestratorInstances	`GetOrchestratorInstancesDocument`	`GetOrchestratorInstances`	`get_orchestrator_instances`

Query.orchestratorPerformanceSeries

Time-series performance points for an orchestrator from the discovery rollups (5m or 1h). meanLatencyMs is server-pre-computed; callers don’t divide latency_sum/latency_count themselves.

orchestratorPerformanceSeries(
  orchAddr: String!
  timeRange: TimeRangeInput!
  interval: String
  gatewayId: String
  resolvedIp: String
): [OrchestratorPerformancePoint!]!

Returns: [OrchestratorPerformancePoint!]! (OrchestratorPerformancePoint)

Arguments

orchAddr: String!
timeRange: TimeRangeInput! (TimeRangeInput)
interval: String — Rollup interval. “5m” (default) or “1h”.
gatewayId: String — Optional drill-down filters.
resolvedIp: String

SDK

Operation	TypeScript	Go	Python
GetOrchestratorPerformanceSeries	`GetOrchestratorPerformanceSeriesDocument`	`GetOrchestratorPerformanceSeries`	`get_orchestrator_performance_series`

Query.orchestratorVantages

List per-(gateway, instance) vantage observations. Multi-region observation surfaces here as multiple rows. Use the optional orchAddr filter to scope to one orchestrator.

orchestratorVantages(
  orchAddr: String
): [OrchestratorVantage!]!

Returns: [OrchestratorVantage!]! (OrchestratorVantage)

Arguments

orchAddr: String

SDK

Operation	TypeScript	Go	Python
GetOrchestratorVantages	`GetOrchestratorVantagesDocument`	`GetOrchestratorVantages`	`get_orchestrator_vantages`

Query.orchestratorsConnection

List orchestrators discovered by Livepeer gateways under this cluster owner tenant. Federation-map data source. Vantage-independent; the per-region table comes from orchestratorVantages.

orchestratorsConnection(
  page: ConnectionInput
  orchAddr: String
): OrchestratorsConnection!

Returns: OrchestratorsConnection! (OrchestratorsConnection)

Arguments

page: ConnectionInput (ConnectionInput) — Pagination options.
orchAddr: String — Optional filter to a single orchestrator (eth address).

SDK

Operation	TypeScript	Go	Python
GetOrchestratorsConnection	`GetOrchestratorsConnectionDocument`	`GetOrchestratorsConnection`	`get_orchestrators_connection`

Query.pendingSubscriptions

Deprecated: Use pendingSubscriptionsConnection instead

List pending subscription requests for a cluster.

pendingSubscriptions(
  clusterId: ID!
): [ClusterSubscription!]!

Returns: [ClusterSubscription!]! (ClusterSubscription)

Arguments

clusterId: ID!

SDK: none; deprecated fields get no generated operation. Use the replacement the deprecation names, or send a GraphQL document through the SDK’s raw client.

Query.pendingSubscriptionsConnection

List pending subscription requests (paginated).

pendingSubscriptionsConnection(
  page: ConnectionInput
  clusterId: ID!
): ClusterSubscriptionConnection!

Returns: ClusterSubscriptionConnection! (ClusterSubscriptionConnection)

Arguments

page: ConnectionInput (ConnectionInput) — Pagination options.
clusterId: ID! — The cluster ID.

SDK

Operation	TypeScript	Go	Python
GetPendingSubscriptionsConnection	`GetPendingSubscriptionsConnectionDocument`	`GetPendingSubscriptionsConnection`	`get_pending_subscriptions_connection`

Query.serviceInstancesHealth

Check health status of service instances for owned infrastructure.

serviceInstancesHealth(
  serviceId: String
): [ServiceInstanceHealth!]

Returns: [ServiceInstanceHealth!] (ServiceInstanceHealth)

Arguments

serviceId: String — Filter by service ID.

SDK

Operation	TypeScript	Go	Python
GetServiceInstancesHealth	`GetServiceInstancesHealthDocument`	`GetServiceInstancesHealth`	`get_service_instances_health`

Mutations

Mutation.acceptClusterInvite

Accept a cluster invite.

acceptClusterInvite(
  inviteToken: String!
): ClusterSubscriptionResult!

Returns: ClusterSubscriptionResult! (ClusterSubscriptionResult)

Arguments

inviteToken: String! — The invite token.

SDK

Operation	TypeScript	Go	Python
AcceptClusterInvite	`AcceptClusterInviteDocument`	`AcceptClusterInvite`	`accept_cluster_invite`

Mutation.acknowledgeIncident

Acknowledge an incident. The incident stays open until its alerts resolve or someone resolves it.

acknowledgeIncident(
  id: ID!
): IncidentMutationResult!

Returns: IncidentMutationResult! (IncidentMutationResult)

Arguments

id: ID!

SDK

Operation	TypeScript	Go	Python
AcknowledgeIncident	`AcknowledgeIncidentDocument`	`AcknowledgeIncident`	`acknowledge_incident`

Mutation.approveClusterSubscription

Approve a pending cluster subscription request.

approveClusterSubscription(
  subscriptionId: ID!
): ClusterSubscriptionResult!

Returns: ClusterSubscriptionResult! (ClusterSubscriptionResult)

Arguments

subscriptionId: ID! — The subscription ID to approve.

SDK

Operation	TypeScript	Go	Python
ApproveClusterSubscription	`ApproveClusterSubscriptionDocument`	`ApproveClusterSubscription`	`approve_cluster_subscription`

Mutation.bootstrapEdge

Bootstrap a new edge using only an opaque bootstrap token. Public — the bootstrap token is itself the credential. Bridge resolves the token’s cluster via Quartermaster, finds the cluster’s assigned Foghorn, and proxies a PreRegisterEdge call so the operator never has to know cluster topology.

bootstrapEdge(
  input: BootstrapEdgeInput!
): BootstrapEdgeResult!

Returns: BootstrapEdgeResult! (BootstrapEdgeResult)

Arguments

input: BootstrapEdgeInput! (BootstrapEdgeInput)

SDK

Operation	TypeScript	Go	Python
BootstrapEdge	`BootstrapEdgeDocument`	`BootstrapEdge`	`bootstrap_edge`

Mutation.createClusterInvite

Create an invite for a cluster.

createClusterInvite(
  input: CreateClusterInviteInput!
): CreateClusterInviteResult!

Returns: CreateClusterInviteResult! (CreateClusterInviteResult)

Arguments

input: CreateClusterInviteInput! (CreateClusterInviteInput) — Invite configuration.

SDK

Operation	TypeScript	Go	Python
CreateClusterInvite	`CreateClusterInviteDocument`	`CreateClusterInvite`	`create_cluster_invite`

Mutation.createEdgeCluster

Create an edge cluster with automatic Foghorn assignment and enrollment token.

createEdgeCluster(
  input: CreateEdgeClusterInput!
): CreateEdgeClusterResult!

Returns: CreateEdgeClusterResult! (CreateEdgeClusterResult)

Arguments

input: CreateEdgeClusterInput! (CreateEdgeClusterInput) — Edge cluster configuration.

SDK

Operation	TypeScript	Go	Python
CreateEdgeCluster	`CreateEdgeClusterDocument`	`CreateEdgeCluster`	`create_edge_cluster`

Mutation.createEnrollmentToken

Create an enrollment token for an existing cluster. Requires active subscription to the cluster.

createEnrollmentToken(
  clusterId: ID!
  name: String
  ttl: String
): CreateEnrollmentTokenResult!

Returns: CreateEnrollmentTokenResult! (CreateEnrollmentTokenResult)

Arguments

clusterId: ID! — Cluster to create the token for.
name: String — Token display name.
ttl: String — Time-to-live (e.g. “24h”, “7d”). Defaults to 30 days.

SDK

Operation	TypeScript	Go	Python
CreateEnrollmentToken	`CreateEnrollmentTokenDocument`	`CreateEnrollmentToken`	`create_enrollment_token`

Mutation.openMistAdminSession

Open the MistServer admin UI on a specific edge node. Returns a short-TTL session token plus the per-edge POST URL the webapp must submit the token to (NOT a query parameter, so the token doesn’t leak via referrers / URL history / access logs). On success the browser sets a fw_mist_admin cookie scoped to /_mist and is redirected to /_mist/. Authority is infrastructure ownership, not subscriber access: Mist admin access is effectively shell on the edge box, so only owner/admin users in the cluster owner tenant can open it. Holders of the platform_operator grant are allowed as break-glass. Anything else returns AuthError without exposing whether the node exists.

openMistAdminSession(
  input: OpenMistAdminSessionInput!
): OpenMistAdminSessionResult!

Returns: OpenMistAdminSessionResult! (OpenMistAdminSessionResult)

Arguments

input: OpenMistAdminSessionInput! (OpenMistAdminSessionInput)

SDK

Operation	TypeScript	Go	Python
OpenMistAdminSession	`OpenMistAdminSessionDocument`	`OpenMistAdminSession`	`open_mist_admin_session`

Mutation.rejectClusterSubscription

Reject a pending cluster subscription request.

rejectClusterSubscription(
  subscriptionId: ID!
  reason: String
): ClusterSubscriptionResult!

Returns: ClusterSubscriptionResult! (ClusterSubscriptionResult)

Arguments

subscriptionId: ID! — The subscription ID to reject.
reason: String — Optional rejection reason.

SDK

Operation	TypeScript	Go	Python
RejectClusterSubscription	`RejectClusterSubscriptionDocument`	`RejectClusterSubscription`	`reject_cluster_subscription`

Mutation.requestClusterSubscription

Request to subscribe to a cluster.

requestClusterSubscription(
  clusterId: ID!
  inviteToken: String
): ClusterSubscriptionResult!

Returns: ClusterSubscriptionResult! (ClusterSubscriptionResult)

Arguments

clusterId: ID! — The cluster ID.
inviteToken: String — Optional invite token.

SDK

Operation	TypeScript	Go	Python
RequestClusterSubscription	`RequestClusterSubscriptionDocument`	`RequestClusterSubscription`	`request_cluster_subscription`

Mutation.revokeClusterInvite

Revoke a cluster invite.

revokeClusterInvite(
  inviteId: ID!
): RevokeClusterInviteResult!

Returns: RevokeClusterInviteResult! (RevokeClusterInviteResult)

Arguments

inviteId: ID! — The invite ID to revoke.

SDK

Operation	TypeScript	Go	Python
RevokeClusterInvite	`RevokeClusterInviteDocument`	`RevokeClusterInvite`	`revoke_cluster_invite`

Mutation.setNodeMode

Set a node’s operational mode. Drains/maintenance bleed traffic away from the node; restoring with NORMAL re-admits it to routing. Reason is recorded in Foghorn’s audit trail.

setNodeMode(
  input: SetNodeModeInput!
): SetNodeModeResult!

Returns: SetNodeModeResult! (SetNodeModeResult)

Arguments

input: SetNodeModeInput! (SetNodeModeInput)

SDK

Operation	TypeScript	Go	Python
SetNodeMode	`SetNodeModeDocument`	`SetNodeMode`	`set_node_mode`

Mutation.setPreferredCluster

Set the tenant’s preferred cluster. Must be a subscribed cluster. Used by routing services when choosing tenant-preferred infrastructure.

setPreferredCluster(
  clusterId: ID!
): SetPreferredClusterResult!

Returns: SetPreferredClusterResult! (SetPreferredClusterResult)

Arguments

clusterId: ID! — The cluster ID to set as preferred.

SDK

Operation	TypeScript	Go	Python
SetPreferredCluster	`SetPreferredClusterDocument`	`SetPreferredCluster`	`set_preferred_cluster`

Mutation.subscribeToCluster

Subscribe to a cluster for streaming access.

subscribeToCluster(
  clusterId: ID!
): Boolean!

Returns: Boolean!

Arguments

clusterId: ID! — The cluster ID to subscribe to.

SDK

Operation	TypeScript	Go	Python
SubscribeToCluster	`SubscribeToClusterDocument`	`SubscribeToCluster`	`subscribe_to_cluster`

Mutation.unsubscribeFromCluster

Unsubscribe from a cluster.

unsubscribeFromCluster(
  clusterId: ID!
): Boolean!

Returns: Boolean!

Arguments

clusterId: ID! — The cluster ID to unsubscribe from.

SDK

Operation	TypeScript	Go	Python
UnsubscribeFromCluster	`UnsubscribeFromClusterDocument`	`UnsubscribeFromCluster`	`unsubscribe_from_cluster`

Mutation.updateClusterMarketplace

Update marketplace settings for a cluster.

updateClusterMarketplace(
  clusterId: ID!
  input: UpdateClusterMarketplaceInput!
): UpdateClusterResult!

Returns: UpdateClusterResult! (UpdateClusterResult)

Arguments

clusterId: ID! — The cluster ID.
input: UpdateClusterMarketplaceInput! (UpdateClusterMarketplaceInput) — Updated marketplace settings.

SDK

Operation	TypeScript	Go	Python
UpdateClusterMarketplace	`UpdateClusterMarketplaceDocument`	`UpdateClusterMarketplace`	`update_cluster_marketplace`

Types

Clusters and infrastructure types: AvailableCluster, AvailableClusterConnection, AvailableClusterEdge, BootstrapEdgeInput, BootstrapEdgeResponse, BootstrapEdgeResult, BootstrapToken, Cluster, ClusterAccess, ClusterAccessConnection, ClusterAccessEdge, ClusterEdge, ClusterInvite, ClusterInviteConnection, ClusterInviteEdge, ClusterPricingModel, ClusterSubscription, ClusterSubscriptionConnection, ClusterSubscriptionEdge, ClusterSubscriptionResult, ClusterSubscriptionStatus, ClusterVisibility, ClustersConnection, CreateClusterInviteInput, CreateClusterInviteResult, CreateEdgeClusterInput, CreateEdgeClusterResponse, CreateEdgeClusterResult, CreateEnrollmentTokenResponse, CreateEnrollmentTokenResult, EdgeTelemetrySetup, InfrastructureNode, LiveNode, MarketplaceCluster, MarketplaceClusterConnection, MarketplaceClusterEdge, MistAdminSession, MySubscriptionEdge, MySubscriptionsConnection, NodeEdge, NodeOperationalMode, NodesConnection, OpenMistAdminSessionInput, OpenMistAdminSessionResult, Orchestrator, OrchestratorCapabilityPrice, OrchestratorInstance, OrchestratorPerformancePoint, OrchestratorVantage, OrchestratorWithDetails, OrchestratorsConnection, RevokeClusterInviteResult, RoutingImpactPreview, SetNodeModeInput, SetNodeModeResult, SetPreferredClusterResult, UpdateClusterMarketplaceInput, UpdateClusterResult