OpenAPI reference

The protocol's endpoints described for tools: every operation's parameters, headers, request and response schemas, the problem document of every error, and Arrow bodies asapplication/vnd.apache.arrow.stream binary. The specification is the definition; this document describes it, and where they differ the specification is right.

• Download it: openapi.yaml or openapi.json (the source is spec/openapi.yaml).
• Servers with capability openapi serve the same document at GET /warp/v1/openapi.json, without credentials (§3.3). The conformance suite checks every response it gets against it.

Try it out against your own server

1. Set origin under Servers to your server's scheme, host and port.
2. Open POST /warp/v1/auth/token, choose Try it out, sign in, and copy theaccess_token.
3. Choose Authorize and paste the token; every request then carries it as a bearer token.

The browser sends these requests from this site's origin, so the server must allow it: a server's cross-origin allow-list is off by default (§9.5). Hardcharger takes --cors-origins, and the reference server --cors-origin. Bodies that are Arrow streams can't be shown here; use the flows' commands for those.

All operations

The same 38 operations without script. Endpoints lists them with their sections of the specification.

Method	Path	Operation	Auth
GET	/warp	Describe the server	none
GET	/warp/v1/health	Health	none
GET	/warp/v1/openapi.json	This OpenAPI document	none
POST	/warp/v1/auth/token	Sign in	none
POST	/warp/v1/auth/oauth/flows	Start a browser sign-in	none
POST	/warp/v1/auth/oauth/flows/{flow_id}	Poll a browser sign-in	none
GET	/warp/v1/auth/oauth/callback	Identity provider callback	none
POST	/warp/v1/sessions	Open a session	bearer
GET	/warp/v1/sessions/{session_id}	Read a session	bearer
PATCH	/warp/v1/sessions/{session_id}	Set session options	bearer
DELETE	/warp/v1/sessions/{session_id}	Close a session	bearer
POST	/warp/v1/sessions/{session_id}/commit	Commit	bearer
POST	/warp/v1/sessions/{session_id}/rollback	Roll back	bearer
POST	/warp/v1/sessions/{session_id}/cancel	Cancel everything the session runs	bearer
POST	/warp/v1/sessions/{session_id}/statements	Submit a statement	bearer
GET	/warp/v1/sessions/{session_id}/statements/{statement_id}	Statement status	bearer
DELETE	/warp/v1/sessions/{session_id}/statements/{statement_id}	Close a statement	bearer
GET	/warp/v1/sessions/{session_id}/statements/{statement_id}/result	Read a result	bearer
POST	/warp/v1/sessions/{session_id}/statements/{statement_id}/cancel	Cancel a statement	bearer
POST	/warp/v1/sessions/{session_id}/prepared	Prepare a statement	bearer
DELETE	/warp/v1/sessions/{session_id}/prepared/{prepared_id}	Close a prepared statement	bearer
POST	/warp/v1/sessions/{session_id}/prepared/{prepared_id}/execute	Execute a prepared statement	bearer
POST	/warp/v1/sessions/{session_id}/ingest	Bulk ingest	bearer
POST	/warp/v1/sessions/{session_id}/ingests	Open a partitioned ingest	bearer
GET	/warp/v1/sessions/{session_id}/ingests/{ingest_id}	Read an ingest	bearer
DELETE	/warp/v1/sessions/{session_id}/ingests/{ingest_id}	Abort an ingest	bearer
POST	/warp/v1/sessions/{session_id}/ingests/{ingest_id}/parts/{part}	Upload a part	bearer
POST	/warp/v1/sessions/{session_id}/ingests/{ingest_id}/commit	Commit an ingest	bearer
GET	/warp/v1/sessions/{session_id}/metadata/server-info	Server facts	bearer
GET	/warp/v1/sessions/{session_id}/metadata/catalogs	Catalogs	bearer
GET	/warp/v1/sessions/{session_id}/metadata/db-schemas	Schemas	bearer
GET	/warp/v1/sessions/{session_id}/metadata/tables	Tables	bearer
GET	/warp/v1/sessions/{session_id}/metadata/table-types	Table types	bearer
GET	/warp/v1/sessions/{session_id}/metadata/primary-keys	Primary keys	bearer
GET	/warp/v1/sessions/{session_id}/metadata/imported-keys	Imported (foreign) keys	bearer
GET	/warp/v1/sessions/{session_id}/metadata/exported-keys	Exported keys	bearer
GET	/warp/v1/sessions/{session_id}/metadata/cross-reference	Cross reference	bearer
GET	/warp/v1/sessions/{session_id}/metadata/type-info	Type information	bearer