Pixie API

Pixie's gRPC API for programmatically running PxL scripts against live Kubernetes clusters and managing Pixie Cloud resources. Two services: Pixie Cloud (cluster discovery, API/deploy keys, artifacts, plugins) and Pixie Vizier (ExecuteScript streaming query execution, health checks). First-party Go (px.dev/pxapi) and Python (pxapi) client libraries wrap the gRPC transport and handle API-key auth and result table streaming.

API entry from apis.yml

apis.yml Raw ↑
name: Pixie API
description: 'Pixie''s gRPC API for programmatically running PxL scripts against live Kubernetes clusters
  and managing Pixie Cloud resources. Two services: Pixie Cloud (cluster discovery, API/deploy keys, artifacts,
  plugins) and Pixie Vizier (ExecuteScript streaming query execution, health checks). First-party Go (px.dev/pxapi)
  and Python (pxapi) client libraries wrap the gRPC transport and handle API-key auth and result table
  streaming.'
humanURL: https://docs.px.dev/reference/api/overview/
baseURL: https://work.withpixie.ai
tags:
- Observability
- gRPC
- Kubernetes
- eBPF
properties:
- type: Protobuf
  name: Pixie Vizier API proto
  url: grpc/pixie-labs-vizierapi.proto
- type: Protobuf
  name: Pixie Cloud API proto
  url: grpc/pixie-labs-cloudapi.proto