Skip to content

Endpoints

Every endpoint of version 1, from the specification’s Appendix B, with the summary its OpenAPI operation gives. The path opens the operation in the OpenAPI reference; the section is where the specification defines it. Auth none means the endpoint takes no token; every other endpoint needs Authorization: Bearer <token> (§4.2). A capability means the endpoint is optional: a client uses it only when discovery (GET /warp) lists that capability.

Method Path What Spec Capability Auth
GET /warp Describe the server §3.1 none
GET /warp/v1/health Health §3.2 none
GET /warp/v1/openapi.json This OpenAPI document §3.3 openapi none
POST /warp/v1/auth/token Sign in §4.1 none
POST /warp/v1/auth/oauth/flows Start a browser sign-in §4.3.1 oauth_browser none
POST /warp/v1/auth/oauth/flows/{flow_id} Poll a browser sign-in §4.3.2 oauth_browser none
GET /warp/v1/auth/oauth/callback Identity provider callback §4.3.4 oauth_browser none
POST /warp/v1/sessions Open a session §5.1 bearer
GET /warp/v1/sessions/{session_id} Read a session §5.2 bearer
PATCH /warp/v1/sessions/{session_id} Set session options §5.3 bearer
DELETE /warp/v1/sessions/{session_id} Close a session §5.4 bearer
POST /warp/v1/sessions/{session_id}/commit Commit §5.5 transactions bearer
POST /warp/v1/sessions/{session_id}/rollback Roll back §5.5 transactions bearer
POST /warp/v1/sessions/{session_id}/cancel Cancel everything the session runs §6.8 bearer
POST /warp/v1/sessions/{session_id}/statements Submit a statement §6.1 bearer
GET /warp/v1/sessions/{session_id}/statements/{statement_id} Statement status §6.3 bearer
DELETE /warp/v1/sessions/{session_id}/statements/{statement_id} Close a statement §6.8 bearer
GET /warp/v1/sessions/{session_id}/statements/{statement_id}/result Read a result §6.4 bearer
POST /warp/v1/sessions/{session_id}/statements/{statement_id}/cancel Cancel a statement §6.8 bearer
POST /warp/v1/sessions/{session_id}/prepared Prepare a statement §7.1 prepared_statements bearer
POST /warp/v1/sessions/{session_id}/prepared/{prepared_id}/execute Execute a prepared statement §7.2 prepared_statements bearer
DELETE /warp/v1/sessions/{session_id}/prepared/{prepared_id} Close a prepared statement §7.3 prepared_statements bearer
POST /warp/v1/sessions/{session_id}/ingest Bulk ingest §8.1 ingest bearer
POST /warp/v1/sessions/{session_id}/ingests Open a partitioned ingest §8.3 partitioned_ingest bearer
GET /warp/v1/sessions/{session_id}/ingests/{ingest_id} Read an ingest §8.3 partitioned_ingest bearer
DELETE /warp/v1/sessions/{session_id}/ingests/{ingest_id} Abort an ingest §8.3 partitioned_ingest bearer
POST /warp/v1/sessions/{session_id}/ingests/{ingest_id}/parts/{part} Upload a part §8.3 partitioned_ingest bearer
POST /warp/v1/sessions/{session_id}/ingests/{ingest_id}/commit Commit an ingest §8.3 partitioned_ingest bearer
GET /warp/v1/sessions/{session_id}/metadata/catalogs Catalogs §10 bearer
GET /warp/v1/sessions/{session_id}/metadata/db-schemas Schemas §10 bearer
GET /warp/v1/sessions/{session_id}/metadata/tables Tables §10 bearer
GET /warp/v1/sessions/{session_id}/metadata/table-types Table types §10 bearer
GET /warp/v1/sessions/{session_id}/metadata/primary-keys Primary keys §10 bearer
GET /warp/v1/sessions/{session_id}/metadata/imported-keys Imported (foreign) keys §10 bearer
GET /warp/v1/sessions/{session_id}/metadata/exported-keys Exported keys §10 bearer
GET /warp/v1/sessions/{session_id}/metadata/cross-reference Cross reference §10 bearer
GET /warp/v1/sessions/{session_id}/metadata/type-info Type information §10 bearer
GET /warp/v1/sessions/{session_id}/metadata/server-info Server facts §10 bearer