DocsAPI Reference
  • Data API
    • POSTGet BIN
LogoLogo
Login
Login
Data APIQuery

Execute Query

POST
/v1/vaults/:vaultID/query
POST
/v1/vaults/:vaultID/query
1curl -X POST https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/vaults/a451b783713e4424a7c761bb7bbc84ea/query \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "query": "select * from opportunities where id=\"01010000ade21cded569d43944544ec6\""
6}'
Try it
1{
2 "records": [
3 {
4 "fields": {
5 "Estimated Value": 10000,
6 "Expected Close Date": "2017-07-12",
7 "Opportunity Name": "BPS Pilot",
8 "Owner": {
9 "email": "kat+collab15@skyflow.com",
10 "id": "usrijG9SC4EQlq5cm",
11 "name": "Jess Patel"
12 },
13 "Priority": "Medium",
14 "Proposal Deadline": "2017-06-14",
15 "Status": "Qualification"
16 }
17 },
18 {
19 "fields": {
20 "Estimated Value": 24791,
21 "Expected Close Date": "2017-07-07",
22 "Opportunity Name": "BPS second use case",
23 "Owner": {
24 "email": "kat+collab36@skyflow.com",
25 "id": "usrGqHsNLhH41Q91M",
26 "name": "Sandy Hagen"
27 },
28 "Priority": "Very Low Deprioritize",
29 "Status": "Proposal"
30 }
31 }
32 ]
33}
Returns records for a valid SQL query. This endpoint <ul><li>Can return redacted record values.</li><li>Supports only the <code>SELECT</code> command.</li><li>Returns a maximum of 25 records. To return additional records, perform another query using the <code>OFFSET</code> keyword.</li><li>Can't modify the vault or perform transactions.</li><li>Can't return tokens.</li><li>Can't return file download or render URLs.</li><li>Doesn't support the <code>WHERE</code> keyword with columns using transient tokenization.</li><li>Doesn't support `?` conditional for columns with column-level encryption disabled.</li><ul>
Was this page helpful?
Previous
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

vaultIDstringRequired
ID of the vault.

Request

This endpoint expects an object.
querystringOptional
The SQL query to execute.<br><br><b>Supported commands:</b> <ul> <li><code>SELECT</code></li> </ul> <b>Supported operators:</b> <ul> <li><code>&gt;</code></li> <li><code>&lt;</code></li> <li><code>=</code></li> <li><code>AND</code></li> <li><code>OR</code></li> <li><code>NOT</code></li> <li><code>LIKE</code></li> <li><code>ILIKE</code></li> <li><code>NULL</code></li> <li><code>NOT NULL</code></li> </ul> <b>Supported keywords:</b> <ul> <li><code>FROM</code></li> <li><code>JOIN</code></li> <li><code>INNER JOIN</code></li> <li><code>LEFT OUTER JOIN</code></li> <li><code>LEFT JOIN</code></li> <li><code>RIGHT OUTER JOIN</code></li> <li><code>RIGHT JOIN</code></li> <li><code>FULL OUTER JOIN</code></li> <li><code>FULL JOIN</code></li> <li><code>OFFSET</code></li> <li><code>LIMIT</code></li> <li><code>WHERE</code></li> </ul> <b>Supported functions:</b> <ul> <li><code>AVG()</code></li> <li><code>SUM()</code></li> <li><code>COUNT()</code></li> <li><code>MIN()</code></li> <li><code>MAX()</code></li> <li><code>REDACTION()</code></li> </ul>

Response

A successful response.
recordslist of objects or null
Records returned by the query.

Errors

A successful response.

Returns records for a valid SQL query. This endpoint <ul>

  • Can return redacted record values.
  • Supports only the SELECT command.
  • Returns a maximum of 25 records. To return additional records, perform another query using the OFFSET keyword.
  • Can’t modify the vault or perform transactions.
  • Can’t return tokens.
  • Can’t return file download or render URLs.
  • Doesn’t support the WHERE keyword with columns using transient tokenization.
  • Doesn’t support ? conditional for columns with column-level encryption disabled.
  • <ul>

    The SQL query to execute.

    Supported commands:

    • SELECT
    Supported operators:
    • >
    • <
    • =
    • AND
    • OR
    • NOT
    • LIKE
    • ILIKE
    • NULL
    • NOT NULL
    Supported keywords:
    • FROM
    • JOIN
    • INNER JOIN
    • LEFT OUTER JOIN
    • LEFT JOIN
    • RIGHT OUTER JOIN
    • RIGHT JOIN
    • FULL OUTER JOIN
    • FULL JOIN
    • OFFSET
    • LIMIT
    • WHERE
    Supported functions:
    • AVG()
    • SUM()
    • COUNT()
    • MIN()
    • MAX()
    • REDACTION()