n8n

openapi: 3.0.0 info: title: n8n Public API description: n8n Public API termsOfService: https://n8n.io/legal/#terms contact: email: hello@n8n.io license: name: Sustainable Use License url: https://github.com/n8n-io/n8n/blob/master/LICENSE.md version: 1.1.1 servers: - url: /api/v1 security: - ApiKeyAuth: [] - BearerAuth: [] tags: - name: User description: Operations about users - name: Audit description: Operations about security audit - name: Execution description: Operations about executions - name: Workflow description: Operations about workflows - name: Credential description: Operations about credentials - name: Tags description: Operations about tags - name: SourceControl description: Operations about source control - name: Variables description: Operations about variables - name: DataTable description: Operations about data tables and their rows - name: Projects description: Operations about projects - name: CommunityPackage description: Operations about community packages - name: Discover description: API capability discovery - name: Insights description: Operations about insights - name: Folders description: Operations about folders externalDocs: description: n8n API documentation url: https://docs.n8n.io/api/ paths: /audit: post: x-eov-operation-id: generateAudit x-eov-operation-handler: v1/handlers/audit/audit.handler tags: - Audit summary: Generate an audit description: Generate a security audit for your n8n instance. requestBody: required: false content: application/json: schema: type: object properties: additionalOptions: type: object properties: daysAbandonedWorkflow: type: integer description: Days for a workflow to be considered abandoned if not executed categories: type: array items: type: string enum: - credentials - database - nodes - filesystem - instance responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/audit' '401': $ref: '#/components/responses/unauthorized' '500': description: Internal server error. /credentials: get: operationId: getCredentials x-eov-operation-id: getCredentials x-eov-operation-handler: v1/handlers/credentials/credentials.handler tags: - Credential summary: List credentials description: Retrieve all credentials from your instance. Only available for the instance owner and admin. Credential data (secrets) is not included. parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/credentialList' '401': $ref: '#/components/responses/unauthorized' post: operationId: createCredential x-eov-operation-id: createCredential x-eov-operation-handler: v1/handlers/credentials/credentials.handler tags: - Credential summary: Create a credential description: Creates a credential that can be used by nodes of the specified type. requestBody: description: Credential to be created. required: true content: application/json: schema: $ref: '#/components/schemas/credentialCreate' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/create-credential-response' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '415': description: Unsupported media type. /credentials/{id}: get: x-eov-operation-id: getCredential x-eov-operation-handler: v1/handlers/credentials/credentials.handler tags: - Credential summary: Get credential by ID description: Retrieves a credential by ID. Credential data (secrets) is not included. operationId: getCredential parameters: - name: id in: path description: The credential ID required: true schema: type: string responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/create-credential-response' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' patch: x-eov-operation-id: updateCredential x-eov-operation-handler: v1/handlers/credentials/credentials.handler tags: - Credential summary: Update credential by ID description: Updates an existing credential. You must be the owner of the credential. operationId: updateCredential parameters: - name: id in: path description: The credential ID that needs to be updated required: true schema: type: string requestBody: description: Credential data to update. All fields are optional. required: true content: application/json: schema: $ref: '#/components/schemas/update-credential-request' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/create-credential-response' '400': description: Bad request - invalid credential type or data. '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' delete: x-eov-operation-id: deleteCredential x-eov-operation-handler: v1/handlers/credentials/credentials.handler tags: - Credential summary: Delete credential by ID description: Deletes a credential from your instance. You must be the owner of the credentials operationId: deleteCredential parameters: - name: id in: path description: The credential ID that needs to be deleted required: true schema: type: string responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/credential' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' /credentials/{id}/test: post: x-eov-operation-id: testCredential x-eov-operation-handler: v1/handlers/credentials/credentials.handler tags: - Credential summary: Test credential by ID description: Tests a credential by ID using the stored credential data. operationId: testCredential parameters: - name: id in: path description: The credential ID required: true schema: type: string responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/credentialTestResponse' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' /credentials/schema/{credentialTypeName}: get: x-eov-operation-id: getCredentialType x-eov-operation-handler: v1/handlers/credentials/credentials.handler tags: - Credential summary: Show credential data schema parameters: - name: credentialTypeName in: path description: The credential type name that you want to get the schema for required: true schema: type: string responses: '200': description: Operation successful. content: application/json: schema: type: object examples: freshdeskApi: value: additionalProperties: false type: object properties: apiKey: type: string domain: type: string required: - apiKey - domain slackOAuth2Api: value: additionalProperties: false type: object properties: clientId: type: string clientSecret: type: string required: - clientId - clientSecret '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' /credentials/{id}/transfer: put: x-eov-operation-id: transferCredential x-eov-operation-handler: v1/handlers/credentials/credentials.handler tags: - Credential summary: Transfer a credential to another project. description: Transfer a credential to another project. parameters: - $ref: '#/components/parameters/credentialId' requestBody: description: Destination project for the credential transfer. content: application/json: schema: type: object properties: destinationProjectId: type: string description: The ID of the project to transfer the credential to. required: - destinationProjectId required: true responses: '200': description: Operation successful. '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' /executions: get: x-eov-operation-id: getExecutions x-eov-operation-handler: v1/handlers/executions/executions.handler tags: - Execution summary: Retrieve all executions description: Retrieve all executions from your instance. parameters: - $ref: '#/components/parameters/includeData' - $ref: '#/components/parameters/redactExecutionData' - name: status in: query description: Status to filter the executions by. required: false schema: type: string enum: - canceled - crashed - error - new - running - success - unknown - waiting - name: workflowId in: query description: Workflow to filter the executions by. required: false schema: type: string example: '1000' - name: projectId in: query required: false explode: false allowReserved: true schema: type: string example: VmwOO9HeTEj20kxM - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/executionList' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' /executions/{id}: get: x-eov-operation-id: getExecution x-eov-operation-handler: v1/handlers/executions/executions.handler tags: - Execution summary: Retrieve an execution description: Retrieve an execution from your instance. parameters: - $ref: '#/components/parameters/executionId' - $ref: '#/components/parameters/includeData' - $ref: '#/components/parameters/redactExecutionData' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/execution' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' delete: x-eov-operation-id: deleteExecution x-eov-operation-handler: v1/handlers/executions/executions.handler tags: - Execution summary: Delete an execution description: Deletes an execution from your instance. parameters: - $ref: '#/components/parameters/executionId' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/execution' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' /executions/{id}/retry: post: x-eov-operation-id: retryExecution x-eov-operation-handler: v1/handlers/executions/executions.handler tags: - Execution summary: Retry an execution description: Retry an execution from your instance. parameters: - $ref: '#/components/parameters/executionId' requestBody: required: false content: application/json: schema: type: object properties: loadWorkflow: type: boolean description: Whether to load the currently saved workflow to execute instead of the one saved at the time of the execution. If set to true, it will retry with the latest version of the workflow. responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/execution' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' /executions/{id}/stop: post: x-eov-operation-id: stopExecution x-eov-operation-handler: v1/handlers/executions/executions.handler tags: - Execution summary: Stop an execution description: Stop an execution by id. parameters: - $ref: '#/components/parameters/executionId' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/execution' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' /executions/stop: post: x-eov-operation-id: stopManyExecutions x-eov-operation-handler: v1/handlers/executions/executions.handler tags: - Execution summary: Stop multiple executions description: Stop multiple executions from your instance based on filter criteria. requestBody: required: true content: application/json: schema: type: object required: - status properties: status: type: array description: Array of execution statuses to stop. Must include at least one status. items: type: string enum: - queued - running - waiting example: - queued - running - waiting workflowId: type: string description: Optional workflow ID to filter executions. If not provided, will stop executions across all accessible workflows. example: 2tUt1wbLX592XDdX startedAfter: type: string format: date-time description: Only stop executions that started after this time. example: '2024-01-01T00:00:00.000Z' startedBefore: type: string format: date-time description: Only stop executions that started before this time. example: '2024-12-31T23:59:59.999Z' responses: '200': description: Operation successful. content: application/json: schema: type: object properties: stopped: type: number description: The number of executions that were successfully stopped. example: 5 '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' /executions/{id}/tags: get: x-eov-operation-id: getExecutionTags x-eov-operation-handler: v1/handlers/executions/executions.handler tags: - Execution summary: Get execution tags description: Get annotation tags for an execution. parameters: - $ref: '#/components/parameters/executionId' responses: '200': description: List of annotation tags content: application/json: schema: $ref: '#/components/schemas/executionTags' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' put: x-eov-operation-id: updateExecutionTags x-eov-operation-handler: v1/handlers/executions/executions.handler tags: - Execution summary: Update tags of an execution description: Update annotation tags of an execution. parameters: - $ref: '#/components/parameters/executionId' requestBody: description: List of annotation tag IDs content: application/json: schema: $ref: '#/components/schemas/tagIds' required: true responses: '200': description: List of tags after updating content: application/json: schema: $ref: '#/components/schemas/executionTags' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' /tags: post: x-eov-operation-id: createTag x-eov-operation-handler: v1/handlers/tags/tags.handler tags: - Tags summary: Create a tag description: Create a tag in your instance. requestBody: description: Created tag object. content: application/json: schema: $ref: '#/components/schemas/tag' required: true responses: '201': description: A tag object content: application/json: schema: $ref: '#/components/schemas/tag' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '409': $ref: '#/components/responses/conflict' get: x-eov-operation-id: getTags x-eov-operation-handler: v1/handlers/tags/tags.handler tags: - Tags summary: Retrieve all tags description: Retrieve all tags from your instance. parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/tagList' '401': $ref: '#/components/responses/unauthorized' /tags/{id}: get: x-eov-operation-id: getTag x-eov-operation-handler: v1/handlers/tags/tags.handler tags: - Tags summary: Retrieves a tag description: Retrieves a tag. parameters: - $ref: '#/components/parameters/tagId' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/tag' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' delete: x-eov-operation-id: deleteTag x-eov-operation-handler: v1/handlers/tags/tags.handler tags: - Tags summary: Delete a tag description: Deletes a tag. parameters: - $ref: '#/components/parameters/tagId' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/tag' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' put: x-eov-operation-id: updateTag x-eov-operation-handler: v1/handlers/tags/tags.handler tags: - Tags summary: Update a tag description: Update a tag. parameters: - $ref: '#/components/parameters/tagId' requestBody: description: Updated tag object. content: application/json: schema: $ref: '#/components/schemas/tag' required: true responses: '200': description: Tag object content: application/json: schema: $ref: '#/components/schemas/tag' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' /workflows: post: x-eov-operation-id: createWorkflow x-eov-operation-handler: v1/handlers/workflows/workflows.handler tags: - Workflow summary: Create a workflow description: Create a workflow in your instance. requestBody: description: Created workflow object. content: application/json: schema: $ref: '#/components/schemas/workflowCreate' required: true responses: '200': description: A workflow object content: application/json: schema: $ref: '#/components/schemas/workflow' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' get: x-eov-operation-id: getWorkflows x-eov-operation-handler: v1/handlers/workflows/workflows.handler tags: - Workflow summary: Retrieve all workflows description: Retrieve all workflows from your instance. parameters: - name: active in: query schema: type: boolean example: true - name: tags in: query required: false explode: false allowReserved: true schema: type: string example: test,production - name: name in: query required: false explode: false allowReserved: true schema: type: string example: My Workflow - name: projectId in: query required: false explode: false allowReserved: true schema: type: string example: VmwOO9HeTEj20kxM - name: excludePinnedData in: query required: false description: Set this to avoid retrieving pinned data schema: type: boolean example: true - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/workflowList' '401': $ref: '#/components/responses/unauthorized' /workflows/{id}: get: x-eov-operation-id: getWorkflow x-eov-operation-handler: v1/handlers/workflows/workflows.handler tags: - Workflow summary: Retrieve a workflow description: Retrieve a workflow. parameters: - name: excludePinnedData in: query required: false description: Set this to avoid retrieving pinned data schema: type: boolean example: true - $ref: '#/components/parameters/workflowId' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/workflow' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' delete: x-eov-operation-id: deleteWorkflow x-eov-operation-handler: v1/handlers/workflows/workflows.handler tags: - Workflow summary: Delete a workflow description: Delete a workflow. parameters: - $ref: '#/components/parameters/workflowId' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/workflow' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' put: x-eov-operation-id: updateWorkflow x-eov-operation-handler: v1/handlers/workflows/workflows.handler tags: - Workflow summary: Update a workflow description: Update a workflow. If the workflow is published, the updated version will be automatically re-published. parameters: - $ref: '#/components/parameters/workflowId' requestBody: description: Updated workflow object. content: application/json: schema: $ref: '#/components/schemas/workflow' required: true responses: '200': description: Workflow object content: application/json: schema: $ref: '#/components/schemas/workflow' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' /workflows/{id}/{versionId}: get: x-eov-operation-id: getWorkflowVersion x-eov-operation-handler: v1/handlers/workflows/workflows.handler tags: - Workflow summary: Retrieves a specific version of a workflow description: Retrieves a specific version of a workflow from workflow history. parameters: - $ref: '#/components/parameters/workflowId' - name: versionId in: path required: true description: The version ID to retrieve schema: type: string example: abc123-def456-ghi789 responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/workflowVersion' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' /workflows/{id}/activate: post: x-eov-operation-id: activateWorkflow x-eov-operation-handler: v1/handlers/workflows/workflows.handler tags: - Workflow summary: Publish a workflow description: Publish a workflow. In n8n v1, this action was termed activating a workflow. parameters: - $ref: '#/components/parameters/workflowId' requestBody: description: Optional parameters to publish the workflow. content: application/json: schema: type: object properties: versionId: type: string description: The specific version ID to activate or publish. If not provided, the latest version is used. name: type: string description: Optional name for the workflow version during activation. description: type: string description: Optional description for the workflow version during activation. required: false responses: '200': description: Workflow object content: application/json: schema: $ref: '#/components/schemas/workflow' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' /workflows/{id}/deactivate: post: x-eov-operation-id: deactivateWorkflow x-eov-operation-handler: v1/handlers/workflows/workflows.handler tags: - Workflow summary: Deactivate a workflow description: Deactivate a workflow. parameters: - $ref: '#/components/parameters/workflowId' responses: '200': description: Workflow object content: application/json: schema: $ref: '#/components/schemas/workflow' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' /workflows/{id}/archive: post: x-eov-operation-id: archiveWorkflow x-eov-operation-handler: v1/handlers/workflows/workflows.handler tags: - Workflow summary: Archive a workflow description: | Soft-deletes a workflow by archiving it. Idempotent: archiving an already archived workflow returns 200 with the current workflow. Requires API key scope `workflow:delete`. parameters: - $ref: '#/components/parameters/workflowId' responses: '200': description: Archived workflow content: application/json: schema: $ref: '#/components/schemas/workflow' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' /workflows/{id}/unarchive: post: x-eov-operation-id: unarchiveWorkflow x-eov-operation-handler: v1/handlers/workflows/workflows.handler tags: - Workflow summary: Unarchive a workflow description: | Restores an archived workflow. Requires API key scope `workflow:delete`. parameters: - $ref: '#/components/parameters/workflowId' responses: '200': description: Unarchived workflow content: application/json: schema: $ref: '#/components/schemas/workflow' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' /workflows/{id}/transfer: put: x-eov-operation-id: transferWorkflow x-eov-operation-handler: v1/handlers/workflows/workflows.handler tags: - Workflow summary: Transfer a workflow to another project description: Transfer a workflow to another project parameters: - $ref: '#/components/parameters/workflowId' requestBody: description: Destination project information for the workflow transfer. content: application/json: schema: type: object properties: destinationProjectId: type: string description: The ID of the project to transfer the workflow to. required: - destinationProjectId required: true responses: '200': description: Operation successful. '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' /workflows/{id}/tags: get: x-eov-operation-id: getWorkflowTags x-eov-operation-handler: v1/handlers/workflows/workflows.handler tags: - Workflow summary: Get workflow tags description: Get workflow tags. parameters: - $ref: '#/components/parameters/workflowId' responses: '200': description: List of tags content: application/json: schema: $ref: '#/components/schemas/workflowTags' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' put: x-eov-operation-id: updateWorkflowTags x-eov-operation-handler: v1/handlers/workflows/workflows.handler tags: - Workflow summary: Update tags of a workflow description: Update tags of a workflow. parameters: - $ref: '#/components/parameters/workflowId' requestBody: description: List of tags content: application/json: schema: $ref: '#/components/schemas/tagIds' required: true responses: '200': description: List of tags after add the tag content: application/json: schema: $ref: '#/components/schemas/workflowTags' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' /users: get: x-eov-operation-id: getUsers x-eov-operation-handler: v1/handlers/users/users.handler.ee tags: - User summary: Retrieve all users description: Retrieve all users from your instance. Only available for the instance owner. parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/includeRole' - name: projectId in: query required: false explode: false allowReserved: true schema: type: string example: VmwOO9HeTEj20kxM responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/userList' '401': $ref: '#/components/responses/unauthorized' post: x-eov-operation-id: createUser x-eov-operation-handler: v1/handlers/users/users.handler.ee tags: - User summary: Create multiple users description: Create one or more users. requestBody: description: Array of users to be created. required: true content: application/json: schema: type: array items: type: object properties: email: type: string format: email role: type: string example: global:member required: - email responses: '200': description: Operation successful. content: application/json: schema: type: object properties: user: type: object properties: id: type: string email: type: string inviteAcceptUrl: type: string emailSent: type: boolean error: type: string '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' /users/{id}: get: x-eov-operation-id: getUser x-eov-operation-handler: v1/handlers/users/users.handler.ee tags: - User summary: Get user by ID/Email description: Retrieve a user from your instance. Only available for the instance owner. parameters: - $ref: '#/components/parameters/userIdentifier' - $ref: '#/components/parameters/includeRole' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/user' '401': $ref: '#/components/responses/unauthorized' delete: x-eov-operation-id: deleteUser x-eov-operation-handler: v1/handlers/users/users.handler.ee tags: - User summary: Delete a user description: Delete a user from your instance. parameters: - $ref: '#/components/parameters/userIdentifier' responses: '204': description: Operation successful. '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' /users/{id}/role: patch: x-eov-operation-id: changeRole x-eov-operation-handler: v1/handlers/users/users.handler.ee tags: - User summary: Change a user's global role description: Change a user's global role parameters: - $ref: '#/components/parameters/userIdentifier' requestBody: description: New role for the user required: true content: application/json: schema: type: object properties: newRoleName: type: string example: global:member required: - newRoleName responses: '200': description: Operation successful. '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' /source-control/pull: post: x-eov-operation-id: pull x-eov-operation-handler: v1/handlers/source-control/source-control.handler tags: - SourceControl summary: Pull changes from the remote repository description: Requires the Source Control feature to be licensed and connected to a repository. requestBody: description: Pull options required: true content: application/json: schema: $ref: '#/components/schemas/pull' responses: '200': description: Import result content: application/json: schema: $ref: '#/components/schemas/importResult' '400': $ref: '#/components/responses/badRequest' '409': $ref: '#/components/responses/conflict' /variables: post: x-eov-operation-id: createVariable x-eov-operation-handler: v1/handlers/variables/variables.handler tags: - Variables summary: Create a variable description: Create a variable in your instance. requestBody: description: Payload for variable to create. content: application/json: schema: $ref: '#/components/schemas/variable.create' required: true responses: '201': description: Operation successful. '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' get: x-eov-operation-id: getVariables x-eov-operation-handler: v1/handlers/variables/variables.handler tags: - Variables summary: Retrieve variables description: Retrieve variables from your instance. parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - name: projectId in: query required: false explode: false allowReserved: true schema: type: string example: VmwOO9HeTEj20kxM - name: state in: query required: false schema: type: string enum: - empty responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/variableList' '401': $ref: '#/components/responses/unauthorized' /variables/{id}: delete: x-eov-operation-id: deleteVariable x-eov-operation-handler: v1/handlers/variables/variables.handler tags: - Variables summary: Delete a variable description: Delete a variable from your instance. parameters: - $ref: '#/components/parameters/variableId' responses: '204': description: Operation successful. '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' put: x-eov-operation-id: updateVariable x-eov-operation-handler: v1/handlers/variables/variables.handler tags: - Variables summary: Update a variable description: Update a variable from your instance. parameters: - $ref: '#/components/parameters/variableId' requestBody: description: Payload for variable to update. content: application/json: schema: $ref: '#/components/schemas/variable.create' required: true responses: '204': description: Operation successful. '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' /data-tables: get: x-eov-operation-id: listDataTables x-eov-operation-handler: v1/handlers/data-tables/data-tables.handler tags: - DataTable summary: List all data tables description: Retrieve a list of all data tables with optional filtering, sorting, and pagination. operationId: list-data-tables parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - name: filter in: query description: JSON string of filter conditions schema: type: string format: jsonString example: '{"name":"my-table"}' - name: sortBy in: query description: 'Sort format: field:asc or field:desc' schema: type: string example: name:asc responses: '200': description: Successfully retrieved data tables content: application/json: schema: $ref: '#/components/schemas/dataTableList' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' security: - ApiKeyAuth: [] post: x-eov-operation-id: createDataTable x-eov-operation-handler: v1/handlers/data-tables/data-tables.handler tags: - DataTable summary: Create a new data table description: Create a new data table in your personal project or a team project you have access to. operationId: create-data-table requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/createDataTableRequest' examples: personalProject: summary: Default (personal project) value: name: customers columns: - name: email type: string - name: status type: string - name: age type: number scopedProject: summary: Explicit project value: name: customers projectId: a1b2c3d4 columns: - name: email type: string - name: status type: string responses: '201': description: Data table created successfully content: application/json: schema: $ref: '#/components/schemas/dataTable' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' security: - ApiKeyAuth: [] /data-tables/{dataTableId}: get: x-eov-operation-id: getDataTable x-eov-operation-handler: v1/handlers/data-tables/data-tables.handler tags: - DataTable summary: Get a data table description: Retrieve a specific data table by ID. operationId: get-data-table parameters: - $ref: '#/components/parameters/dataTableId' responses: '200': description: Successfully retrieved data table content: application/json: schema: $ref: '#/components/schemas/dataTable' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' security: - ApiKeyAuth: [] patch: x-eov-operation-id: updateDataTable x-eov-operation-handler: v1/handlers/data-tables/data-tables.handler tags: - DataTable summary: Update a data table description: Update a data table's name. operationId: update-data-table parameters: - $ref: '#/components/parameters/dataTableId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/updateDataTableRequest' example: name: updated-customers responses: '200': description: Data table updated successfully content: application/json: schema: $ref: '#/components/schemas/dataTable' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' security: - ApiKeyAuth: [] delete: x-eov-operation-id: deleteDataTable x-eov-operation-handler: v1/handlers/data-tables/data-tables.handler tags: - DataTable summary: Delete a data table description: Delete a data table. This will also delete all rows in