{ "item": [ { "name": "Audit", "description": "", "item": [ { "id": "afd7e93b-bee4-4b9b-aa22-5641512107b0", "name": "List Data Audit Events", "request": { "name": "List Data Audit Events", "description": { "content": "Lists data audit events that match query parameters.", "type": "text/plain" }, "url": { "path": [ "v1", "audit", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "ID for the audit event. Use this to uniquely identify a specific audit record.", "type": "text/plain" }, "key": "filterOps.context.changeID", "value": "" }, { "disabled": true, "description": { "content": "ID for the request that caused the event. Use to correlate multiple audit events triggered by a single API request.", "type": "text/plain" }, "key": "filterOps.context.requestID", "value": "" }, { "disabled": true, "description": { "content": "ID for the session in which the request was sent. Present when a session context is available.", "type": "text/plain" }, "key": "filterOps.context.sessionID", "value": "" }, { "disabled": true, "description": { "content": "Member who sent the request. Depending on `actorType`, this may be a user ID or a service account ID. For users this is their email address.", "type": "text/plain" }, "key": "filterOps.context.actor", "value": "" }, { "disabled": true, "description": { "content": "Type of member who sent the request. (This can only be one of NONE,USER,GROUP,SERVICE_ACCOUNT,SQL_SERVICE_ACCOUNT)", "type": "text/plain" }, "key": "filterOps.context.actorType", "value": "GROUP" }, { "disabled": true, "description": { "content": "Type of access for the request. (This can only be one of ACCESS_NONE,API,SQL,OKTA_LOGIN)", "type": "text/plain" }, "key": "filterOps.context.accessType", "value": "OKTA_LOGIN" }, { "disabled": true, "description": { "content": "IP Address of the client that made the request.", "type": "text/plain" }, "key": "filterOps.context.ipAddress", "value": "" }, { "disabled": true, "description": { "content": "HTTP Origin request header (including scheme, hostname, and port) of the request. Present only for browser-originated requests. Absent for server-to-server API calls.", "type": "text/plain" }, "key": "filterOps.context.origin", "value": "" }, { "disabled": true, "description": { "content": "Authentication mode the `actor` used. `OKTA_JWT`: Federated identity via Okta SSO. `SERVICE_ACCOUNT_JWT`: Service account JWT (machine-to-machine). `PAT_JWT`: Personal Access Token issued as a JWT. `API_KEY`: Static API key. (This can only be one of AUTH_NONE,OKTA_JWT,SERVICE_ACCOUNT_JWT,PAT_JWT,API_KEY,STS)", "type": "text/plain" }, "key": "filterOps.context.authMode", "value": "SERVICE_ACCOUNT_JWT" }, { "disabled": true, "description": { "content": "ID of the JWT token (the `jti` claim). Identifies the specific token used for this request.", "type": "text/plain" }, "key": "filterOps.context.jwtID", "value": "" }, { "disabled": true, "description": { "content": "User context embedded in the bearer token. Present when a bearer token encodes additional user context.", "type": "text/plain" }, "key": "filterOps.context.bearerTokenContextID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified parent account ID.", "type": "text/plain" }, "key": "filterOps.parentAccountID", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "filterOps.accountID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified workspace ID.", "type": "text/plain" }, "key": "filterOps.workspaceID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified vault ID.", "type": "text/plain" }, "key": "filterOps.vaultID", "value": "" }, { "disabled": true, "description": { "content": "Resources with a specified ID. If a resource matches at least one ID, the associated event is returned. Format is a comma-separated list of \"\\/\\\". For example, \"VAULT/12345, USER/67890\".", "type": "text/plain" }, "key": "filterOps.resourceIDs", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1dba3eeb-ea05-496f-949c-ecec6ab7071b", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "audit", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "ID for the audit event. Use this to uniquely identify a specific audit record.", "type": "text/plain" }, "key": "filterOps.context.changeID", "value": "" }, { "disabled": true, "description": { "content": "ID for the request that caused the event. Use to correlate multiple audit events triggered by a single API request.", "type": "text/plain" }, "key": "filterOps.context.requestID", "value": "" }, { "disabled": true, "description": { "content": "ID for the session in which the request was sent. Present when a session context is available.", "type": "text/plain" }, "key": "filterOps.context.sessionID", "value": "" }, { "disabled": true, "description": { "content": "Member who sent the request. Depending on `actorType`, this may be a user ID or a service account ID. For users this is their email address.", "type": "text/plain" }, "key": "filterOps.context.actor", "value": "" }, { "disabled": true, "description": { "content": "Type of member who sent the request. (This can only be one of NONE,USER,GROUP,SERVICE_ACCOUNT,SQL_SERVICE_ACCOUNT)", "type": "text/plain" }, "key": "filterOps.context.actorType", "value": "GROUP" }, { "disabled": true, "description": { "content": "Type of access for the request. (This can only be one of ACCESS_NONE,API,SQL,OKTA_LOGIN)", "type": "text/plain" }, "key": "filterOps.context.accessType", "value": "OKTA_LOGIN" }, { "disabled": true, "description": { "content": "IP Address of the client that made the request.", "type": "text/plain" }, "key": "filterOps.context.ipAddress", "value": "" }, { "disabled": true, "description": { "content": "HTTP Origin request header (including scheme, hostname, and port) of the request. Present only for browser-originated requests. Absent for server-to-server API calls.", "type": "text/plain" }, "key": "filterOps.context.origin", "value": "" }, { "disabled": true, "description": { "content": "Authentication mode the `actor` used. `OKTA_JWT`: Federated identity via Okta SSO. `SERVICE_ACCOUNT_JWT`: Service account JWT (machine-to-machine). `PAT_JWT`: Personal Access Token issued as a JWT. `API_KEY`: Static API key. (This can only be one of AUTH_NONE,OKTA_JWT,SERVICE_ACCOUNT_JWT,PAT_JWT,API_KEY,STS)", "type": "text/plain" }, "key": "filterOps.context.authMode", "value": "SERVICE_ACCOUNT_JWT" }, { "disabled": true, "description": { "content": "ID of the JWT token (the `jti` claim). Identifies the specific token used for this request.", "type": "text/plain" }, "key": "filterOps.context.jwtID", "value": "" }, { "disabled": true, "description": { "content": "User context embedded in the bearer token. Present when a bearer token encodes additional user context.", "type": "text/plain" }, "key": "filterOps.context.bearerTokenContextID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified parent account ID.", "type": "text/plain" }, "key": "filterOps.parentAccountID", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "filterOps.accountID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified workspace ID.", "type": "text/plain" }, "key": "filterOps.workspaceID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified vault ID.", "type": "text/plain" }, "key": "filterOps.vaultID", "value": "" }, { "disabled": true, "description": { "content": "Resources with a specified ID. If a resource matches at least one ID, the associated event is returned. Format is a comma-separated list of \"\\/\\\". For example, \"VAULT/12345, USER/67890\".", "type": "text/plain" }, "key": "filterOps.resourceIDs", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"event\": [\n {\n \"context\": {\n \"changeID\": \"\",\n \"requestID\": \"\",\n \"traceID\": \"\",\n \"actor\": \"\",\n \"actorType\": \"SERVICE_ACCOUNT\",\n \"accessType\": \"SQL\",\n \"ipAddress\": \"\",\n \"authMode\": \"API_KEY\",\n \"jwtID\": \"\",\n \"sessionID\": \"\",\n \"origin\": \"\",\n \"bearerTokenContextID\": \"\",\n \"keyID\": \"\",\n \"subject\": \"\"\n },\n \"response\": {\n \"code\": \"\",\n \"message\": \"\",\n \"timestamp\": \"\",\n \"data\": {\n \"content\": \"\"\n },\n \"nestedResponse\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"identifier\": \"\",\n \"data\": {\n \"content\": \"\"\n }\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"identifier\": \"\",\n \"data\": {\n \"content\": \"\"\n }\n }\n ]\n }\n },\n {\n \"context\": {\n \"changeID\": \"\",\n \"requestID\": \"\",\n \"traceID\": \"\",\n \"actor\": \"\",\n \"actorType\": \"SERVICE_ACCOUNT\",\n \"accessType\": \"SQL\",\n \"ipAddress\": \"\",\n \"authMode\": \"API_KEY\",\n \"jwtID\": \"\",\n \"sessionID\": \"\",\n \"origin\": \"\",\n \"bearerTokenContextID\": \"\",\n \"keyID\": \"\",\n \"subject\": \"\"\n },\n \"response\": {\n \"code\": \"\",\n \"message\": \"\",\n \"timestamp\": \"\",\n \"data\": {\n \"content\": \"\"\n },\n \"nestedResponse\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"identifier\": \"\",\n \"data\": {\n \"content\": \"\"\n }\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"identifier\": \"\",\n \"data\": {\n \"content\": \"\"\n }\n }\n ]\n }\n }\n ],\n \"nextOps\": {\n \"timestamp\": \"\",\n \"changeID\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c227dc2-6fce-44ec-925c-4f173b4b0a28", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "audit", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "ID for the audit event. Use this to uniquely identify a specific audit record.", "type": "text/plain" }, "key": "filterOps.context.changeID", "value": "" }, { "disabled": true, "description": { "content": "ID for the request that caused the event. Use to correlate multiple audit events triggered by a single API request.", "type": "text/plain" }, "key": "filterOps.context.requestID", "value": "" }, { "disabled": true, "description": { "content": "ID for the session in which the request was sent. Present when a session context is available.", "type": "text/plain" }, "key": "filterOps.context.sessionID", "value": "" }, { "disabled": true, "description": { "content": "Member who sent the request. Depending on `actorType`, this may be a user ID or a service account ID. For users this is their email address.", "type": "text/plain" }, "key": "filterOps.context.actor", "value": "" }, { "disabled": true, "description": { "content": "Type of member who sent the request. (This can only be one of NONE,USER,GROUP,SERVICE_ACCOUNT,SQL_SERVICE_ACCOUNT)", "type": "text/plain" }, "key": "filterOps.context.actorType", "value": "GROUP" }, { "disabled": true, "description": { "content": "Type of access for the request. (This can only be one of ACCESS_NONE,API,SQL,OKTA_LOGIN)", "type": "text/plain" }, "key": "filterOps.context.accessType", "value": "OKTA_LOGIN" }, { "disabled": true, "description": { "content": "IP Address of the client that made the request.", "type": "text/plain" }, "key": "filterOps.context.ipAddress", "value": "" }, { "disabled": true, "description": { "content": "HTTP Origin request header (including scheme, hostname, and port) of the request. Present only for browser-originated requests. Absent for server-to-server API calls.", "type": "text/plain" }, "key": "filterOps.context.origin", "value": "" }, { "disabled": true, "description": { "content": "Authentication mode the `actor` used. `OKTA_JWT`: Federated identity via Okta SSO. `SERVICE_ACCOUNT_JWT`: Service account JWT (machine-to-machine). `PAT_JWT`: Personal Access Token issued as a JWT. `API_KEY`: Static API key. (This can only be one of AUTH_NONE,OKTA_JWT,SERVICE_ACCOUNT_JWT,PAT_JWT,API_KEY,STS)", "type": "text/plain" }, "key": "filterOps.context.authMode", "value": "SERVICE_ACCOUNT_JWT" }, { "disabled": true, "description": { "content": "ID of the JWT token (the `jti` claim). Identifies the specific token used for this request.", "type": "text/plain" }, "key": "filterOps.context.jwtID", "value": "" }, { "disabled": true, "description": { "content": "User context embedded in the bearer token. Present when a bearer token encodes additional user context.", "type": "text/plain" }, "key": "filterOps.context.bearerTokenContextID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified parent account ID.", "type": "text/plain" }, "key": "filterOps.parentAccountID", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "filterOps.accountID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified workspace ID.", "type": "text/plain" }, "key": "filterOps.workspaceID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified vault ID.", "type": "text/plain" }, "key": "filterOps.vaultID", "value": "" }, { "disabled": true, "description": { "content": "Resources with a specified ID. If a resource matches at least one ID, the associated event is returned. Format is a comma-separated list of \"\\/\\\". For example, \"VAULT/12345, USER/67890\".", "type": "text/plain" }, "key": "filterOps.resourceIDs", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4505d6bb-6bef-4fed-bb65-c0735d09eddb", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "audit", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "ID for the audit event. Use this to uniquely identify a specific audit record.", "type": "text/plain" }, "key": "filterOps.context.changeID", "value": "" }, { "disabled": true, "description": { "content": "ID for the request that caused the event. Use to correlate multiple audit events triggered by a single API request.", "type": "text/plain" }, "key": "filterOps.context.requestID", "value": "" }, { "disabled": true, "description": { "content": "ID for the session in which the request was sent. Present when a session context is available.", "type": "text/plain" }, "key": "filterOps.context.sessionID", "value": "" }, { "disabled": true, "description": { "content": "Member who sent the request. Depending on `actorType`, this may be a user ID or a service account ID. For users this is their email address.", "type": "text/plain" }, "key": "filterOps.context.actor", "value": "" }, { "disabled": true, "description": { "content": "Type of member who sent the request. (This can only be one of NONE,USER,GROUP,SERVICE_ACCOUNT,SQL_SERVICE_ACCOUNT)", "type": "text/plain" }, "key": "filterOps.context.actorType", "value": "GROUP" }, { "disabled": true, "description": { "content": "Type of access for the request. (This can only be one of ACCESS_NONE,API,SQL,OKTA_LOGIN)", "type": "text/plain" }, "key": "filterOps.context.accessType", "value": "OKTA_LOGIN" }, { "disabled": true, "description": { "content": "IP Address of the client that made the request.", "type": "text/plain" }, "key": "filterOps.context.ipAddress", "value": "" }, { "disabled": true, "description": { "content": "HTTP Origin request header (including scheme, hostname, and port) of the request. Present only for browser-originated requests. Absent for server-to-server API calls.", "type": "text/plain" }, "key": "filterOps.context.origin", "value": "" }, { "disabled": true, "description": { "content": "Authentication mode the `actor` used. `OKTA_JWT`: Federated identity via Okta SSO. `SERVICE_ACCOUNT_JWT`: Service account JWT (machine-to-machine). `PAT_JWT`: Personal Access Token issued as a JWT. `API_KEY`: Static API key. (This can only be one of AUTH_NONE,OKTA_JWT,SERVICE_ACCOUNT_JWT,PAT_JWT,API_KEY,STS)", "type": "text/plain" }, "key": "filterOps.context.authMode", "value": "SERVICE_ACCOUNT_JWT" }, { "disabled": true, "description": { "content": "ID of the JWT token (the `jti` claim). Identifies the specific token used for this request.", "type": "text/plain" }, "key": "filterOps.context.jwtID", "value": "" }, { "disabled": true, "description": { "content": "User context embedded in the bearer token. Present when a bearer token encodes additional user context.", "type": "text/plain" }, "key": "filterOps.context.bearerTokenContextID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified parent account ID.", "type": "text/plain" }, "key": "filterOps.parentAccountID", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "filterOps.accountID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified workspace ID.", "type": "text/plain" }, "key": "filterOps.workspaceID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified vault ID.", "type": "text/plain" }, "key": "filterOps.vaultID", "value": "" }, { "disabled": true, "description": { "content": "Resources with a specified ID. If a resource matches at least one ID, the associated event is returned. Format is a comma-separated list of \"\\/\\\". For example, \"VAULT/12345, USER/67890\".", "type": "text/plain" }, "key": "filterOps.resourceIDs", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85eebadb-cb4e-49d7-96ba-9afa8fc106be", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "audit", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "ID for the audit event. Use this to uniquely identify a specific audit record.", "type": "text/plain" }, "key": "filterOps.context.changeID", "value": "" }, { "disabled": true, "description": { "content": "ID for the request that caused the event. Use to correlate multiple audit events triggered by a single API request.", "type": "text/plain" }, "key": "filterOps.context.requestID", "value": "" }, { "disabled": true, "description": { "content": "ID for the session in which the request was sent. Present when a session context is available.", "type": "text/plain" }, "key": "filterOps.context.sessionID", "value": "" }, { "disabled": true, "description": { "content": "Member who sent the request. Depending on `actorType`, this may be a user ID or a service account ID. For users this is their email address.", "type": "text/plain" }, "key": "filterOps.context.actor", "value": "" }, { "disabled": true, "description": { "content": "Type of member who sent the request. (This can only be one of NONE,USER,GROUP,SERVICE_ACCOUNT,SQL_SERVICE_ACCOUNT)", "type": "text/plain" }, "key": "filterOps.context.actorType", "value": "GROUP" }, { "disabled": true, "description": { "content": "Type of access for the request. (This can only be one of ACCESS_NONE,API,SQL,OKTA_LOGIN)", "type": "text/plain" }, "key": "filterOps.context.accessType", "value": "OKTA_LOGIN" }, { "disabled": true, "description": { "content": "IP Address of the client that made the request.", "type": "text/plain" }, "key": "filterOps.context.ipAddress", "value": "" }, { "disabled": true, "description": { "content": "HTTP Origin request header (including scheme, hostname, and port) of the request. Present only for browser-originated requests. Absent for server-to-server API calls.", "type": "text/plain" }, "key": "filterOps.context.origin", "value": "" }, { "disabled": true, "description": { "content": "Authentication mode the `actor` used. `OKTA_JWT`: Federated identity via Okta SSO. `SERVICE_ACCOUNT_JWT`: Service account JWT (machine-to-machine). `PAT_JWT`: Personal Access Token issued as a JWT. `API_KEY`: Static API key. (This can only be one of AUTH_NONE,OKTA_JWT,SERVICE_ACCOUNT_JWT,PAT_JWT,API_KEY,STS)", "type": "text/plain" }, "key": "filterOps.context.authMode", "value": "SERVICE_ACCOUNT_JWT" }, { "disabled": true, "description": { "content": "ID of the JWT token (the `jti` claim). Identifies the specific token used for this request.", "type": "text/plain" }, "key": "filterOps.context.jwtID", "value": "" }, { "disabled": true, "description": { "content": "User context embedded in the bearer token. Present when a bearer token encodes additional user context.", "type": "text/plain" }, "key": "filterOps.context.bearerTokenContextID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified parent account ID.", "type": "text/plain" }, "key": "filterOps.parentAccountID", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "filterOps.accountID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified workspace ID.", "type": "text/plain" }, "key": "filterOps.workspaceID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified vault ID.", "type": "text/plain" }, "key": "filterOps.vaultID", "value": "" }, { "disabled": true, "description": { "content": "Resources with a specified ID. If a resource matches at least one ID, the associated event is returned. Format is a comma-separated list of \"\\/\\\". For example, \"VAULT/12345, USER/67890\".", "type": "text/plain" }, "key": "filterOps.resourceIDs", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ec70e43-4209-43d2-a1e4-efe6a9e9cb14", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "audit", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "ID for the audit event. Use this to uniquely identify a specific audit record.", "type": "text/plain" }, "key": "filterOps.context.changeID", "value": "" }, { "disabled": true, "description": { "content": "ID for the request that caused the event. Use to correlate multiple audit events triggered by a single API request.", "type": "text/plain" }, "key": "filterOps.context.requestID", "value": "" }, { "disabled": true, "description": { "content": "ID for the session in which the request was sent. Present when a session context is available.", "type": "text/plain" }, "key": "filterOps.context.sessionID", "value": "" }, { "disabled": true, "description": { "content": "Member who sent the request. Depending on `actorType`, this may be a user ID or a service account ID. For users this is their email address.", "type": "text/plain" }, "key": "filterOps.context.actor", "value": "" }, { "disabled": true, "description": { "content": "Type of member who sent the request. (This can only be one of NONE,USER,GROUP,SERVICE_ACCOUNT,SQL_SERVICE_ACCOUNT)", "type": "text/plain" }, "key": "filterOps.context.actorType", "value": "GROUP" }, { "disabled": true, "description": { "content": "Type of access for the request. (This can only be one of ACCESS_NONE,API,SQL,OKTA_LOGIN)", "type": "text/plain" }, "key": "filterOps.context.accessType", "value": "OKTA_LOGIN" }, { "disabled": true, "description": { "content": "IP Address of the client that made the request.", "type": "text/plain" }, "key": "filterOps.context.ipAddress", "value": "" }, { "disabled": true, "description": { "content": "HTTP Origin request header (including scheme, hostname, and port) of the request. Present only for browser-originated requests. Absent for server-to-server API calls.", "type": "text/plain" }, "key": "filterOps.context.origin", "value": "" }, { "disabled": true, "description": { "content": "Authentication mode the `actor` used. `OKTA_JWT`: Federated identity via Okta SSO. `SERVICE_ACCOUNT_JWT`: Service account JWT (machine-to-machine). `PAT_JWT`: Personal Access Token issued as a JWT. `API_KEY`: Static API key. (This can only be one of AUTH_NONE,OKTA_JWT,SERVICE_ACCOUNT_JWT,PAT_JWT,API_KEY,STS)", "type": "text/plain" }, "key": "filterOps.context.authMode", "value": "SERVICE_ACCOUNT_JWT" }, { "disabled": true, "description": { "content": "ID of the JWT token (the `jti` claim). Identifies the specific token used for this request.", "type": "text/plain" }, "key": "filterOps.context.jwtID", "value": "" }, { "disabled": true, "description": { "content": "User context embedded in the bearer token. Present when a bearer token encodes additional user context.", "type": "text/plain" }, "key": "filterOps.context.bearerTokenContextID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified parent account ID.", "type": "text/plain" }, "key": "filterOps.parentAccountID", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "filterOps.accountID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified workspace ID.", "type": "text/plain" }, "key": "filterOps.workspaceID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified vault ID.", "type": "text/plain" }, "key": "filterOps.vaultID", "value": "" }, { "disabled": true, "description": { "content": "Resources with a specified ID. If a resource matches at least one ID, the associated event is returned. Format is a comma-separated list of \"\\/\\\". For example, \"VAULT/12345, USER/67890\".", "type": "text/plain" }, "key": "filterOps.resourceIDs", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Records", "description": "", "item": [ { "id": "026b7de4-6a45-4c2c-8958-4dbf6e52fa7d", "name": "Batch Operation", "request": { "name": "Batch Operation", "description": { "content": "Performs multiple record operations in a single transaction.", "type": "text/plain" }, "url": { "path": [ "v1", "vaults", ":vaultID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "vaultID", "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"tableName\": \"\",\n \"fields\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 7439.462303910427\n },\n \"method\": \"GET\",\n \"batchID\": \"\",\n \"redaction\": \"DEFAULT\",\n \"tokenization\": false,\n \"ID\": \"\",\n \"downloadURL\": false,\n \"upsert\": \"\",\n \"tokens\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": true\n },\n \"returnFileMetadata\": false\n },\n {\n \"tableName\": \"\",\n \"fields\": {\n \"key_0\": 6362.282330723548,\n \"key_1\": 8173.280167236297\n },\n \"method\": \"POST\",\n \"batchID\": \"\",\n \"redaction\": \"DEFAULT\",\n \"tokenization\": false,\n \"ID\": \"\",\n \"downloadURL\": false,\n \"upsert\": \"\",\n \"tokens\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"returnFileMetadata\": false\n }\n ],\n \"continueOnError\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "1d4998d6-0370-4a61-9ebd-153646ada3f8", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"tableName\": \"\",\n \"fields\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 7439.462303910427\n },\n \"method\": \"GET\",\n \"batchID\": \"\",\n \"redaction\": \"DEFAULT\",\n \"tokenization\": false,\n \"ID\": \"\",\n \"downloadURL\": false,\n \"upsert\": \"\",\n \"tokens\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": true\n },\n \"returnFileMetadata\": false\n },\n {\n \"tableName\": \"\",\n \"fields\": {\n \"key_0\": 6362.282330723548,\n \"key_1\": 8173.280167236297\n },\n \"method\": \"POST\",\n \"batchID\": \"\",\n \"redaction\": \"DEFAULT\",\n \"tokenization\": false,\n \"ID\": \"\",\n \"downloadURL\": false,\n \"upsert\": \"\",\n \"tokens\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"returnFileMetadata\": false\n }\n ],\n \"continueOnError\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"vaultID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4d4e33a-6752-44b0-9b09-994ea1368b30", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"tableName\": \"\",\n \"fields\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 7439.462303910427\n },\n \"method\": \"GET\",\n \"batchID\": \"\",\n \"redaction\": \"DEFAULT\",\n \"tokenization\": false,\n \"ID\": \"\",\n \"downloadURL\": false,\n \"upsert\": \"\",\n \"tokens\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": true\n },\n \"returnFileMetadata\": false\n },\n {\n \"tableName\": \"\",\n \"fields\": {\n \"key_0\": 6362.282330723548,\n \"key_1\": 8173.280167236297\n },\n \"method\": \"POST\",\n \"batchID\": \"\",\n \"redaction\": \"DEFAULT\",\n \"tokenization\": false,\n \"ID\": \"\",\n \"downloadURL\": false,\n \"upsert\": \"\",\n \"tokens\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"returnFileMetadata\": false\n }\n ],\n \"continueOnError\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8d1919a-a56f-4baf-bda1-e36320f021a8", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"tableName\": \"\",\n \"fields\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 7439.462303910427\n },\n \"method\": \"GET\",\n \"batchID\": \"\",\n \"redaction\": \"DEFAULT\",\n \"tokenization\": false,\n \"ID\": \"\",\n \"downloadURL\": false,\n \"upsert\": \"\",\n \"tokens\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": true\n },\n \"returnFileMetadata\": false\n },\n {\n \"tableName\": \"\",\n \"fields\": {\n \"key_0\": 6362.282330723548,\n \"key_1\": 8173.280167236297\n },\n \"method\": \"POST\",\n \"batchID\": \"\",\n \"redaction\": \"DEFAULT\",\n \"tokenization\": false,\n \"ID\": \"\",\n \"downloadURL\": false,\n \"upsert\": \"\",\n \"tokens\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"returnFileMetadata\": false\n }\n ],\n \"continueOnError\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20b1fcfc-4c2e-4c19-a6f0-827a689b9a44", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"tableName\": \"\",\n \"fields\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 7439.462303910427\n },\n \"method\": \"GET\",\n \"batchID\": \"\",\n \"redaction\": \"DEFAULT\",\n \"tokenization\": false,\n \"ID\": \"\",\n \"downloadURL\": false,\n \"upsert\": \"\",\n \"tokens\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": true\n },\n \"returnFileMetadata\": false\n },\n {\n \"tableName\": \"\",\n \"fields\": {\n \"key_0\": 6362.282330723548,\n \"key_1\": 8173.280167236297\n },\n \"method\": \"POST\",\n \"batchID\": \"\",\n \"redaction\": \"DEFAULT\",\n \"tokenization\": false,\n \"ID\": \"\",\n \"downloadURL\": false,\n \"upsert\": \"\",\n \"tokens\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"returnFileMetadata\": false\n }\n ],\n \"continueOnError\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6118ae47-bea0-4621-98ef-38bc2f0a2d91", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"tableName\": \"\",\n \"fields\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 7439.462303910427\n },\n \"method\": \"GET\",\n \"batchID\": \"\",\n \"redaction\": \"DEFAULT\",\n \"tokenization\": false,\n \"ID\": \"\",\n \"downloadURL\": false,\n \"upsert\": \"\",\n \"tokens\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": true\n },\n \"returnFileMetadata\": false\n },\n {\n \"tableName\": \"\",\n \"fields\": {\n \"key_0\": 6362.282330723548,\n \"key_1\": 8173.280167236297\n },\n \"method\": \"POST\",\n \"batchID\": \"\",\n \"redaction\": \"DEFAULT\",\n \"tokenization\": false,\n \"ID\": \"\",\n \"downloadURL\": false,\n \"upsert\": \"\",\n \"tokens\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"returnFileMetadata\": false\n }\n ],\n \"continueOnError\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "99df7700-7e67-4b1b-a4d9-081c9c14230e", "name": "Get Records", "request": { "name": "Get Records", "description": { "content": "Returns the specified records from a table.", "type": "text/plain" }, "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "skyflow_ids", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "skyflow_ids", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of DEFAULT,REDACTED,MASKED,PLAIN_TEXT)", "type": "text/plain" }, "key": "redaction", "value": "REDACTED" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "tokenization", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "downloadURL", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "column_name", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "column_values", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "column_values", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of ASCENDING,DESCENDING,NONE)", "type": "text/plain" }, "key": "order_by", "value": "DESCENDING" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "returnFileMetadata", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "vaultID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "objectName", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f991a194-31d5-4b34-b362-1ce4243219ea", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "skyflow_ids", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of DEFAULT,REDACTED,MASKED,PLAIN_TEXT)", "type": "text/plain" }, "key": "redaction", "value": "REDACTED" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "tokenization", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "downloadURL", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "column_name", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "column_values", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of ASCENDING,DESCENDING,NONE)", "type": "text/plain" }, "key": "order_by", "value": "DESCENDING" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "returnFileMetadata", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"records\": [\n {\n \"fields\": {\n \"key_0\": 3265,\n \"key_1\": 7878.953056583385\n },\n \"tokens\": {\n \"key_0\": \"string\",\n \"key_1\": 738,\n \"key_2\": false\n },\n \"fileMetadata\": {\n \"key_0\": {\n \"fileName\": \"\",\n \"fileSizeKB\": \"\",\n \"fileType\": \"\"\n },\n \"key_1\": {\n \"fileName\": \"\",\n \"fileSizeKB\": \"\",\n \"fileType\": \"\"\n },\n \"key_2\": {\n \"fileName\": \"\",\n \"fileSizeKB\": \"\",\n \"fileType\": \"\"\n }\n }\n },\n {\n \"fields\": {\n \"key_0\": 2260,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"tokens\": {\n \"key_0\": 5051\n },\n \"fileMetadata\": {\n \"key_0\": {\n \"fileName\": \"\",\n \"fileSizeKB\": \"\",\n \"fileType\": \"\"\n },\n \"key_1\": {\n \"fileName\": \"\",\n \"fileSizeKB\": \"\",\n \"fileType\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45133ae2-56d7-47a6-8691-de3213e0ad12", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "skyflow_ids", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of DEFAULT,REDACTED,MASKED,PLAIN_TEXT)", "type": "text/plain" }, "key": "redaction", "value": "REDACTED" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "tokenization", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "downloadURL", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "column_name", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "column_values", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of ASCENDING,DESCENDING,NONE)", "type": "text/plain" }, "key": "order_by", "value": "DESCENDING" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "returnFileMetadata", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acd5c246-558c-4d36-9803-78e4cdb5ed35", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "skyflow_ids", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of DEFAULT,REDACTED,MASKED,PLAIN_TEXT)", "type": "text/plain" }, "key": "redaction", "value": "REDACTED" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "tokenization", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "downloadURL", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "column_name", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "column_values", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of ASCENDING,DESCENDING,NONE)", "type": "text/plain" }, "key": "order_by", "value": "DESCENDING" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "returnFileMetadata", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56a699d7-425d-4538-b206-e11c8eb1e68d", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "skyflow_ids", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of DEFAULT,REDACTED,MASKED,PLAIN_TEXT)", "type": "text/plain" }, "key": "redaction", "value": "REDACTED" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "tokenization", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "downloadURL", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "column_name", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "column_values", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of ASCENDING,DESCENDING,NONE)", "type": "text/plain" }, "key": "order_by", "value": "DESCENDING" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "returnFileMetadata", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8438acf2-f40a-4fc5-8ec6-69e26da5bfa3", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "skyflow_ids", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of DEFAULT,REDACTED,MASKED,PLAIN_TEXT)", "type": "text/plain" }, "key": "redaction", "value": "REDACTED" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "tokenization", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "downloadURL", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "column_name", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "column_values", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of ASCENDING,DESCENDING,NONE)", "type": "text/plain" }, "key": "order_by", "value": "DESCENDING" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "returnFileMetadata", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9a683e7d-0184-4ea7-b700-bea737e4cc9e", "name": "Insert Records", "request": { "name": "Insert Records", "description": { "content": "Inserts a record in the specified table.

The time-to-live (TTL) for a transient field begins when the field value is set during record insertion.

Columns that have a string data type and a uniqueness constraint accept strings up to 2500 characters. If an inserted string exceeds 2500 characters, the call returns a token insertion error.", "type": "text/plain" }, "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "vaultID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "objectName", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"fields\": {\n \"key_0\": 2581,\n \"key_1\": false\n },\n \"tokens\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"fields\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"tokens\": {\n \"key_0\": 3845,\n \"key_1\": 1211.1560232414577\n }\n }\n ],\n \"tokenization\": false,\n \"upsert\": \"\",\n \"homogeneous\": false,\n \"byot\": \"DISABLE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6c97dffb-2fdf-4152-8350-a8924bd77e3c", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"fields\": {\n \"key_0\": 2581,\n \"key_1\": false\n },\n \"tokens\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"fields\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"tokens\": {\n \"key_0\": 3845,\n \"key_1\": 1211.1560232414577\n }\n }\n ],\n \"tokenization\": false,\n \"upsert\": \"\",\n \"homogeneous\": false,\n \"byot\": \"DISABLE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"records\": [\n {\n \"skyflow_id\": \"\",\n \"tokens\": {}\n },\n {\n \"skyflow_id\": \"\",\n \"tokens\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "178fd084-f7cf-4aaa-a8d6-6546e37ff738", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"fields\": {\n \"key_0\": 2581,\n \"key_1\": false\n },\n \"tokens\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"fields\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"tokens\": {\n \"key_0\": 3845,\n \"key_1\": 1211.1560232414577\n }\n }\n ],\n \"tokenization\": false,\n \"upsert\": \"\",\n \"homogeneous\": false,\n \"byot\": \"DISABLE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce7e5d87-2899-4e46-99d2-be01cd02b71b", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"fields\": {\n \"key_0\": 2581,\n \"key_1\": false\n },\n \"tokens\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"fields\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"tokens\": {\n \"key_0\": 3845,\n \"key_1\": 1211.1560232414577\n }\n }\n ],\n \"tokenization\": false,\n \"upsert\": \"\",\n \"homogeneous\": false,\n \"byot\": \"DISABLE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1140c38b-76eb-447b-b8df-c7008265b2bc", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"fields\": {\n \"key_0\": 2581,\n \"key_1\": false\n },\n \"tokens\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"fields\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"tokens\": {\n \"key_0\": 3845,\n \"key_1\": 1211.1560232414577\n }\n }\n ],\n \"tokenization\": false,\n \"upsert\": \"\",\n \"homogeneous\": false,\n \"byot\": \"DISABLE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ddba0337-6b26-4cc8-be30-e8fa3590143b", "name": "Delete Records", "request": { "name": "Delete Records", "description": { "content": "Deletes the specified records from a table.", "type": "text/plain" }, "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "vaultID", "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "objectName", "disabled": false, "description": { "content": "(Required) Name of the table.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"skyflow_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "eeab1b9c-6e02-40a5-a7be-7dcc42362059", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) Name of the table.", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"skyflow_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"RecordIDResponse\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "302d0314-3b9d-4704-80dd-386bb1857e3f", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) Name of the table.", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"skyflow_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9560483a-9678-45b4-bbe3-ca93ab48f22e", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) Name of the table.", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"skyflow_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02ab72a9-b6f3-4b16-bbf6-dbd513ece678", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) Name of the table.", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"skyflow_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96414c44-17ca-4015-99a1-95f00ecdcd7b", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) Name of the table.", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"skyflow_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "711bd41a-c556-48b4-8680-9f81328ef3d1", "name": "Get Record By ID", "request": { "name": "Get Record By ID", "description": { "content": "Returns the specified record from a table.", "type": "text/plain" }, "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": " (This can only be one of DEFAULT,REDACTED,MASKED,PLAIN_TEXT)", "type": "text/plain" }, "key": "redaction", "value": "REDACTED" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "tokenization", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "downloadURL", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "returnFileMetadata", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "vaultID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "objectName", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6c0ee6f6-6751-4469-8279-a0eecc12c48c", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": " (This can only be one of DEFAULT,REDACTED,MASKED,PLAIN_TEXT)", "type": "text/plain" }, "key": "redaction", "value": "REDACTED" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "tokenization", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "downloadURL", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "returnFileMetadata", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"fields\": {\n \"key_0\": \"string\"\n },\n \"tokens\": {\n \"key_0\": 1177.4637098927453,\n \"key_1\": \"string\",\n \"key_2\": 4235\n },\n \"fileMetadata\": {\n \"key_0\": {\n \"fileName\": \"\",\n \"fileSizeKB\": \"\",\n \"fileType\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77f15a73-ac8e-40d0-9e85-63ca72ee820b", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": " (This can only be one of DEFAULT,REDACTED,MASKED,PLAIN_TEXT)", "type": "text/plain" }, "key": "redaction", "value": "REDACTED" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "tokenization", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "downloadURL", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "returnFileMetadata", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e11fe426-2d0e-4e43-9b15-a5a6e7b9e5d4", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": " (This can only be one of DEFAULT,REDACTED,MASKED,PLAIN_TEXT)", "type": "text/plain" }, "key": "redaction", "value": "REDACTED" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "tokenization", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "downloadURL", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "returnFileMetadata", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb0ce829-55ec-4bf6-a4e9-bb6c3c7cb32f", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": " (This can only be one of DEFAULT,REDACTED,MASKED,PLAIN_TEXT)", "type": "text/plain" }, "key": "redaction", "value": "REDACTED" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "tokenization", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "downloadURL", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "returnFileMetadata", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1628f07a-9dff-41b1-a6d2-93a822ecee39", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": " (This can only be one of DEFAULT,REDACTED,MASKED,PLAIN_TEXT)", "type": "text/plain" }, "key": "redaction", "value": "REDACTED" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "tokenization", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "downloadURL", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "returnFileMetadata", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "06be0dc1-9256-43e3-a0d4-727c3de2694e", "name": "Update Record", "request": { "name": "Update Record", "description": { "content": "Updates the specified record in a table.

When you update a field, include the entire contents you want the field to store. For JSON fields, include all nested fields and values. If a nested field isn't included, it's removed.

The time-to-live (TTL) for a transient field resets when the field value is updated.", "type": "text/plain" }, "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "vaultID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "objectName", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"record\": {\n \"fields\": {\n \"key_0\": \"string\"\n },\n \"tokens\": {\n \"key_0\": 3122,\n \"key_1\": false\n }\n },\n \"tokenization\": false,\n \"byot\": \"DISABLE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9cda8ea4-af02-4727-bdf3-9563e6055cdf", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"record\": {\n \"fields\": {\n \"key_0\": \"string\"\n },\n \"tokens\": {\n \"key_0\": 3122,\n \"key_1\": false\n }\n },\n \"tokenization\": false,\n \"byot\": \"DISABLE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"skyflow_id\": \"\",\n \"tokens\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc11351a-d940-4c9d-b086-b18aa10018e9", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"record\": {\n \"fields\": {\n \"key_0\": \"string\"\n },\n \"tokens\": {\n \"key_0\": 3122,\n \"key_1\": false\n }\n },\n \"tokenization\": false,\n \"byot\": \"DISABLE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd77b745-686c-4843-a710-8cb7ebbe9448", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"record\": {\n \"fields\": {\n \"key_0\": \"string\"\n },\n \"tokens\": {\n \"key_0\": 3122,\n \"key_1\": false\n }\n },\n \"tokenization\": false,\n \"byot\": \"DISABLE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "684b66d2-8b31-4270-a1c5-8eb6b5e146f3", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"record\": {\n \"fields\": {\n \"key_0\": \"string\"\n },\n \"tokens\": {\n \"key_0\": 3122,\n \"key_1\": false\n }\n },\n \"tokenization\": false,\n \"byot\": \"DISABLE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a5897f4-07d2-4437-92c4-356c33d118a2", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"record\": {\n \"fields\": {\n \"key_0\": \"string\"\n },\n \"tokens\": {\n \"key_0\": 3122,\n \"key_1\": false\n }\n },\n \"tokenization\": false,\n \"byot\": \"DISABLE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2eaa319f-30f6-4e37-b433-e6bfdd92cbfd", "name": "Delete Record", "request": { "name": "Delete Record", "description": { "content": "Deletes the specified record from a table.

Note: This method doesn't delete transient field tokens. Transient field values are available until they expire based on the fields' time-to-live (TTL) setting.", "type": "text/plain" }, "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "vaultID", "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "objectName", "disabled": false, "description": { "content": "(Required) Name of the table.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) `skyflow_id` of the record to delete.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "0153d69b-97d0-40e0-9ca2-7fdb1474381a", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) Name of the table.", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" }, { "disabled": false, "description": { "content": "(Required) `skyflow_id` of the record to delete.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"skyflow_id\": \"\",\n \"deleted\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0c24091-8c8e-4348-994b-f635a370a566", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) Name of the table.", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" }, { "disabled": false, "description": { "content": "(Required) `skyflow_id` of the record to delete.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43ecccf6-18ef-4ffd-bf61-6945437f7bb5", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) Name of the table.", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" }, { "disabled": false, "description": { "content": "(Required) `skyflow_id` of the record to delete.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8345896e-9611-490f-89b2-4035b31c0701", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) Name of the table.", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" }, { "disabled": false, "description": { "content": "(Required) `skyflow_id` of the record to delete.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f92bc773-0a14-4f57-a4c5-2ea6a1747521", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) Name of the table.", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" }, { "disabled": false, "description": { "content": "(Required) `skyflow_id` of the record to delete.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Tokens", "description": "", "item": [ { "id": "ea4953d7-ec06-437a-933a-5443704c2a87", "name": "Detokenize", "request": { "name": "Detokenize", "description": { "content": "Returns records that correspond to the specified tokens.", "type": "text/plain" }, "url": { "path": [ "v1", "vaults", ":vaultID", "detokenize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "vaultID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"detokenizationParameters\": [\n {\n \"token\": \"\",\n \"redaction\": \"DEFAULT\"\n },\n {\n \"token\": \"\",\n \"redaction\": \"DEFAULT\"\n }\n ],\n \"downloadURL\": false,\n \"continueOnError\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "0fedf96b-6e87-410f-8adb-524b69bafa68", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", "detokenize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"detokenizationParameters\": [\n {\n \"token\": \"\",\n \"redaction\": \"DEFAULT\"\n },\n {\n \"token\": \"\",\n \"redaction\": \"DEFAULT\"\n }\n ],\n \"downloadURL\": false,\n \"continueOnError\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"records\": [\n {\n \"token\": \"\",\n \"valueType\": \"DATETIME\",\n \"value\": \"\",\n \"error\": \"\"\n },\n {\n \"token\": \"\",\n \"valueType\": \"DATE\",\n \"value\": \"\",\n \"error\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19d5e509-d070-4b6f-85b1-c05b0c90671c", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", "detokenize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"detokenizationParameters\": [\n {\n \"token\": \"\",\n \"redaction\": \"DEFAULT\"\n },\n {\n \"token\": \"\",\n \"redaction\": \"DEFAULT\"\n }\n ],\n \"downloadURL\": false,\n \"continueOnError\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "083a43a9-1983-437c-8022-cf5c5de0882e", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", "detokenize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"detokenizationParameters\": [\n {\n \"token\": \"\",\n \"redaction\": \"DEFAULT\"\n },\n {\n \"token\": \"\",\n \"redaction\": \"DEFAULT\"\n }\n ],\n \"downloadURL\": false,\n \"continueOnError\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "864c0ea8-dff8-4502-baf6-9c01c4fd4df4", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", "detokenize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"detokenizationParameters\": [\n {\n \"token\": \"\",\n \"redaction\": \"DEFAULT\"\n },\n {\n \"token\": \"\",\n \"redaction\": \"DEFAULT\"\n }\n ],\n \"downloadURL\": false,\n \"continueOnError\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0dec20c8-ef10-4e3b-8036-693adca27a1f", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", "detokenize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"detokenizationParameters\": [\n {\n \"token\": \"\",\n \"redaction\": \"DEFAULT\"\n },\n {\n \"token\": \"\",\n \"redaction\": \"DEFAULT\"\n }\n ],\n \"downloadURL\": false,\n \"continueOnError\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2fde2431-ccf5-4237-a62e-8ed2f2e1bc0e", "name": "Tokenize", "request": { "name": "Tokenize", "description": { "content": "Returns tokens that correspond to the specified records. Only applicable for fields with deterministic tokenization.

Note: This endpoint doesn't insert records—it returns tokens for existing values. To insert records and return tokens for that new record's values, see Insert Records' `tokenization` parameter.", "type": "text/plain" }, "url": { "path": [ "v1", "vaults", ":vaultID", "tokenize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "vaultID", "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tokenizationParameters\": [\n {\n \"value\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"columnGroup\": \"\"\n },\n {\n \"value\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"columnGroup\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "05eeeba8-e9f2-4d51-8a3d-afa5624d8b5c", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", "tokenize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tokenizationParameters\": [\n {\n \"value\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"columnGroup\": \"\"\n },\n {\n \"value\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"columnGroup\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"records\": [\n {\n \"token\": \"\"\n },\n {\n \"token\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22354e01-e805-4287-a64e-4a1a0c5017c1", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", "tokenize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tokenizationParameters\": [\n {\n \"value\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"columnGroup\": \"\"\n },\n {\n \"value\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"columnGroup\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6882f63-14a7-4c5a-b843-823518519bf7", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", "tokenize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tokenizationParameters\": [\n {\n \"value\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"columnGroup\": \"\"\n },\n {\n \"value\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"columnGroup\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d946455f-265f-42a2-8964-54fcd3b55a93", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", "tokenize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tokenizationParameters\": [\n {\n \"value\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"columnGroup\": \"\"\n },\n {\n \"value\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"columnGroup\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c16cdbc9-f107-4b4b-9e9c-71b50c59132b", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", "tokenize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tokenizationParameters\": [\n {\n \"value\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"columnGroup\": \"\"\n },\n {\n \"value\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"columnGroup\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Query", "description": "", "item": [ { "id": "888eb7e4-9ac3-403a-b67e-4a15e3ba6496", "name": "Execute Query", "request": { "name": "Execute Query", "description": { "content": "Returns records for a valid SQL query. This endpoint
  • 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.
      • ", "type": "text/plain" }, "url": { "path": [ "v1", "vaults", ":vaultID", "query" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "vaultID", "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c2a6e429-ada8-4f39-920a-aac2b5ff0e2b", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", "query" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"records\": [\n {\n \"fields\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": 1549\n },\n \"tokens\": {\n \"key_0\": 8413.099374431646\n }\n },\n {\n \"fields\": {\n \"key_0\": 3935.194789379519\n },\n \"tokens\": {\n \"key_0\": 7861,\n \"key_1\": 4977.097589294625,\n \"key_2\": 5561,\n \"key_3\": 3537.0022324759366\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65af4884-6eea-448a-b9b2-ada5c2b4117f", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", "query" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f272e2b-753b-4d4c-81c1-a5c3ba6b0c04", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", "query" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1caacafe-9732-4b16-a3d7-38596906ff48", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", "query" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Files", "description": "", "item": [ { "id": "159bf45b-85a5-4e36-83a4-1b487a2c15e7", "name": "Upload File", "request": { "name": "Upload File", "description": { "content": "Uploads a file to the specified record.", "type": "text/plain" }, "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName", ":ID", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "vaultID", "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "objectName", "disabled": false, "description": { "content": "(Required) Name of the table.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) `skyflow_id` of the record.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "The key for `fileColumnName` is the name of the column to store the file in, which must have a `file` data type. The value is the file to upload.", "type": "text/plain" }, "key": "fileColumnName", "type": "file" } ] }, "auth": null }, "response": [ { "id": "cacfe4da-1a87-46fd-9044-ad74e023af6c", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName", ":ID", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) Name of the table.", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" }, { "disabled": false, "description": { "content": "(Required) `skyflow_id` of the record.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "The key for `fileColumnName` is the name of the column to store the file in, which must have a `file` data type. The value is the file to upload.", "type": "text/plain" }, "key": "fileColumnName", "type": "file" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"skyflow_id\": \"\",\n \"tokens\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27e22414-9dec-41ad-b2ef-d3b92b2c7201", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName", ":ID", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) Name of the table.", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" }, { "disabled": false, "description": { "content": "(Required) `skyflow_id` of the record.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "The key for `fileColumnName` is the name of the column to store the file in, which must have a `file` data type. The value is the file to upload.", "type": "text/plain" }, "key": "fileColumnName", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1152cd75-fc1b-43e6-ab6d-4f5ecd4db01e", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName", ":ID", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) Name of the table.", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" }, { "disabled": false, "description": { "content": "(Required) `skyflow_id` of the record.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "The key for `fileColumnName` is the name of the column to store the file in, which must have a `file` data type. The value is the file to upload.", "type": "text/plain" }, "key": "fileColumnName", "type": "file" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "961ff650-058c-4b3a-b234-b232a3edf90c", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":objectName", ":ID", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) Name of the table.", "type": "text/plain" }, "type": "any", "value": "", "key": "objectName" }, { "disabled": false, "description": { "content": "(Required) `skyflow_id` of the record.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "The key for `fileColumnName` is the name of the column to store the file in, which must have a `file` data type. The value is the file to upload.", "type": "text/plain" }, "key": "fileColumnName", "type": "file" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c44b7efb-7dcf-4f26-b45d-8c1d7870d93a", "name": "Delete File", "request": { "name": "Delete File", "description": { "content": "Deletes a file from a specified record.", "type": "text/plain" }, "url": { "path": [ "v1", "vaults", ":vaultID", ":tableName", ":ID", "files", ":columnName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "vaultID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "tableName", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "columnName", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "f5481f06-1f99-4954-b976-eef8a6078d0e", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":tableName", ":ID", "files", ":columnName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "tableName" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "columnName" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"skyflow_id\": \"\",\n \"deleted\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "228376ae-aa32-48e7-9450-36f0f6317490", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":tableName", ":ID", "files", ":columnName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "tableName" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "columnName" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fe51834-bf31-4d96-9445-74a8828be838", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":tableName", ":ID", "files", ":columnName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "tableName" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "columnName" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5666e52f-aa0e-4196-955c-f77093927c2a", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":tableName", ":ID", "files", ":columnName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "tableName" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "columnName" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0007d581-270a-46af-8e81-633e8dfb0169", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":tableName", ":ID", "files", ":columnName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "tableName" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "columnName" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6298a5cb-b386-4a52-994a-f44e42198ab8", "name": "Get File Scan Status", "request": { "name": "Get File Scan Status", "description": { "content": "Returns the anti-virus scan status of a file.", "type": "text/plain" }, "url": { "path": [ "v1", "vaults", ":vaultID", ":tableName", ":ID", "files", ":columnName", "scan-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "vaultID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "tableName", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "columnName", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6401e8ef-426f-4e61-b71c-53465bb7eaa4", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":tableName", ":ID", "files", ":columnName", "scan-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "tableName" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "columnName" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"file_status\": \"undefined\",\n \"av_scan_status\": \"SCAN_ERROR\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "798fab23-a9b3-4b68-ac20-e9e5394b6d00", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":tableName", ":ID", "files", ":columnName", "scan-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "tableName" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "columnName" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a453190-72c3-4d01-b6d5-a1fc52c10407", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":tableName", ":ID", "files", ":columnName", "scan-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "tableName" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "columnName" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2bb3419-7bc4-49a4-898c-dad0e67dd927", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", ":tableName", ":ID", "files", ":columnName", "scan-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "tableName" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "columnName" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "80149246-ec2c-451b-bb9b-8bb76eba8766", "name": "Upload File", "request": { "name": "Upload File", "description": { "content": "Uploads a file to a new or specified record.", "type": "text/plain" }, "url": { "path": [ "v2", "vaults", ":vaultID", "files", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "vaultID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Name of the table.", "type": "text/plain" }, "key": "tableName", "value": "", "type": "text" }, { "description": { "content": "(Required) Name of the column that contains the file.", "type": "text/plain" }, "key": "columnName", "value": "", "type": "text" }, { "description": { "content": "(Required) Path of the file to upload. Each request only supports one file.", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "ID of the record to update.", "type": "text/plain" }, "key": "skyflowID", "value": "", "type": "text" }, { "description": { "content": "If `true`, returns metadata about the uploaded file.", "type": "text/plain" }, "key": "returnFileMetadata", "value": "false", "type": "text" } ] }, "auth": null }, "response": [ { "id": "3c3d9f01-75b3-4da5-9d56-ca148b1d8b86", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "vaults", ":vaultID", "files", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Name of the table.", "type": "text/plain" }, "key": "tableName", "value": "", "type": "text" }, { "description": { "content": "(Required) Name of the column that contains the file.", "type": "text/plain" }, "key": "columnName", "value": "", "type": "text" }, { "description": { "content": "(Required) Path of the file to upload. Each request only supports one file.", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "ID of the record to update.", "type": "text/plain" }, "key": "skyflowID", "value": "", "type": "text" }, { "description": { "content": "If `true`, returns metadata about the uploaded file.", "type": "text/plain" }, "key": "returnFileMetadata", "value": "false", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"skyflowID\": \"\",\n \"fileMetadata\": {\n \"key_0\": {\n \"fileName\": \"\",\n \"fileSizeKB\": \"\",\n \"fileType\": \"\"\n },\n \"key_1\": {\n \"fileName\": \"\",\n \"fileSizeKB\": \"\",\n \"fileType\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cabac56-b0aa-4bd2-8edc-aa8b06ecdb40", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v2", "vaults", ":vaultID", "files", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Name of the table.", "type": "text/plain" }, "key": "tableName", "value": "", "type": "text" }, { "description": { "content": "(Required) Name of the column that contains the file.", "type": "text/plain" }, "key": "columnName", "value": "", "type": "text" }, { "description": { "content": "(Required) Path of the file to upload. Each request only supports one file.", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "ID of the record to update.", "type": "text/plain" }, "key": "skyflowID", "value": "", "type": "text" }, { "description": { "content": "If `true`, returns metadata about the uploaded file.", "type": "text/plain" }, "key": "returnFileMetadata", "value": "false", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4783eeb7-03cf-4344-be98-85d462859d2c", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v2", "vaults", ":vaultID", "files", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Name of the table.", "type": "text/plain" }, "key": "tableName", "value": "", "type": "text" }, { "description": { "content": "(Required) Name of the column that contains the file.", "type": "text/plain" }, "key": "columnName", "value": "", "type": "text" }, { "description": { "content": "(Required) Path of the file to upload. Each request only supports one file.", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "ID of the record to update.", "type": "text/plain" }, "key": "skyflowID", "value": "", "type": "text" }, { "description": { "content": "If `true`, returns metadata about the uploaded file.", "type": "text/plain" }, "key": "returnFileMetadata", "value": "false", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5999d367-5081-4f70-82e6-8bb1449976fa", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v2", "vaults", ":vaultID", "files", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Name of the table.", "type": "text/plain" }, "key": "tableName", "value": "", "type": "text" }, { "description": { "content": "(Required) Name of the column that contains the file.", "type": "text/plain" }, "key": "columnName", "value": "", "type": "text" }, { "description": { "content": "(Required) Path of the file to upload. Each request only supports one file.", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "ID of the record to update.", "type": "text/plain" }, "key": "skyflowID", "value": "", "type": "text" }, { "description": { "content": "If `true`, returns metadata about the uploaded file.", "type": "text/plain" }, "key": "returnFileMetadata", "value": "false", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2fe6a54-c4ae-461f-8867-c12b7b35343b", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v2", "vaults", ":vaultID", "files", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Name of the table.", "type": "text/plain" }, "key": "tableName", "value": "", "type": "text" }, { "description": { "content": "(Required) Name of the column that contains the file.", "type": "text/plain" }, "key": "columnName", "value": "", "type": "text" }, { "description": { "content": "(Required) Path of the file to upload. Each request only supports one file.", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "ID of the record to update.", "type": "text/plain" }, "key": "skyflowID", "value": "", "type": "text" }, { "description": { "content": "If `true`, returns metadata about the uploaded file.", "type": "text/plain" }, "key": "returnFileMetadata", "value": "false", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d454a6e8-6afb-476e-9fc9-5fa881754878", "name": "Get Files Upload Status", "request": { "name": "Get Files Upload Status", "description": { "content": "Returns the upload and scan status for the specified file columns across multiple records.", "type": "text/plain" }, "url": { "path": [ "v2", "vaults", ":vaultID", "files", "uploadStatus" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "vaultID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"tableName\": \"\",\n \"skyflowID\": \"\",\n \"fileColumns\": [\n \"\",\n \"\"\n ]\n },\n {\n \"tableName\": \"\",\n \"skyflowID\": \"\",\n \"fileColumns\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "321cde9f-e563-4ef7-acce-97385d6a03d0", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "vaults", ":vaultID", "files", "uploadStatus" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"tableName\": \"\",\n \"skyflowID\": \"\",\n \"fileColumns\": [\n \"\",\n \"\"\n ]\n },\n {\n \"tableName\": \"\",\n \"skyflowID\": \"\",\n \"fileColumns\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"records\": [\n {\n \"fields\": {},\n \"tableName\": \"\",\n \"error\": \"\",\n \"http_code\": \"\"\n },\n {\n \"fields\": {},\n \"tableName\": \"\",\n \"error\": \"\",\n \"http_code\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd2ae41e-1222-4325-9b3a-fd45f3f23712", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v2", "vaults", ":vaultID", "files", "uploadStatus" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"tableName\": \"\",\n \"skyflowID\": \"\",\n \"fileColumns\": [\n \"\",\n \"\"\n ]\n },\n {\n \"tableName\": \"\",\n \"skyflowID\": \"\",\n \"fileColumns\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "401a4f55-a87b-48b5-9248-fc0aef8aa7db", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v2", "vaults", ":vaultID", "files", "uploadStatus" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"tableName\": \"\",\n \"skyflowID\": \"\",\n \"fileColumns\": [\n \"\",\n \"\"\n ]\n },\n {\n \"tableName\": \"\",\n \"skyflowID\": \"\",\n \"fileColumns\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "591c9f19-3be5-424f-bfae-5c8084463504", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v2", "vaults", ":vaultID", "files", "uploadStatus" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"tableName\": \"\",\n \"skyflowID\": \"\",\n \"fileColumns\": [\n \"\",\n \"\"\n ]\n },\n {\n \"tableName\": \"\",\n \"skyflowID\": \"\",\n \"fileColumns\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf285421-124b-4590-a48e-d504903b5573", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v2", "vaults", ":vaultID", "files", "uploadStatus" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"tableName\": \"\",\n \"skyflowID\": \"\",\n \"fileColumns\": [\n \"\",\n \"\"\n ]\n },\n {\n \"tableName\": \"\",\n \"skyflowID\": \"\",\n \"fileColumns\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 3655,\n \"key_1\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 4493,\n \"key_2\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "event": [], "variable": [ { "key": "token", "value": "", "type": "string" }, { "key": "accountID", "value": "", "type": "string" }, { "key": "vaultURL", "value": "", "type": "string" }, { "key": "baseUrl", "value": "{{vaultURL}}" } ], "info": { "_postman_id": "ac912265-e0d7-47bc-ab37-5aa65e786dd2", "name": "Data API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "This API inserts, retrieves, and otherwise manages data in a vault.\n\nThe Data API is available from two base URIs. *identifier* is the identifier in your vault's URL.
      • Sandbox: https://*identifier*.vault.skyflowapis-preview.com
      • Production: https://*identifier*.vault.skyflowapis.com
      \n\nWhen you make an API call, you need to add a header:
      HeaderValueExample
      AuthorizationA Bearer Token. See API Authentication.Authorization: Bearer eyJhbGciOiJSUzI...1NiIsJdfPA
      ", "type": "text/plain" } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] } }