> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://fern-docs.skyflow.dev/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://fern-docs.skyflow.dev/_mcp/server. # Batch Operation POST https://%7B%7Bvault_url_identifier%7D%7D.vault.skyflowapis.com/v1/vaults/{vaultID} Content-Type: application/json Performs multiple record operations in a single transaction. Reference: https://fern-docs.skyflow.dev/api/data/records/batch-operation ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Servers - `https://%7B%7Bvault_url_identifier%7D%7D.vault.skyflowapis.com` (Production, default) - `https://%7B%7Bvault_url_identifier%7D%7D.vault.skyflowapis-preview.com` (Sandbox) ## Request ### Path parameters - `vaultID` (string, required) — ID of the vault. ### Body (application/json) This endpoint expects a batch_operation_request. - `records` (list of batch_record, optional) — Record operations to perform. - `continueOnError` (boolean, optional) — Continue performing operations on partial errors. - `byot` (enum, optional, default: DISABLE) — Token insertion behavior. - DISABLE: Tokens aren't allowed for any fields. If tokens are specified, the request fails. - ENABLE: Tokens are allowed—but not required—for all fields. If tokens are specified, they're inserted. - ENABLE_STRICT: Tokens are required for all fields. If tokens are specified, they're inserted. If not, the request fails. - Allowed values: `DISABLE`, `ENABLE`, `ENABLE_STRICT` ## Response ### 200 A successful response. - `vaultID` (string, optional) — ID of the vault. - `responses` (list of map from string to any, optional) — Responses in the same order as in the request. Responses have the same payload structure as their corresponding APIs: `POST` returns an Insert Records response.`PUT` returns an Update Record response.`GET` returns a Get Record response.`DELETE` returns a Delete Record response. ## Errors ### 400 Bad Request Error Returned when the request doesn't match the schema, such as not including required fields. - `error` (ErrorResponseError, required) ### 401 Unauthorized Error Returned when the request doesn't match the schema, such as not including required fields. - `string` ### 404 Not Found Error Returned when the resource doesn't exist. - `error` (ErrorResponseError, required) ### 500 Internal Server Error An unexpected error response. - `error` (ErrorResponseError, required) ## Types ### batch_record - `fields` (map from string to any, optional) — Field and value key pairs. For example, `{'field_1':'value_1', 'field_2':'value_2'}`. Only valid when `method` is `POST` or `PUT`. - `tableName` (string, optional) — Name of the table to perform the operation on. - `method` (enum, optional) — Method of the operation. - Allowed values: `DELETE`, `GET`, `POST`, `PUT` - `batchID` (string, optional) — ID to group operations by. Operations in the same group are executed sequentially. - `redaction` (enum, optional, default: DEFAULT) — Redaction type. Subject to policies assigned to the API caller. When used for detokenization, only supported for vaults that support [column groups](/tokenization-column-groups/). - Allowed values: `DEFAULT`, `MASKED`, `PLAIN_TEXT`, `REDACTED` - `tokenization` (boolean, optional) — If `true`, this operation returns tokens for fields with tokenization enabled. Only applicable if `skyflow_id` values are specified. - `ID` (string, optional) — `skyflow_id` for the record. Only valid when `method` is `GET`, `DELETE`, or `PUT`. - `downloadURL` (boolean, optional) — If `true`, returns download URLs for fields with a file data type. URLs are valid for 15 minutes. If virus scanning is enabled, only returns if the file is clean. - `upsert` (string, optional) — Column that stores primary keys for upsert operations. The column must be marked as unique in the vault schema. Only valid when `method` is `POST`. - `tokens` (map from string to any, optional) — Fields and tokens for the record. For example, `{'field_1':'token_1', 'field_2':'token_2'}`. ### ErrorResponseError - `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) — HTTP status message. - `message` (string, required) - `details` (list of map from string to any, optional) ## Examples **Request** ```json { "records": [ { "fields": { "drivers_license_number": "89867453", "name": "Connor", "phone_number": "8794523160", "ssn": "143-89-2306" }, "tableName": "persons", "method": "POST", "batchID": "persons-12345", "redaction": "PLAIN_TEXT", "tokenization": false, "downloadURL": false, "upsert": "drivers_license_number" }, { "tableName": "persons", "method": "GET", "batchID": "persons-12345", "redaction": "PLAIN_TEXT", "tokenization": false, "ID": "f1dbc55c-7c9b-495d-9a36-72bb2b619202", "downloadURL": true } ] } ``` **Response** ```json { "vaultID": "cd1d815aa09b4cbfbb803bd20349f202", "responses": [ { "records": [ { "fields": { "drivers_license_number": "*REDACTED*", "id_proof": "https:///f244fg04bgh876qemk6c3a32256e2k90/record_file/cd1d815aa09b4cbfbb803bd20349f202/c2d1debe468923c08f32470a9dh789f9/f1dbc55c-7c9b-495d-9a36-72bb2b619202/8fa99367cf58h5w296eaf15d6f42a4d237cbab65?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=&X-Amz-Date=20230622T100910Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=", "name": "B***ok", "phone_number": "XXXXXX7533", "skyflow_id": "f1dbc55c-7c9b-495d-9a36-72bb2b619202", "ssn": "XXX-XX-7645" }, "skyflow_id": "4bc4a3a6-dfba-4314-809d-5ca63d43c732" } ] } ] } ``` **SDK Code** ```python import requests url = "https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/vaults/a451b783713e4424a7c761bb7bbc84ea" payload = { "records": [ { "fields": { "drivers_license_number": "89867453", "name": "Connor", "phone_number": "8794523160", "ssn": "143-89-2306" }, "tableName": "persons", "method": "POST", "batchID": "persons-12345", "redaction": "PLAIN_TEXT", "tokenization": False, "downloadURL": False, "upsert": "drivers_license_number" }, { "tableName": "persons", "method": "GET", "batchID": "persons-12345", "redaction": "PLAIN_TEXT", "tokenization": False, "ID": "f1dbc55c-7c9b-495d-9a36-72bb2b619202", "downloadURL": True } ] } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/vaults/a451b783713e4424a7c761bb7bbc84ea'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"records":[{"fields":{"drivers_license_number":"89867453","name":"Connor","phone_number":"8794523160","ssn":"143-89-2306"},"tableName":"persons","method":"POST","batchID":"persons-12345","redaction":"PLAIN_TEXT","tokenization":false,"downloadURL":false,"upsert":"drivers_license_number"},{"tableName":"persons","method":"GET","batchID":"persons-12345","redaction":"PLAIN_TEXT","tokenization":false,"ID":"f1dbc55c-7c9b-495d-9a36-72bb2b619202","downloadURL":true}]}' }; 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://{{vault_url_identifier}}.vault.skyflowapis.com/v1/vaults/a451b783713e4424a7c761bb7bbc84ea" payload := strings.NewReader("{\n \"records\": [\n {\n \"fields\": {\n \"drivers_license_number\": \"89867453\",\n \"name\": \"Connor\",\n \"phone_number\": \"8794523160\",\n \"ssn\": \"143-89-2306\"\n },\n \"tableName\": \"persons\",\n \"method\": \"POST\",\n \"batchID\": \"persons-12345\",\n \"redaction\": \"PLAIN_TEXT\",\n \"tokenization\": false,\n \"downloadURL\": false,\n \"upsert\": \"drivers_license_number\"\n },\n {\n \"tableName\": \"persons\",\n \"method\": \"GET\",\n \"batchID\": \"persons-12345\",\n \"redaction\": \"PLAIN_TEXT\",\n \"tokenization\": false,\n \"ID\": \"f1dbc55c-7c9b-495d-9a36-72bb2b619202\",\n \"downloadURL\": true\n }\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://{{vault_url_identifier}}.vault.skyflowapis.com/v1/vaults/a451b783713e4424a7c761bb7bbc84ea") 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 \"records\": [\n {\n \"fields\": {\n \"drivers_license_number\": \"89867453\",\n \"name\": \"Connor\",\n \"phone_number\": \"8794523160\",\n \"ssn\": \"143-89-2306\"\n },\n \"tableName\": \"persons\",\n \"method\": \"POST\",\n \"batchID\": \"persons-12345\",\n \"redaction\": \"PLAIN_TEXT\",\n \"tokenization\": false,\n \"downloadURL\": false,\n \"upsert\": \"drivers_license_number\"\n },\n {\n \"tableName\": \"persons\",\n \"method\": \"GET\",\n \"batchID\": \"persons-12345\",\n \"redaction\": \"PLAIN_TEXT\",\n \"tokenization\": false,\n \"ID\": \"f1dbc55c-7c9b-495d-9a36-72bb2b619202\",\n \"downloadURL\": true\n }\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://{{vault_url_identifier}}.vault.skyflowapis.com/v1/vaults/a451b783713e4424a7c761bb7bbc84ea") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"records\": [\n {\n \"fields\": {\n \"drivers_license_number\": \"89867453\",\n \"name\": \"Connor\",\n \"phone_number\": \"8794523160\",\n \"ssn\": \"143-89-2306\"\n },\n \"tableName\": \"persons\",\n \"method\": \"POST\",\n \"batchID\": \"persons-12345\",\n \"redaction\": \"PLAIN_TEXT\",\n \"tokenization\": false,\n \"downloadURL\": false,\n \"upsert\": \"drivers_license_number\"\n },\n {\n \"tableName\": \"persons\",\n \"method\": \"GET\",\n \"batchID\": \"persons-12345\",\n \"redaction\": \"PLAIN_TEXT\",\n \"tokenization\": false,\n \"ID\": \"f1dbc55c-7c9b-495d-9a36-72bb2b619202\",\n \"downloadURL\": true\n }\n ]\n}") .asString(); ``` ```php request('POST', 'https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/vaults/a451b783713e4424a7c761bb7bbc84ea', [ 'body' => '{ "records": [ { "fields": { "drivers_license_number": "89867453", "name": "Connor", "phone_number": "8794523160", "ssn": "143-89-2306" }, "tableName": "persons", "method": "POST", "batchID": "persons-12345", "redaction": "PLAIN_TEXT", "tokenization": false, "downloadURL": false, "upsert": "drivers_license_number" }, { "tableName": "persons", "method": "GET", "batchID": "persons-12345", "redaction": "PLAIN_TEXT", "tokenization": false, "ID": "f1dbc55c-7c9b-495d-9a36-72bb2b619202", "downloadURL": true } ] }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/vaults/a451b783713e4424a7c761bb7bbc84ea"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"records\": [\n {\n \"fields\": {\n \"drivers_license_number\": \"89867453\",\n \"name\": \"Connor\",\n \"phone_number\": \"8794523160\",\n \"ssn\": \"143-89-2306\"\n },\n \"tableName\": \"persons\",\n \"method\": \"POST\",\n \"batchID\": \"persons-12345\",\n \"redaction\": \"PLAIN_TEXT\",\n \"tokenization\": false,\n \"downloadURL\": false,\n \"upsert\": \"drivers_license_number\"\n },\n {\n \"tableName\": \"persons\",\n \"method\": \"GET\",\n \"batchID\": \"persons-12345\",\n \"redaction\": \"PLAIN_TEXT\",\n \"tokenization\": false,\n \"ID\": \"f1dbc55c-7c9b-495d-9a36-72bb2b619202\",\n \"downloadURL\": true\n }\n ]\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["records": [ [ "fields": [ "drivers_license_number": "89867453", "name": "Connor", "phone_number": "8794523160", "ssn": "143-89-2306" ], "tableName": "persons", "method": "POST", "batchID": "persons-12345", "redaction": "PLAIN_TEXT", "tokenization": false, "downloadURL": false, "upsert": "drivers_license_number" ], [ "tableName": "persons", "method": "GET", "batchID": "persons-12345", "redaction": "PLAIN_TEXT", "tokenization": false, "ID": "f1dbc55c-7c9b-495d-9a36-72bb2b619202", "downloadURL": true ] ]] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/vaults/a451b783713e4424a7c761bb7bbc84ea")! 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() ```