Run Harbor Query
Submits a query against the Harbor backing connection for asynchronous execution.
Use a scoped credential bound to this Harbor. The query runs only against the
Harbor’s backing connection; you cannot select another connection on this route.
Send a unique X-Polytomic-Activity-Request-ID UUID with each submission. The
X-Polytomic-Harbor-Session header is optional; if you send one, it must be
valid for this Harbor.
The response contains a query ID and an initial created status. Poll
GET /api/queries/{id} with that ID
until the status is done, failed, or unknown. Follow the result endpoint’s
pagination links for additional rows. Results are temporary; check expires
on the completed query.
Authentication
AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic
Basic organization-scoped API key
Path parameters
harbor_id
Unique identifier of the Harbor whose backing connection runs the query.
Headers
X-Polytomic-Version
X-Polytomic-Harbor-Session
X-Polytomic-Activity-Request-ID
Request
This endpoint expects an object.
query
SQL query to execute against the Harbor backing connection.
Response
OK
data
Errors
400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error
503
Service Unavailable Error
