{ "openapi": "3.0.3", "info": { "title": "Data API", "description": "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.\n\nWhen you make an API call, you need to add a header:
HeaderValueExample
AuthorizationA Bearer Token. See API Authentication.Authorization: Bearer eyJhbGciOiJSUzI...1NiIsJdfPA
", "license": { "name": "Proprietary", "url": "https://docs.skyflow.com" }, "version": "2026.06" }, "servers": [ { "url": "https://{identifier}.vault.skyflowapis.com", "description": "Production", "variables": { "identifier": { "default": "{{vault_uri}}", "description": "The unique identifier for the vault." } } }, { "url": "https://{identifier}.vault.skyflowapis-preview.com", "description": "Sandbox", "variables": { "identifier": { "default": "{{vault_uri}}", "description": "The unique identifier for the vault." } } } ], "externalDocs": { "description": "Guides, tutorials, and references for using Skyflow.", "url": "https://docs.skyflow.com/" }, "paths": { "/v1/audit/events": { "get": { "tags": [ "Audit" ], "summary": "List Data Audit Events", "description": "Lists data audit events that match query parameters.", "operationId": "list_data_audit_events", "parameters": [ { "name": "filterOps.context.changeID", "in": "query", "description": "ID for the audit event. Use this to uniquely identify a specific audit record.", "schema": { "type": "string" } }, { "name": "filterOps.context.requestID", "in": "query", "description": "ID for the request that caused the event. Use to correlate multiple audit events triggered by a single API request.", "schema": { "type": "string" } }, { "name": "filterOps.context.sessionID", "in": "query", "description": "ID for the session in which the request was sent. Present when a session context is available.", "schema": { "type": "string" } }, { "name": "filterOps.context.actor", "in": "query", "description": "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.", "schema": { "type": "string" } }, { "name": "filterOps.context.actorType", "in": "query", "description": "Type of member who sent the request.", "schema": { "enum": [ "NONE", "USER", "GROUP", "SERVICE_ACCOUNT", "SQL_SERVICE_ACCOUNT" ], "type": "string", "format": "enum" } }, { "name": "filterOps.context.accessType", "in": "query", "description": "Type of access for the request.", "schema": { "enum": [ "ACCESS_NONE", "API", "SQL", "OKTA_LOGIN" ], "type": "string", "format": "enum" } }, { "name": "filterOps.context.ipAddress", "in": "query", "description": "IP Address of the client that made the request.", "schema": { "type": "string" } }, { "name": "filterOps.context.origin", "in": "query", "description": "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.", "schema": { "type": "string" } }, { "name": "filterOps.context.authMode", "in": "query", "description": "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.", "schema": { "enum": [ "AUTH_NONE", "OKTA_JWT", "SERVICE_ACCOUNT_JWT", "PAT_JWT", "API_KEY", "STS" ], "type": "string", "format": "enum" } }, { "name": "filterOps.context.jwtID", "in": "query", "description": "ID of the JWT token (the `jti` claim). Identifies the specific token used for this request.", "schema": { "type": "string" } }, { "name": "filterOps.context.bearerTokenContextID", "in": "query", "description": "User context embedded in the bearer token. Present when a bearer token encodes additional user context.", "schema": { "type": "string" } }, { "name": "filterOps.parentAccountID", "in": "query", "description": "Resources with the specified parent account ID.", "schema": { "type": "string" } }, { "name": "filterOps.accountID", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "filterOps.workspaceID", "in": "query", "description": "Resources with the specified workspace ID.", "schema": { "type": "string" } }, { "name": "filterOps.vaultID", "in": "query", "description": "Resources with the specified vault ID.", "schema": { "type": "string" } }, { "name": "filterOps.resourceIDs", "in": "query", "description": "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\".", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditResponse" } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/x-request-id" } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" }, "500": { "$ref": "#/components/responses/500" } }, "security": [ { "Bearer": [] } ], "x-external-query-parameters": [ "filterOps.accountID", "filterOps.context.actor", "filterOps.context.actorType", "filterOps.context.accessType", "filterOps.context.authMode", "filterOps.context.bearerTokenContextID", "filterOps.context.changeID", "filterOps.context.ipAddress", "filterOps.context.jwtID", "filterOps.context.origin", "filterOps.context.requestID", "filterOps.context.sessionID", "filterOps.parentAccountID", "filterOps.resourceIDs", "filterOps.workspaceID", "filterOps.vaultID" ], "x-required-query-parameters": [ "filterOps.accountID" ], "x-fern-audiences": [ "external" ] } }, "/v1/vaults/{vaultID}": { "post": { "tags": [ "Records" ], "summary": "Batch Operation", "description": "Performs multiple record operations in a single transaction.", "operationId": "batch_operation", "parameters": [ { "name": "vaultID", "in": "path", "description": "ID of the vault.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/x-request-id" } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" }, "500": { "$ref": "#/components/responses/500" } }, "security": [ { "Bearer": [] } ], "x-fern-audiences": [ "external" ] } }, "/v1/vaults/{vaultID}/detokenize": { "post": { "tags": [ "Tokens" ], "summary": "Detokenize", "description": "Returns records that correspond to the specified tokens.", "operationId": "detokenize", "parameters": [ { "name": "vaultID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DetokenizePayload" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DetokenizeResponse" } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/x-request-id" } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" }, "500": { "$ref": "#/components/responses/500" } }, "security": [ { "Bearer": [] } ], "x-fern-audiences": [ "external" ] } }, "/v1/vaults/{vaultID}/query": { "post": { "tags": [ "Query" ], "summary": "Execute Query", "description": "Returns records for a valid SQL query. This endpoint