APIActive

Skaffold API

Skaffold exposes an API for retrieving process state and controlling execution, available via gRPC and HTTP.

Open source page ↗

Field note

What it does

Skaffold API allows retrieving information about the state of the Skaffold process and provides fine-grained control over execution. It is exposed through both gRPC and HTTP protocols.

Capabilities

Available capabilities

HTTP API AccessPipeline ControlReal-time API request and event streaminggRPC APIState Snapshot

Tags

Tags

CLIDeveloper toolsAPISkaffoldKubernetes

Ways to use it

Ways to use it

other

Not filed / Not filed

rest

Not filed / Not filed

other

Go / https://skaffold.dev/docs/design/api/

Product features

Product features

Control API

Control build, deploy, and sync phases.

Event API

Streaming lifecycle events.

gRPC Server

gRPC API can be started with --rpc-port flag.

HTTP REST Server

HTTP REST API can be started with --rpc-http-port flag.

State API

Snapshot of current pipeline state.