> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://apidocs.polytomic.com/2025-09-18/api-reference/harbors/run-query/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://apidocs.polytomic.com/_mcp/server. # Run Harbor Query POST https://app.polytomic.com/api/harbors/{harbor_id}/query Content-Type: application/json 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}`](../../../../api-reference/query-runner/get-query) 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. Reference: https://apidocs.polytomic.com/api-reference/harbors/run-query ## Authentication - `Authorization` header (bearer token, required) — Bearer user API key - `Authorization` header (basic auth, required) — Basic organization-scoped API key ## Request ### Path parameters - `harbor_id` (string, required) — Unique identifier of the Harbor whose backing connection runs the query. ### Headers - `X-Polytomic-Harbor-Session` (string, optional) - `X-Polytomic-Activity-Request-ID` (string, optional) ### Body (application/json) This endpoint expects a RunHarborQueryRequest. - `query` (string, required) — SQL query to execute against the Harbor backing connection. ## Response ### 200 OK - `data` (RunQueryResult, optional) ## Errors ### 400 Bad Request Error Bad Request - `key` (string, optional) - `message` (string, optional) - `metadata` (map from string to any, optional) - `status` (integer, optional) ### 403 Forbidden Error Forbidden - `key` (string, optional) - `message` (string, optional) - `metadata` (map from string to any, optional) - `status` (integer, optional) ### 404 Not Found Error Not Found - `key` (string, optional) - `message` (string, optional) - `metadata` (map from string to any, optional) - `status` (integer, optional) ### 409 Conflict Error Conflict - `key` (string, optional) - `message` (string, optional) - `metadata` (map from string to any, optional) - `status` (integer, optional) ### 500 Internal Server Error Internal Server Error - `key` (string, optional) - `message` (string, optional) - `metadata` (map from string to any, optional) - `status` (integer, optional) ### 503 Service Unavailable Error Service Unavailable - `key` (string, optional) - `message` (string, optional) - `metadata` (map from string to any, optional) - `status` (integer, optional) ## Types ### RunQueryResult - `count` (long, optional) — The number of rows returned by the query. This will not be returned until the query completes. - `error` (string, optional) — Error message if the query failed. - `expires` (string, optional) — The time at which the query will expire and be deleted. This will not be returned until the query completes. - `fields` (list of string, optional) — The names of the fields returned by the query. This will not be returned until the query completes. - `id` (string, optional) — The ID of the query task. Poll GET /api/queries/\{id} until the task reaches the terminal status done, failed, or unknown. - `results` (list of map from string to any, optional) — The query results, returned as an array of objects. - `status` (enum, optional) - Allowed values: `created`, `running`, `unknown`, `done`, `failed` ## Examples **Request** ```json { "query": "SELECT 1 AS n" } ``` **Response** ```json { "data": { "count": 10, "error": "string", "expires": "2021-01-01T00:00:00Z", "fields": [ "name", "age" ], "id": "43d893ef-322b-47da-badb-3cf10d13a556", "results": [ {} ], "status": "created" } } ``` **SDK Code** ```python import requests url = "https://app.polytomic.com/api/harbors/248df4b7-aa70-47b8-a036-33ac447e668d/query" payload = { "query": "SELECT 1 AS n" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://app.polytomic.com/api/harbors/248df4b7-aa70-47b8-a036-33ac447e668d/query'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"query":"SELECT 1 AS n"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://app.polytomic.com/api/harbors/248df4b7-aa70-47b8-a036-33ac447e668d/query" payload := strings.NewReader("{\n \"query\": \"SELECT 1 AS n\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://app.polytomic.com/api/harbors/248df4b7-aa70-47b8-a036-33ac447e668d/query") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"query\": \"SELECT 1 AS n\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://app.polytomic.com/api/harbors/248df4b7-aa70-47b8-a036-33ac447e668d/query") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"query\": \"SELECT 1 AS n\"\n}") .asString(); ``` ```php request('POST', 'https://app.polytomic.com/api/harbors/248df4b7-aa70-47b8-a036-33ac447e668d/query', [ 'body' => '{ "query": "SELECT 1 AS n" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://app.polytomic.com/api/harbors/248df4b7-aa70-47b8-a036-33ac447e668d/query"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"query\": \"SELECT 1 AS n\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["query": "SELECT 1 AS n"] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://app.polytomic.com/api/harbors/248df4b7-aa70-47b8-a036-33ac447e668d/query")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```