Delete Records

DELETE https://%7B%7Bvault_uri%7D%7D.vault.skyflowapis.com/v1/vaults/{vaultID}/{objectName}
Content-Type: application/json

Deletes the specified records from a table.

Authentication

• Authorization header (bearer token, required) — Access token, prefixed by Bearer .

Servers

• https://%7B%7Bvault_uri%7D%7D.vault.skyflowapis.com (Production, default)
• https://%7B%7Bvault_uri%7D%7D.vault.skyflowapis-preview.com (Sandbox)

Request

Path parameters

• vaultID (string, required) — ID of the vault.
• objectName (string, required) — Name of the table.

Body (application/json)

This endpoint expects an object.

• skyflow_ids (list of string, optional) — skyflow_id values of the records to delete. If * is specified, this operation deletes all records in the table.

Response

200

OK

• RecordIDResponse (list of string, optional) — IDs for the deleted records, or * if all records were deleted.

Errors

400 Bad Request Error

Returned when the request is invalid or cannot be served.

• error (object, required)
  • grpc_code (integer, required) — gRPC status codes. See https://grpc.io/docs/guides/status-codes.
  • http_code (integer, required) — HTTP status codes. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status.
  • http_status (string, required)
  • message (string, required)
  • details (list of map from string to any, optional)

401 Unauthorized Error

Returned when the request is unauthorized.

• error (object, required)
  • grpc_code (integer, required) — gRPC status codes. See https://grpc.io/docs/guides/status-codes.
  • http_code (integer, required) — HTTP status codes. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status.
  • http_status (string, required)
  • message (string, required)
  • details (list of map from string to any, optional)

404 Not Found Error

Returned when a resource doesn’t exist.

• error (object, required)
  • grpc_code (integer, required) — gRPC status codes. See https://grpc.io/docs/guides/status-codes.
  • http_code (integer, required) — HTTP status codes. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status.
  • http_status (string, required)
  • message (string, required)
  • details (list of map from string to any, optional)

500 Internal Server Error

An unexpected error response.

• error (object, required)
  • grpc_code (integer, required) — gRPC status codes. See https://grpc.io/docs/guides/status-codes.
  • http_code (integer, required) — HTTP status codes. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status.
  • http_status (string, required)
  • message (string, required)
  • details (list of map from string to any, optional)

Examples

Request

{
  "skyflow_ids": [
    "51782ea4-91a5-4430-a06d-f4b76efd3d2f",
    "110ce08f-6059-4874-b1ae-7c6651d286ff"
  ]
}

Response

{
  "RecordIDResponse": [
    "51782ea4-91a5-4430-a06d-f4b76efd3d2f",
    "110ce08f-6059-4874-b1ae-7c6651d286ff"
  ]
}

SDK Code

import requests

url = "https://{{vault_uri}}.vault.skyflowapis.com/v1/vaults/vaultID/objectName"

payload = { "skyflow_ids": ["51782ea4-91a5-4430-a06d-f4b76efd3d2f", "110ce08f-6059-4874-b1ae-7c6651d286ff"] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.delete(url, json=payload, headers=headers)

print(response.json())

const url = 'https://{{vault_uri}}.vault.skyflowapis.com/v1/vaults/vaultID/objectName';
const options = {
  method: 'DELETE',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"skyflow_ids":["51782ea4-91a5-4430-a06d-f4b76efd3d2f","110ce08f-6059-4874-b1ae-7c6651d286ff"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://{{vault_uri}}.vault.skyflowapis.com/v1/vaults/vaultID/objectName"

  payload := strings.NewReader("{\n  \"skyflow_ids\": [\n    \"51782ea4-91a5-4430-a06d-f4b76efd3d2f\",\n    \"110ce08f-6059-4874-b1ae-7c6651d286ff\"\n  ]\n}")

  req, _ := http.NewRequest("DELETE", url, payload)

  req.Header.Add("Authorization", "Bearer <token>")
  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))

}

require 'uri'
require 'net/http'

url = URI("https://{{vault_uri}}.vault.skyflowapis.com/v1/vaults/vaultID/objectName")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"skyflow_ids\": [\n    \"51782ea4-91a5-4430-a06d-f4b76efd3d2f\",\n    \"110ce08f-6059-4874-b1ae-7c6651d286ff\"\n  ]\n}"

response = http.request(request)
puts response.read_body

import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.delete("https://{{vault_uri}}.vault.skyflowapis.com/v1/vaults/vaultID/objectName")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"skyflow_ids\": [\n    \"51782ea4-91a5-4430-a06d-f4b76efd3d2f\",\n    \"110ce08f-6059-4874-b1ae-7c6651d286ff\"\n  ]\n}")
  .asString();

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://{{vault_uri}}.vault.skyflowapis.com/v1/vaults/vaultID/objectName', [
  'body' => '{
  "skyflow_ids": [
    "51782ea4-91a5-4430-a06d-f4b76efd3d2f",
    "110ce08f-6059-4874-b1ae-7c6651d286ff"
  ]
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

using RestSharp;

var client = new RestClient("https://{{vault_uri}}.vault.skyflowapis.com/v1/vaults/vaultID/objectName");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"skyflow_ids\": [\n    \"51782ea4-91a5-4430-a06d-f4b76efd3d2f\",\n    \"110ce08f-6059-4874-b1ae-7c6651d286ff\"\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["skyflow_ids": ["51782ea4-91a5-4430-a06d-f4b76efd3d2f", "110ce08f-6059-4874-b1ae-7c6651d286ff"]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://{{vault_uri}}.vault.skyflowapis.com/v1/vaults/vaultID/objectName")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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()