Batch Operation | Skyflow

curl -X POST https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/vaults/a451b783713e4424a7c761bb7bbc84ea \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "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
    }
  ]
}'

{
  "vaultID": "cd1d815aa09b4cbfbb803bd20349f202",
  "responses": [
    {
      "records": [
        {
          "fields": {
            "drivers_license_number": "*REDACTED*",
            "id_proof": "https://<aws-url>/f244fg04bgh876qemk6c3a32256e2k90/record_file/cd1d815aa09b4cbfbb803bd20349f202/c2d1debe468923c08f32470a9dh789f9/f1dbc55c-7c9b-495d-9a36-72bb2b619202/8fa99367cf58h5w296eaf15d6f42a4d237cbab65?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=<aws-credential>&X-Amz-Date=20230622T100910Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=<aws-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"
        }
      ]
    }
  ]
}

Performs multiple record operations in a single transaction.

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.

recordslist of objectsOptional

Record operations to perform.

continueOnErrorbooleanOptional

Continue performing operations on partial errors.

byotenumOptionalDefaults to 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:

Response

A successful response.

vaultIDstring

ID of the vault.

responseslist of maps from strings to any

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

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error