How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Pixie Clusters API

Operations for listing and inspecting Pixie-instrumented Kubernetes clusters connected to the Pixie Cloud.

Pixie Clusters API is one of 5 APIs that Pixie publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Cluster. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and an API reference.

This API exposes 2 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.2.0, at version 0.1.

Requests are made against a single base URL, https://work.withpixie.ai.

2 operations 2 paths 3 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1
Server
https://work.withpixie.ai
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Pixie Clusters API declares 1 security scheme for authenticating requests. An API key is passed in the header as pixie-api-key (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — Pixie API key for authenticating requests. Generate an API key from the Pixie Cloud UI under Profile API Keys.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Clusters 2

Operations for listing and inspecting Pixie-instrumented Kubernetes clusters connected to the Pixie Cloud.

GET
/api/clusters
Pixie List clusters
listClusters → 200401500
GET
/api/clusters/{cluster_id}
Pixie Get cluster details
getCluster 1 param → 200401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Cluster (10 properties), ErrorResponse (3 properties), ClusterListResponse (1 property). Each schema is shown below with its type and property counts.

Cluster
object
A Kubernetes cluster connected to Pixie Cloud with a deployed Vizier agent collecting eBPF telemetry data.
10 properties
ErrorResponse
object
Standard error response from the Pixie API.
3 properties
ClusterListResponse
object
Response containing a list of clusters connected to Pixie Cloud.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pixie-clusters-api-openapi.yml Raw ↑

Other APIs Pixie publishes across the network.

Pixie PxL Script API
Pixie Plugin System API
Pixie Health API
Pixie Scripts API
Where this information came from

This is an independent, third-party profile of Pixie Clusters API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.