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 description: Current n8n instance (self-hosted built-in playground) - url: '{url}/api/v1' description: Self-hosted n8n instance variables: url: default: https://example.com security: - ApiKeyAuth: [] - BearerAuth: [] - CookieAuth: [] tags: - name: Audit description: Operations about security audit - name: CommunityPackage description: Operations about community packages - name: Credential description: Operations about credentials - name: DataTable description: Operations about data tables and their rows - name: Discover description: API capability discovery - name: Evaluation description: Operations about evaluation test runs - name: Executions description: Operations about executions - name: Folders description: Operations about folders - name: Insights description: Operations about insights - name: LogStreaming description: Operations about log streaming destinations - name: N8nPackage description: Beta — breaking changes may still occur without major version bump. - name: NodeTypePolicy description: Operations about node type availability policies - name: Projects description: Operations about projects - name: Promotions description: Operations about promotion providers, connections, and package operations - name: Role description: Operations about roles - name: RoleMappingRule description: Operations about identity-provider role-mapping rules - name: SecurityPolicy description: Operations about the instance security policy settings - name: SettingsLdap description: Operations about LDAP settings - name: SettingsOtel description: Operations about OpenTelemetry settings - name: SettingsSsoOidc description: Operations about OIDC SSO settings - name: SettingsSsoSaml description: Operations about SAML SSO settings - name: SourceControl description: Operations about source control - name: Tags description: Operations about tags - name: User description: Operations about users - name: Variables description: Operations about variables - name: Workflow description: Operations about workflows externalDocs: description: n8n API documentation url: https://docs.n8n.io/api/ paths: /audit: post: x-eov-operation-id: generateAudit x-required-scope: securityAudit:generate 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. /settings/ldap: get: x-eov-operation-id: getLdapConfiguration x-required-scope: ldap:manage x-eov-operation-handler: v1/handlers/ldap/ldap.handler tags: - SettingsLdap summary: Retrieve the LDAP configuration description: | Retrieve the current LDAP configuration, including every field exposed in the UI. The binding admin password is redacted on read. Requires the `ldap:manage` scope and the LDAP feature to be licensed. responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/ldap-configuration' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' put: x-eov-operation-id: updateLdapConfiguration x-required-scope: ldap:manage x-eov-operation-handler: v1/handlers/ldap/ldap.handler tags: - SettingsLdap summary: Set the LDAP configuration description: | Replace the LDAP configuration with the provided full object (partial updates are not supported). For bindingAdminPassword, submit the blanking placeholder from a prior GET to keep the stored password unchanged. Requires the `ldap:manage` scope and the LDAP feature to be licensed. Setting loginEnabled to false is destructive and it deletes all stored LDAP user identities and disables synchronization. requestBody: description: The full LDAP configuration to set. required: true content: application/json: schema: $ref: '#/components/schemas/ldap-configuration.update' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/ldap-configuration' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' /settings/ldap/sync: get: x-eov-operation-id: getLdapSync x-required-scope: ldap:sync x-eov-operation-handler: v1/handlers/ldap/ldap.handler tags: - SettingsLdap summary: Retrieve LDAP synchronization history description: | Retrieve the history of LDAP synchronizations, most recent first. Requires the `ldap:sync` scope and the LDAP feature to be licensed. parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/ldap-sync-history.list' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' post: x-eov-operation-id: runLdapSync x-required-scope: ldap:sync x-eov-operation-handler: v1/handlers/ldap/ldap.handler tags: - SettingsLdap summary: Trigger an LDAP synchronization description: | Manually trigger an LDAP synchronization. The response returns the new sync history record. Requires the `ldap:sync` scope and the LDAP feature to be licensed. requestBody: description: Synchronization parameters. required: true content: application/json: schema: $ref: '#/components/schemas/ldap-sync.update' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/ldap-sync-history' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' /settings/security-policy: get: x-eov-operation-id: getSecurityPolicy x-required-scope: securitySettings:manage x-eov-operation-handler: v1/handlers/security-policy/security-policy.handler tags: - SecurityPolicy summary: Retrieve the security policy description: | Retrieve the instance security policy: personal-space publishing and sharing, the execution-data redaction enforcement floor, and the read-only usage counts shown in the UI. Requires the `securitySettings:manage` scope and the Personal Space Policy feature to be licensed. responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/security-policy' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' put: x-eov-operation-id: updateSecurityPolicy x-required-scope: securitySettings:manage x-eov-operation-handler: v1/handlers/security-policy/security-policy.handler tags: - SecurityPolicy summary: Set the security policy description: | Replace the instance security policy with the provided full object. Every writable field must be sent. Read-only usage counts from GET are ignored if included, so a GET response can be sent back as a PUT body. The update takes effect exactly as it would from the UI, using the same validation. Requires the `securitySettings:manage` scope and the Personal Space Policy feature to be licensed. When the group is managed via environment variables, the write is rejected with 409 and no changes are made; a read still returns the current values. requestBody: description: The full security policy to set. required: true content: application/json: schema: $ref: '#/components/schemas/security-policy.update' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/security-policy' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' /settings/otel: get: x-eov-operation-id: getOtelSettings x-required-scope: otel:manage x-eov-operation-handler: v1/handlers/otel/otel.handler tags: - SettingsOtel summary: Retrieve the OpenTelemetry configuration description: | Retrieve the current OpenTelemetry configuration, including every field exposed in the UI. Requires the `otel:manage` scope. responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/otel-settings' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' put: x-eov-operation-id: updateOtelSettings x-required-scope: otel:manage x-eov-operation-handler: v1/handlers/otel/otel.handler tags: - SettingsOtel summary: Set the OpenTelemetry configuration description: | Set the OpenTelemetry configuration. This is a full replacement: every field must be provided, and a partial body is rejected. The one exception is `exporterProtocol`, which defaults to `http/protobuf` when omitted. The update takes effect exactly as it would from the UI, using the same validation, and is applied to the running instance immediately. Fields managed declaratively via environment variables are read-only: attempting to change one is rejected with 409, while re-submitting its current value (as returned by GET) is accepted. Requires the `otel:manage` scope. requestBody: description: The OpenTelemetry configuration to set. required: true content: application/json: schema: $ref: '#/components/schemas/otel-settings' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/otel-settings' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' /settings/otel/test-trace: post: x-eov-operation-id: testOtelTrace x-required-scope: otel:manage x-eov-operation-handler: v1/handlers/otel/otel.handler tags: - SettingsOtel summary: Test the connection to an OTLP collector description: | Send a single test span to the given OTLP collector and report whether it was accepted. This tests the supplied connection details without changing the stored configuration. Fields managed declaratively via environment variables are overridden with their effective value before the test is sent. Requires the `otel:manage` scope. requestBody: description: The connection details to test. required: true content: application/json: schema: $ref: '#/components/schemas/otel-test-trace' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/otel-test-trace-result' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' /settings/sso/oidc: get: x-eov-operation-id: getOidcConfiguration x-required-scope: oidc:manage x-eov-operation-handler: v1/handlers/sso-oidc/sso-oidc.handler tags: - SettingsSsoOidc summary: Retrieve the OIDC SSO configuration description: | Retrieve the current OIDC SSO configuration, including every field exposed in the UI. The client secret is redacted on read and is never echoed back in plaintext. Requires the `oidc:manage` scope and the OIDC feature to be licensed. responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/oidc-configuration' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' put: x-eov-operation-id: setOidcConfiguration x-required-scope: oidc:manage x-eov-operation-handler: v1/handlers/sso-oidc/sso-oidc.handler tags: - SettingsSsoOidc summary: Set the OIDC SSO configuration description: | Set the OIDC SSO configuration. The update takes effect exactly as it would from the UI, using the same validation. `clientId`, `clientSecret` and `discoveryEndpoint` are required; submit the redacted client secret sentinel to keep the stored secret unchanged. Requires the `oidc:manage` scope and the OIDC feature to be licensed. The client secret is redacted in the response. When the configuration is managed declaratively (via environment variables), the write is rejected with 409 and no changes are made. requestBody: description: The OIDC SSO configuration to set. required: true content: application/json: schema: $ref: '#/components/schemas/oidc-configuration.update' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/oidc-configuration' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' /settings/sso/saml: get: x-eov-operation-id: getSamlConfiguration x-required-scope: saml:manage x-eov-operation-handler: v1/handlers/sso-saml/sso-saml.handler tags: - SettingsSsoSaml summary: Retrieve the SAML SSO configuration description: | Retrieve the current SAML SSO configuration, including every field exposed in the UI plus the service provider entity ID and ACS return URL. Signing private keys, signing certificates, and identity provider metadata are redacted on read. Requires the `saml:manage` scope and the SAML feature to be licensed. responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/saml-configuration' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' put: x-eov-operation-id: updateSamlConfiguration x-required-scope: saml:manage x-eov-operation-handler: v1/handlers/sso-saml/sso-saml.handler tags: - SettingsSsoSaml summary: Set the SAML SSO configuration description: | Replace the SAML SSO configuration with the provided full object. Every writable field must be sent; use empty strings or empty arrays when a value is unset. Read-only `entityID` / `returnUrl` from GET are ignored if included, so a GET response can be sent back as a PUT body. Redacted secret placeholders keep the stored values unchanged. The update takes effect exactly as it would from the UI, using the same validation. Requires the `saml:manage` scope and the SAML feature to be licensed. When the configuration is managed via environment variables, the write is rejected with 409 and no changes are made. requestBody: description: The full SAML SSO configuration to set. required: true content: application/json: schema: $ref: '#/components/schemas/saml-configuration.update' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/saml-configuration' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' /workflows/{id}/{versionId}: get: x-eov-operation-id: getWorkflowVersion x-required-scope: workflow:read x-eov-operation-handler: v1/handlers/workflows/workflows.handler tags: - Workflow summary: Retrieves a specific version of a workflow description: 'Deprecated: use GET /workflows/{workflowId}/versions/{workflowVersionId} instead. Retrieves a specific version of a workflow from workflow history.' deprecated: true 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}/test-runs: get: x-eov-operation-id: getTestRuns x-required-scope: testRun:list x-eov-operation-handler: v1/handlers/evaluations/evaluations.handler tags: - Evaluation summary: Retrieve test runs description: Retrieve the evaluation test runs of a workflow. parameters: - $ref: '#/components/parameters/testRunWorkflowId' - name: status in: query description: Status to filter the test runs by. required: false schema: type: string enum: - new - running - completed - error - cancelled - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/testRunList' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' post: x-eov-operation-id: createTestRun x-required-scope: testRun:create x-eov-operation-handler: v1/handlers/evaluations/evaluations.handler tags: - Evaluation summary: Trigger a test run description: Start a new evaluation test run for a workflow. The workflow must contain a configured evaluation trigger. Requires the `workflow:execute` project scope in addition to the `testRun:create` API key scope. parameters: - $ref: '#/components/parameters/testRunWorkflowId' responses: '201': description: Test run triggered. content: application/json: schema: $ref: '#/components/schemas/testRun' '401': $ref: '#/components/responses/unauthorized' '402': $ref: '#/components/responses/paymentRequired' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' /workflows/{id}/test-runs/{runId}: get: x-eov-operation-id: getTestRun x-required-scope: testRun:read x-eov-operation-handler: v1/handlers/evaluations/evaluations.handler tags: - Evaluation summary: Retrieve a test run description: Retrieve a single evaluation test run of a workflow, including its aggregated metrics and final result. parameters: - $ref: '#/components/parameters/testRunWorkflowId' - $ref: '#/components/parameters/testRunId' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/testRunSummary' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' /workflows/{id}/test-runs/{runId}/cancel: post: x-eov-operation-id: cancelTestRun x-required-scope: testRun:cancel x-eov-operation-handler: v1/handlers/evaluations/evaluations.handler tags: - Evaluation summary: Cancel a test run description: Cancel a running evaluation test run of a workflow. Requires the `workflow:execute` project scope in addition to the `testRun:cancel` API key scope. parameters: - $ref: '#/components/parameters/testRunWorkflowId' - $ref: '#/components/parameters/testRunId' responses: '202': description: Cancellation requested. content: application/json: schema: $ref: '#/components/schemas/testRunCancel' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' /workflows/{id}/test-runs/{runId}/test-cases: get: x-eov-operation-id: getTestCases x-required-scope: testRun:read x-eov-operation-handler: v1/handlers/evaluations/evaluations.handler tags: - Evaluation summary: Retrieve test run cases description: Retrieve the per-case results of an evaluation test run. parameters: - $ref: '#/components/parameters/testRunWorkflowId' - $ref: '#/components/parameters/testRunId' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/testCaseExecutionList' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' /users: get: x-eov-operation-id: getUsers x-required-scope: user:list 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-required-scope: user:create 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-required-scope: user:read 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-required-scope: user:delete 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-required-scope: user: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' /data-tables: get: x-eov-operation-id: listDataTables x-required-scope: dataTable:list 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. Each table includes `sizeBytes`, the value the `size` sort option orders by. 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-required-scope: dataTable:create 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-required-scope: dataTable:read 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-required-scope: dataTable:update 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-required-scope: dataTable:delete 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 the table. operationId: delete-data-table parameters: - $ref: '#/components/parameters/dataTableId' responses: '204': description: Data table deleted successfully '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' security: - ApiKeyAuth: [] /data-tables/{dataTableId}/rows: get: x-eov-operation-id: getDataTableRows x-required-scope: dataTableRow:read x-eov-operation-handler: v1/handlers/data-tables/data-tables.rows.handler tags: - DataTable summary: Retrieve rows from a data table description: Query and retrieve rows from a data table with optional filtering, sorting, and pagination. operationId: get-data-table-rows parameters: - $ref: '#/components/parameters/dataTableId' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - name: filter in: query description: JSON string of filter conditions schema: type: string format: jsonString example: '{"type":"and","filters":[{"columnName":"status","condition":"eq","value":"active"}]}' - name: sortBy in: query description: 'Sort format: columnName:asc or columnName:desc' schema: type: string example: createdAt:desc - name: search in: query description: Search text across all string columns schema: type: string responses: '200': description: Successfully retrieved rows content: application/json: schema: $ref: '#/components/schemas/dataTableRowList' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' security: - ApiKeyAuth: [] post: x-eov-operation-id: insertDataTableRows x-required-scope: dataTableRow:create x-eov-operation-handler: v1/handlers/data-tables/data-tables.rows.handler tags: - DataTable summary: Insert rows into a data table description: Insert one or more rows into a data table. operationId: insert-data-table-rows parameters: - $ref: '#/components/parameters/dataTableId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/insertRowsRequest' example: data: - name: John Doe email: john@example.com age: 30 - name: Jane Smith email: jane@example.com age: 25 returnType: all responses: '200': description: Rows inserted successfully content: application/json: schema: oneOf: - type: object properties: count: type: integer description: Number of rows inserted (when returnType is 'count') - type: array items: type: integer description: Array of inserted row IDs (when returnType is 'id') - type: array items: $ref: '#/components/schemas/dataTableRow' description: Array of inserted rows (when returnType is 'all') '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' security: - ApiKeyAuth: [] /data-tables/{dataTableId}/rows/update: patch: x-eov-operation-id: updateDataTableRows x-required-scope: dataTableRow:update x-eov-operation-handler: v1/handlers/data-tables/data-tables.rows.handler tags: - DataTable summary: Update rows in a data table description: Update rows matching filter conditions in a data table. operationId: update-data-table-rows parameters: - $ref: '#/components/parameters/dataTableId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/updateRowsRequest' example: filter: type: and filters: - columnName: status condition: eq value: pending data: status: completed updatedBy: admin returnData: false dryRun: false responses: '200': description: Rows updated successfully content: application/json: schema: oneOf: - type: boolean description: True when returnData is false - type: array items: $ref: '#/components/schemas/dataTableRow' description: Updated rows when returnData is true '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' security: - ApiKeyAuth: [] /data-tables/{dataTableId}/rows/upsert: post: x-eov-operation-id: upsertDataTableRow x-required-scope: dataTableRow:upsert x-eov-operation-handler: v1/handlers/data-tables/data-tables.rows.handler tags: - DataTable summary: Upsert a row in a data table description: Update an existing row or insert a new one if no row matches the filter conditions. operationId: upsert-data-table-row parameters: - $ref: '#/components/parameters/dataTableId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/upsertRowRequest' example: filter: type: and filters: - columnName: email condition: eq value: user@example.com data: email: user@example.com name: Updated Name status: active returnData: true dryRun: false responses: '200': description: Row upserted successfully content: application/json: schema: oneOf: - type: boolean description: True when returnData is false - allOf: - $ref: '#/components/schemas/dataTableRow' description: Upserted row when returnData is true '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' security: - ApiKeyAuth: [] /data-tables/{dataTableId}/rows/clear: delete: x-eov-operation-id: clearDataTableRows x-required-scope: dataTableRow:delete x-eov-operation-handler: v1/handlers/data-tables/data-tables.rows.handler tags: - DataTable summary: Clear all rows from a data table description: Permanently deletes all rows from a data table. The table structure will be retained. This action cannot be undone. operationId: clear-data-table-rows parameters: - $ref: '#/components/parameters/dataTableId' responses: '200': description: Rows cleared successfully content: application/json: schema: type: object properties: deletedCount: type: integer description: The number of rows that were deleted '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' security: - ApiKeyAuth: [] /data-tables/{dataTableId}/rows/delete: delete: x-eov-operation-id: deleteDataTableRows x-required-scope: dataTableRow:delete x-eov-operation-handler: v1/handlers/data-tables/data-tables.rows.handler tags: - DataTable summary: Delete rows from a data table description: Delete rows matching filter conditions from a data table. Filter is required to prevent accidental deletion of all data. operationId: delete-data-table-rows parameters: - $ref: '#/components/parameters/dataTableId' - name: filter in: query required: true description: JSON string of filter conditions. Required to prevent accidental deletion of all data. schema: type: string format: jsonString example: '{"type":"and","filters":[{"columnName":"status","condition":"eq","value":"archived"}]}' - name: returnData in: query description: If true, return the deleted rows; if false, return true on success schema: type: boolean default: false - name: dryRun in: query description: If true, preview which rows would be deleted without actually deleting them schema: type: boolean default: false responses: '200': description: Rows deleted successfully content: application/json: schema: oneOf: - type: boolean description: True when returnData is false - type: array items: $ref: '#/components/schemas/dataTableRow' description: Deleted rows when returnData is true '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' security: - ApiKeyAuth: [] /data-tables/{dataTableId}/columns: get: x-eov-operation-id: listDataTableColumns x-required-scope: dataTableColumn:read x-eov-operation-handler: v1/handlers/data-tables/data-tables.columns.handler tags: - DataTable summary: List columns of a data table description: Retrieve all columns for a specific data table. operationId: list-data-table-columns parameters: - $ref: '#/components/parameters/dataTableId' responses: '200': description: Successfully retrieved columns content: application/json: schema: type: array items: $ref: '#/components/schemas/dataTableColumn' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' security: - ApiKeyAuth: [] post: x-eov-operation-id: createDataTableColumn x-required-scope: dataTableColumn:create x-eov-operation-handler: v1/handlers/data-tables/data-tables.columns.handler tags: - DataTable summary: Add a column to a data table description: Add a new column to an existing data table. operationId: create-data-table-column parameters: - $ref: '#/components/parameters/dataTableId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/createColumnRequest' example: name: email type: string responses: '201': description: Column created successfully content: application/json: schema: $ref: '#/components/schemas/dataTableColumn' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' security: - ApiKeyAuth: [] /data-tables/{dataTableId}/columns/{columnId}: delete: x-eov-operation-id: deleteDataTableColumn x-required-scope: dataTableColumn:delete x-eov-operation-handler: v1/handlers/data-tables/data-tables.columns.handler tags: - DataTable summary: Delete a column description: Remove a column from a data table. This will also delete all data in the column. operationId: delete-data-table-column parameters: - $ref: '#/components/parameters/dataTableId' - $ref: '#/components/parameters/columnId' responses: '204': description: Column deleted successfully '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' security: - ApiKeyAuth: [] patch: x-eov-operation-id: updateDataTableColumn x-required-scope: dataTableColumn:update x-eov-operation-handler: v1/handlers/data-tables/data-tables.columns.handler tags: - DataTable summary: Update a column description: Rename and/or reorder a column in a data table. operationId: update-data-table-column parameters: - $ref: '#/components/parameters/dataTableId' - $ref: '#/components/parameters/columnId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/updateColumnRequest' example: name: email index: 1 responses: '200': description: Column updated successfully content: application/json: schema: $ref: '#/components/schemas/dataTableColumn' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' security: - ApiKeyAuth: [] /community-packages: post: x-eov-operation-id: installPackage x-required-scope: communityPackage:install x-eov-operation-handler: v1/handlers/community-packages/community-packages.handler tags: - CommunityPackage summary: Install a community package description: Install a community package by npm name and optional version. requestBody: description: Package to install. required: true content: application/json: schema: $ref: '#/components/schemas/installCommunityPackageRequest' responses: '200': description: Package installed successfully. content: application/json: schema: $ref: '#/components/schemas/communityPackage' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' security: - ApiKeyAuth: [] get: x-eov-operation-id: getInstalledPackages x-required-scope: communityPackage:list x-eov-operation-handler: v1/handlers/community-packages/community-packages.handler tags: - CommunityPackage summary: List installed community packages description: Retrieve all installed community packages with pending update info. responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/communityPackageList' '401': $ref: '#/components/responses/unauthorized' security: - ApiKeyAuth: [] /community-packages/{name}: patch: x-eov-operation-id: updatePackage x-required-scope: communityPackage:update x-eov-operation-handler: v1/handlers/community-packages/community-packages.handler tags: - CommunityPackage summary: Update a community package description: Update an installed community package to a new version. parameters: - name: name in: path description: npm package name required: true schema: type: string requestBody: description: Update options. required: false content: application/json: schema: type: object properties: version: type: string description: Semver version or npm dist-tag to update to, such as latest or beta. When unverified packages are disabled, only versions verified by n8n can be installed. responses: '200': description: Package updated successfully. content: application/json: schema: $ref: '#/components/schemas/communityPackage' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' security: - ApiKeyAuth: [] delete: x-eov-operation-id: uninstallPackage x-required-scope: communityPackage:uninstall x-eov-operation-handler: v1/handlers/community-packages/community-packages.handler tags: - CommunityPackage summary: Uninstall a community package description: Uninstall a community package by name. parameters: - name: name in: path description: npm package name required: true schema: type: string responses: '204': description: Package uninstalled successfully. '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' security: - ApiKeyAuth: [] /discover: get: x-eov-operation-id: getDiscover x-required-scope: none x-eov-operation-handler: v1/handlers/discover/discover.handler tags: - Discover summary: Discover available API capabilities description: | Returns a filtered capability map based on the caller's API key scopes. Each resource includes the operations and endpoints accessible to the authenticated API key. Use query parameters to narrow the response. parameters: - name: include in: query required: false schema: type: string enum: - schemas description: | Include additional data. Use "schemas" to inline request body schemas per endpoint, eliminating the need to fetch the full OpenAPI spec. - name: resource in: query required: false schema: type: string description: | Filter to a specific resource (e.g. "workflow", "tags", "credential"). - name: operation in: query required: false schema: type: string description: | Filter to endpoints with a specific operation (e.g. "read", "create", "list"). responses: '200': description: Discovery response with available resources and endpoints. content: application/json: schema: type: object properties: data: type: object properties: scopes: type: array items: type: string description: The API key's active scopes resources: type: object additionalProperties: type: object properties: operations: type: array items: type: string endpoints: type: array items: type: object properties: method: type: string path: type: string operationId: type: string requestSchema: type: object description: | Request body schema (only present when include=schemas and the endpoint accepts a request body). filters: type: object description: | Available query parameter filters. The values arrays reflect what the caller's scopes permit. additionalProperties: type: object properties: description: type: string values: type: array items: type: string specUrl: type: string description: URL to the full OpenAPI specification '401': $ref: '#/components/responses/unauthorized' /projects/{projectId}/folders: post: x-eov-operation-id: createFolder x-required-scope: folder:create x-eov-operation-handler: v1/handlers/folders/folders.handler tags: - Folders summary: Create a folder description: Create a folder within a project. parameters: - name: projectId in: path description: The ID of the project, or `personal` to create the folder in the calling user's own personal project. required: true schema: type: string requestBody: description: Payload for folder to create. content: application/json: schema: $ref: '#/components/schemas/folder.create' required: true responses: '201': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/folder' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' get: operationId: listFolders tags: - Folders summary: Retrieve folders description: Retrieve folders within a project. Supports filtering, sorting, field selection, and pagination. x-required-scope: folder:list x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the project. name: projectId in: path - schema: type: string description: JSON-encoded filter object. Supported fields — parentFolderId, name, tags (array of tag names), excludeFolderIdAndDescendants. example: '{"parentFolderId":"abc123","name":"My Folder"}' required: false name: filter in: query - schema: type: string description: JSON-encoded array of fields to include. Valid fields — id, name, createdAt, updatedAt, project, tags, parentFolder, workflowCount, subFolderCount, path. example: '["id","name","tags","workflowCount"]' required: false name: select in: query - schema: type: string enum: - name:asc - name:desc - createdAt:asc - createdAt:desc - updatedAt:asc - updatedAt:desc description: Sort order for results. required: false name: sortBy in: query - schema: type: string description: Number of items to skip for pagination. Defaults to 0. required: false name: skip in: query - schema: type: string description: Number of items to return. Defaults to 10. required: false name: take in: query responses: '200': description: Operation successful. content: application/json: schema: type: object properties: count: type: integer description: Total number of folders matching the query. data: type: array items: type: object properties: id: type: string readOnly: true example: zLXWgYyZrZ4Gn1Vk name: type: string example: My Folder parentFolderId: type: string nullable: true example: kRZ0ewrAEAhCkTBd createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true homeProject: type: object properties: id: type: string readOnly: true example: VmwOO9HeTEj20kxM name: type: string example: Marketing type: type: string readOnly: true example: team enum: - personal - team icon: type: object description: Icon of the project, or null when the project has none properties: type: type: string enum: - emoji - icon value: type: string color: type: string required: - type - value nullable: true required: - id - name - type - icon parentFolder: type: object nullable: true properties: id: type: string readOnly: true example: zLXWgYyZrZ4Gn1Vk name: type: string example: My Folder parentFolderId: type: string nullable: true required: - id - name - parentFolderId tags: type: array items: type: object properties: id: type: string name: type: string required: - id - name workflowCount: type: number description: Number of workflows the folder holds. readOnly: true subFolderCount: type: number description: Number of folders the folder holds. readOnly: true path: type: array items: type: string description: Names of every folder from the project root down to this folder. readOnly: true example: - Marketing - Campaigns required: - id required: - count - data '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' /projects/{projectId}/folders/{folderId}: delete: x-eov-operation-id: deleteFolder x-required-scope: folder:delete x-eov-operation-handler: v1/handlers/folders/folders.handler tags: - Folders summary: Delete a folder description: Delete a folder within a project. When `transferToFolderId` is provided, workflows and sub-folders are moved to the target folder before deletion. When omitted, workflows are moved to the project root and archived, and child folders are deleted. parameters: - name: projectId in: path description: The ID of the project. required: true schema: type: string - name: folderId in: path description: The ID of the folder. required: true schema: type: string - name: transferToFolderId in: query description: Optional target folder ID to move workflows and sub-folders into before deleting. required: false schema: type: string 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' patch: x-eov-operation-id: updateFolder x-required-scope: folder:update x-eov-operation-handler: v1/handlers/folders/folders.handler tags: - Folders summary: Update a folder description: Update folder name or parent folder. parameters: - name: projectId in: path description: The ID of the project. required: true schema: type: string - name: folderId in: path description: The ID of the folder. required: true schema: type: string requestBody: description: Payload for folder update. content: application/json: schema: $ref: '#/components/schemas/folder.update' required: true responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/folder' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' get: operationId: getFolder tags: - Folders summary: Get folder details description: Get folder details including sub-folder and workflow counts. x-required-scope: folder:read x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the project. name: projectId in: path - schema: type: string required: true description: The ID of the folder. name: folderId in: path responses: '200': description: Operation successful. content: application/json: schema: type: object properties: id: type: string readOnly: true example: zLXWgYyZrZ4Gn1Vk name: type: string example: My Folder parentFolderId: type: string nullable: true example: kRZ0ewrAEAhCkTBd createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true totalSubFolders: type: integer description: Total number of sub-folders (recursive). totalWorkflows: type: integer description: Total number of workflows (recursive). required: - id - name - parentFolderId - createdAt - updatedAt - totalSubFolders - totalWorkflows '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' /n8n-packages/export: post: x-eov-operation-id: exportPackage x-required-scope: project:export,workflow:export x-eov-operation-handler: v1/handlers/n8n-packages/n8n-packages.handler tags: - N8nPackage summary: 'Beta: Export workflows, folders, or projects as an n8n package' description: | **Beta** — breaking changes may still occur without major version bump. Export workflows and/or folders, or projects, as a gzipped tar archive (.n8np). Provide `workflowIds`/`folderIds`, or `projectIds`, but not both groups. Each exported folder includes its nested folders. Empty projects export project metadata only. Statically referenced sub-workflows must also be included in the resulting package, otherwise the export is rejected. The response is streamed as `application/gzip` with a `Content-Disposition` attachment header. Requires the n8n Packages feature to be licensed. API key scopes: `workflow:export` is required when exporting workflows or folders, and `project:export` is required when exporting projects. When `includeVariableValues` is true (the default) and the exported workflows reference variables, `variable:list` is also required; exports that reference no variables never need it. requestBody: description: Workflows, folders, or projects to include in the exported package. required: true content: application/json: schema: $ref: '#/components/schemas/exportPackageRequest' responses: '200': description: A gzipped tar archive containing the exported package contents. headers: X-N8n-Export-Counts: description: | JSON-serialized per-entity counts of what actually ended up in the package (after folder bundling and auto-inclusion), e.g. `{"workflows":2,"folders":1,"credentials":0,"dataTables":0,"variables":0}`. schema: type: string content: application/gzip: schema: type: string format: binary '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' /n8n-packages/import: post: x-eov-operation-id: importPackage x-required-scope: workflow:import x-eov-operation-handler: v1/handlers/n8n-packages/n8n-packages.handler tags: - N8nPackage summary: 'Beta: Import an n8n package into a project' description: | **Beta** — breaking changes may still occur without major version bump. Imports a gzip-compressed tar package (`.n8np`) into the target project. Send the archive as the multipart field `package`. Optional routing uses form fields `projectId` and `folderId` (omit or send empty for defaults). Every optional mode/policy field (credential, workflow, project, folder, data table, variable, and tag) takes its default when omitted; the one non-fixed default is `folderConflictPolicy`, which follows `projectConflictPolicy` on a project package (see its description). The required `workflowConflictPolicy` field controls what happens when a package workflow matches an existing workflow by source id in the target project. Maximum upload size is `N8N_ENDPOINTS_PAYLOAD_SIZE_MAX` MB (default 16). The package must declare its manifest at `manifest.json` and include every file referenced by the manifest. The caller is authorised through the `workflow:import` scope. With the default `workflowIdPolicy=new`, newly created workflows receive a fresh local id; imported workflows arrive inactive unless `workflowPublishingPolicy` publishes them after import. Credential references are resolved before any workflow is written. Credentials owned by, shared with, or global to the target project (with `credential:read`) match. requestBody: required: true content: multipart/form-data: schema: type: object required: - package - workflowConflictPolicy properties: package: type: string format: binary description: Gzip-compressed tar package (`.n8np`). projectId: type: string description: | Target project id. Omit or send empty to import into the caller's personal project. folderId: type: string description: | Optional folder within the target project. Omit or send empty for project root. credentialMatchingMode: type: string enum: - id-only - name-and-type - type-only default: id-only description: | How credential references in `requirements.credentials` are matched on the target instance. `id-only` (default) matches by id. `name-and-type` matches credentials with the exact same name and type. `type-only` matches any credential of the same type. For `name-and-type` and `type-only`, candidates are ranked by scope — a credential owned by the target project wins over one merely shared into it, which in turn wins over a global credential; if several candidates remain in the winning scope, the most recently updated one is chosen. credentialMissingMode: type: string enum: - must-preexist - create-stub default: create-stub description: | What to do when a credential reference cannot be resolved. `create-stub` (default) creates empty credential placeholders in the target project for missing references. `must-preexist` requires every referenced credential to already exist. bindings: type: string default: '{}' description: | Optional JSON object of explicit source→target id bindings, keyed by entity type. Only `credentials` is supported today: send `{"credentials":{"":""}}` to map credential ids from the package to credential ids on the target instance. These explicit bindings are validated on type and applied before `credentialMatchingMode` resolution runs. workflowConflictPolicy: type: string enum: - new-version - fail - skip description: | `new-version` updates matching workflows and creates a new version; the archived state follows the package, so a matching workflow is archived or unarchived to match it. `fail` rejects the import when any matching workflow exists, and `skip` leaves matching workflows unchanged. Archived workflows in the target project match like any other. An archive state change also needs the `workflow:delete` scope. workflowIdPolicy: type: string enum: - new - source default: source description: | Controls the id each newly created workflow receives. `source` (default) reuses the package's own workflow id on the target instance, which best fits promotion use cases where the same workflow moves between environments. `new` mints a fresh id and records the package id as `sourceWorkflowId`, so the same package can be imported repeatedly without id collisions — best suited to marketplace imports. Workflows matched to an existing workflow in the target project (status `updated` or `skipped`) always keep that workflow's current id, regardless of policy. missingNodeTypeMode: type: string enum: - fail - import-anyway default: fail description: | What to do when a workflow in the package uses a node type — or a version of a node type — this instance does not have. `fail` (default) rejects the import before anything is written, listing every missing `(nodeType, typeVersion)` pair and the workflows that use it. `import-anyway` imports the package; workflows containing missing node types are never published by this import, regardless of `workflowPublishingPolicy`. workflowPublishingPolicy: type: string enum: - preserve-published-state - match-source - publish-all - unpublish-all default: preserve-published-state description: | Controls whether imported workflows are published after content is written. `preserve-published-state` keeps new workflows inactive and republishes an updated workflow only when it was already published and the package carries the version the source publishes, so drafts are never published. `match-source` publishes the version the package carries when the source publishes it, and unpublishes when the source publishes nothing; when the source publishes a version the package does not carry, the target keeps its published version. `publish-all` publishes every imported workflow. `unpublish-all` leaves new workflows inactive and unpublishes updated workflows that were published. projectConflictPolicy: type: string enum: - merge - fail - overwrite default: merge description: | What to do when a project the package defines already exists here (matched by id), and — unless `folderConflictPolicy` overrides it — how its contents are treated. `merge` (default) leaves the existing project's name, description, icon and custom span attributes untouched and adds the package's contents alongside. `overwrite` replaces those details with the package's; a detail the package omits is left as it is, not cleared. `fail` rejects the import before anything is written, with one `project-conflict` issue per existing project. A package project id belonging to a personal project, or to a team project the caller cannot update, always rejects the import. Ignored for workflow packages. folderConflictPolicy: type: string enum: - merge - fail - overwrite description: | What to do when a package folder already exists at the same position in the target project. Defaults to whatever `projectConflictPolicy` is, so the intent is stated once; a workflow package defines no projects, so it defaults to `merge` there. `merge` reuses the existing folder and merges the package's children into it. `fail` rejects the import. `overwrite` reuses folders as `merge` does and additionally removes workflows the package does not contain — at a project's root and in folders the package defines, leaving target-only folders and their contents alone. Folders it does not define are then removed too, but only once nothing is left inside them. Removals are listed under `removedWorkflows` and `removedFolders`; see `overwriteDeletionPolicy`. A folder whose id sits under a different parent, or belongs to another project, always blocks the import. `overwrite` is project-packages-only, needs the `workflow:delete` and `folder:delete` scopes, is rejected against a `projectConflictPolicy` other than `overwrite`, and blocks up front if the caller cannot delete something it would remove. Folders need the `folder:create` scope and a folders-enabled licence. overwriteDeletionPolicy: type: string enum: - archive - hard-delete default: archive description: | How `folderConflictPolicy=overwrite` removes a workflow the package does not contain. `archive` (default) archives it, so it stays recoverable along with its execution history. `hard-delete` archives it — the step that unpublishes it, which a delete will not do on its own — and then deletes the workflow and its executions permanently. Each entry in `removedWorkflows` reports what actually happened in its `deletion` field: a `hard-delete` whose row cannot be dropped yet, because unpublishing defers trigger teardown, is left `archived` rather than failing an import whose content is already written. Ignored unless `folderConflictPolicy` is `overwrite`. dataTableMatchingMode: type: string enum: - by-id default: by-id description: | How data tables referenced by the package's workflows are matched against the target project. `by-id` matches the target-project table with the same id (imported tables keep their source id) and never falls back to name matching, so a match survives a rename on the target. Currently the only mode. dataTableMissingMode: type: string enum: - create - must-preexist - do-nothing default: create description: | Controls what happens when a referenced data table has no match in the target project. `create` (default) creates it from the package schema, keeping the source id, with no rows; requires the `dataTable:create` scope. `must-preexist` rejects the import. `do-nothing` skips creation of missing tables — matched tables are still validated for schema compatibility and can still block the import. Matched tables are always used as-is: never renamed, altered, or filled. dataTableSchemaConflictPolicy: type: string enum: - keep-existing - fail default: keep-existing description: | How strictly a matched data table's schema is compared. `keep-existing` (default) accepts a target table that has every package column with the same name and type, even when the target table also has additional columns of its own. `fail` is the strict drift-detection choice: any difference, including such target-only columns, rejects the import. A missing package column or a type mismatch always rejects. Both policies are non-destructive — the matched target table is never altered, and package columns are never added to it. variableMissingMode: type: string enum: - do-nothing - must-preexist - create-stub - create-with-value default: create-with-value description: | Controls what happens when a variable referenced by the package's workflows is absent from the target project and the global scope (lookup order: project, then global). `create-with-value` (default) creates the variable with its package value and lists its name under `variables.created`. When the package carries no value for it — values were excluded at export, or the exported value was itself empty — it creates an empty stub listed under `variables.stubbed`. `do-nothing` imports without creating the variable and lists its name under `variables.missing`. `must-preexist` rejects the import unless every referenced variable already resolves. `create-stub` creates each missing variable with an empty value at the placement scope (see `variableParentPolicy`) and lists the created names under `variables.stubbed`. An import that actually creates a variable requires a license that permits variables and, for API key callers, the `variable:create` scope; a package whose variables all already resolve creates nothing and needs neither. variableConflictPolicy: type: string enum: - keep-existing - overwrite - fail default: keep-existing description: | What to do when a referenced variable resolves in the target project or global scope but the package bundles a *different* value for it. `keep-existing` (default) leaves the target value untouched and reports the name under `variables.matched`. `overwrite` silently replaces the value of the existing variable at whichever scope it was found — the target project or the global scope, so a global variable other projects also read can be rewritten by this import — and reports the name under `variables.updated`; it needs a license that permits variables, the `variable:update` / `projectVariable:update` permission on that scope, and, for API key callers, the `variable:update` scope. `fail` rejects the import with a 409 instead. Every policy leaves a resolved variable alone when there is nothing to change — either the package bundles no value for it (values were excluded at export, or the exported value was itself empty), or the value it bundles already matches the target's. The reverse does not hold: a resolved variable holding an empty value — a stub an earlier import created, say — still counts as a value, so `overwrite` fills it and `fail` rejects it. Under `overwrite`, a project package whose projects hold *different* values for a name they all resolve to one row — a global none of them shadows, typically — is rejected with a 409: one row cannot carry both values, and the import will not pick for you. Give the projects their own variables in the target, or import them separately. variableParentPolicy: type: string enum: - project - global description: | Where `create-with-value` and `create-stub` create missing variables for workflow/folder packages. `project` — also the behaviour when the field is omitted — creates them in the import target project (`projectId`, else the caller's personal project). `global` creates them at the global scope. The license and `variable:create` requirements described under `variableMissingMode` apply to both placements. Must be omitted for project packages, which reject it with a 400: their placement follows the package layout, where a variable bundled under a project is created in that project and one bundled at the top level is created globally. tagMissingMode: type: string enum: - create - do-nothing default: create description: | What to do when a tag referenced by the package's workflows has no tag with the same id on the target instance (tags are matched by source id, never by name). `create` (default) creates the tag globally with its package (source) id and name; when the import would create a tag this needs an API key carrying the `tag:create` scope. `do-nothing` imports the workflows without the missing tags — nothing is created and the dropped names are listed under `tags.skipped`. tagConflictPolicy: type: string enum: - skip - fail - rename default: skip description: | What to do when a referenced tag conflicts on the target instance — either the same-id target tag carries a different name (rename drift), or the tag's name is already held by a different tag (name collision). `skip` (default) drops the conflicted tags from the import (not created, not renamed, not attached anywhere; the import proceeds and lists them under `tags.skipped`). `fail` rejects the import with a 409. `rename` renames a drifted target tag to the package name, and reconciles a name collision by re-keying the existing tag to the package (source) id — its name, workflow and folder taggings follow; both need an API key carrying the `tag:update` scope when the import would rename or reconcile a tag. A drifted tag whose package name is held by another tag still rejects the import (rename degrades to fail). responses: '200': description: Import succeeded; the listed workflows were written to the target project. content: application/json: schema: type: object required: - package - workflows - removedWorkflows - removedFolders - folders - projects - bindings - credentials - dataTables - variables - tags properties: package: type: object required: - sourceN8nVersion - sourceId - exportedAt properties: sourceN8nVersion: type: string sourceId: type: string exportedAt: type: string format: date-time workflows: type: array items: type: object required: - sourceWorkflowId - localId - name - projectId - parentFolderId - activeVersionId - isArchived - publishing - status properties: sourceWorkflowId: type: string description: Workflow id as it appeared in the package. localId: type: string description: | Workflow id on the target instance: newly assigned for `created` (fresh under `workflowIdPolicy=new`, the package id under `source`), the existing workflow's id for `updated`/`skipped`. name: type: string projectId: type: string parentFolderId: type: string nullable: true activeVersionId: type: string nullable: true description: | Published version on the target instance, if any. `null` when the workflow is not published after import. isArchived: type: boolean description: | Whether the workflow is archived on the target after import. Under `new-version` this follows the package's `isArchived` flag. A skipped workflow keeps its own state. publishing: type: object required: - state description: | Outcome of applying the selected publishing policy to this workflow. properties: state: type: string enum: - published - unpublished - unchanged - blocked - failed description: | `blocked` means the imported version could not be published and no version is active (for example because the workflow uses a stubbed credential, or uses a node type this instance does not have). When a prior published version remains active, `state` is `unchanged` with `skippedPublishReason` instead. `failed` means publish or unpublish was attempted but did not succeed. error: type: string description: | Present when `state` is `failed`. Explains why publish or unpublish could not be applied. blockedReason: type: string enum: - stub-credential - missing-node-type description: | Present when `state` is `blocked`: the imported version could not be published and no version is active. skippedPublishReason: type: string enum: - stub-credential - missing-node-type description: | Present when `state` is `unchanged` but the policy wanted to publish the imported version: a prior published version is still active (for example after an update with stubbed credentials). status: type: string enum: - created - updated - skipped description: Import outcome for this package workflow. removedWorkflows: type: array description: | Workflows the target had that the package does not, removed by `folderConflictPolicy=overwrite`. Empty under every other policy. items: type: object required: - workflowId - name - projectId - parentFolderId - deletion properties: workflowId: type: string description: Id of the removed workflow on this instance. name: type: string projectId: type: string description: Project the workflow was reconciled against. parentFolderId: type: string nullable: true description: Folder that held the workflow, or null at the project root. deletion: type: string enum: - archived - deleted description: | What actually happened, not what `overwriteDeletionPolicy` asked for: a `hard-delete` whose row could not be dropped yet is reported as `archived`. removedFolders: type: array description: | Folders the package does not define that reconciliation left empty, removed by `folderConflictPolicy=overwrite`. A folder still holding anything survives, so target-only content is never swept up. Empty under every other policy. items: type: object required: - folderId - name - projectId - parentFolderId properties: folderId: type: string name: type: string projectId: type: string parentFolderId: type: string nullable: true description: Folder that held it, or null at the project root. folders: type: array description: Folder shells created or skipped in the target project. items: type: object required: - sourceFolderId - localId - name - parentFolderId - status properties: sourceFolderId: type: string description: Folder id as it appeared in the package. localId: type: string description: Folder id on the target instance (equal to `sourceFolderId`; folder ids are reused). name: type: string parentFolderId: type: string nullable: true description: Resolved parent folder on the target, or `null` at the project root. status: type: string enum: - created - skipped description: Import outcome for this package folder. projects: type: array description: | Project shells created, or matched and then updated or left as-is (see `projectConflictPolicy`). Present for project packages; empty when importing loose workflows/folders. items: type: object required: - sourceProjectId - localId - name - status properties: sourceProjectId: type: string description: Project id as it appeared in the package. localId: type: string description: Project id on the target instance (equal to `sourceProjectId`; project ids are reused). name: type: string description: | The project's name on the target: the package's under `overwrite`, the pre-existing one under `merge`. status: type: string enum: - created - updated - skipped description: | Import outcome for this package project. `skipped` means the project already existed and `projectConflictPolicy=merge` left its details untouched — its contents were still imported. credentials: type: object description: | Source credential ids grouped by whether they matched an existing credential or were created as stubs. Full source→target id mapping is in `bindings.credentials`. required: - matched - stubbed properties: matched: type: array items: type: string description: | Source credential ids from the package that matched existing credentials on the target instance. stubbed: type: array items: type: string description: | Source credential ids for which empty placeholder credentials were created in the target project. dataTables: type: object required: - matched - created properties: matched: type: integer minimum: 0 created: type: integer minimum: 0 variables: type: object description: | Resolution of the package's variable requirements. Names only — values never travel in the response. For project packages these arrays are package-level unions of per-destination outcomes and may overlap (for example, a name may be created with a value in one project and stubbed in another); classification under concurrent external writes is best-effort. required: - matched - missing - created - stubbed - updated properties: matched: type: array items: type: string description: | Variable names that resolved to an existing variable (importing project's scope first, then global) and were left untouched. A resolved variable this import rewrote is listed under `updated` instead. missing: type: array items: type: string description: | Variable names still unresolved after import. Under `variableMissingMode=do-nothing` these are warnings — the import still succeeds and nothing is created. A successful `create-stub` or `create-with-value` import normally leaves this empty. created: type: array items: type: string description: | Variable names created with a package value under `variableMissingMode=create-with-value`. Empty stubs are listed under `stubbed`. stubbed: type: array items: type: string description: | Variable names created with an empty value by this import under `variableMissingMode=create-stub`, or because `create-with-value` had no exported value. Empty for other outcomes. updated: type: array items: type: string description: | Variable names whose existing value this import replaced with the package value under `variableConflictPolicy=overwrite`. Empty for other policies. tags: type: object description: | Resolution of the tags referenced by the imported workflows, matched by source id. Tag names only. required: - matched - created - renamed - reconciled - skipped properties: matched: type: array items: type: string description: | Tags that resolved to an existing tag with the same id and name; attached as-is. created: type: array items: type: string description: | Tags created by this import with their package (source) id and name, under `tagMissingMode=create`. renamed: type: array items: type: string description: | Target tags renamed to the package name under `tagConflictPolicy=rename`; listed by their new name. reconciled: type: array items: type: string description: | Existing target tags re-keyed to the package (source) id on a name collision under `tagConflictPolicy=rename`; their name, workflow and folder taggings are kept. skipped: type: array items: type: string description: | Tags dropped from the import — not created, not renamed, and not attached to any imported workflow — under `tagMissingMode=do-nothing` or `tagConflictPolicy=skip`. bindings: type: object description: | Source id → target id mappings produced during import, one map per entity type. Each value maps an id as it appeared in the package to the id on the target instance. required: - workflows - credentials properties: workflows: type: object additionalProperties: type: string credentials: type: object description: | Credential id from `requirements.credentials` in the package manifest → matched credential id on the target instance. additionalProperties: type: string '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': description: | Import blocked by at least one conflict among the issues — a workflow source-id conflict, a folder conflict (id under a different parent, id owned by another project, or a `fail`-policy match), a tag conflict (rename drift or name collision), a variable whose bundled value differs from the resolved target's under `variableConflictPolicy=fail`, or one row two projects of a package would overwrite with different values. content: application/json: schema: type: object required: - message - issues properties: message: type: string issues: type: array items: $ref: '#/components/schemas/importBlockingIssue' '422': description: | Import blocked by non-conflict issues only (e.g. unresolved credentials or variables, node types this instance does not have under `missingNodeTypeMode=fail`, or variable stubs whose creation would exceed the instance variable quota). content: application/json: schema: type: object required: - message - issues properties: message: type: string issues: type: array items: $ref: '#/components/schemas/importBlockingIssue' /settings/log-streaming/event-types: get: x-eov-operation-id: getEventTypes x-required-scope: eventBusDestination:list x-eov-operation-handler: v1/handlers/log-streaming/log-streaming.handler tags: - LogStreaming summary: List streamable event types description: | List the event types that can be streamed to a log streaming destination. Requires the `eventBusDestination:list` scope and the Log Streaming feature to be licensed. responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/event-types' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' /settings/log-streaming/destinations: get: x-eov-operation-id: getDestinations x-required-scope: eventBusDestination:list x-eov-operation-handler: v1/handlers/log-streaming/log-streaming.handler tags: - LogStreaming summary: List log streaming destinations description: | List the configured log streaming destinations. Requires the `eventBusDestination:list` scope and the Log Streaming feature to be licensed. responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/destination.list' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' post: x-eov-operation-id: createDestination x-required-scope: eventBusDestination:create x-eov-operation-handler: v1/handlers/log-streaming/log-streaming.handler tags: - LogStreaming summary: Create a log streaming destination description: | Create a log streaming destination. The destination takes effect exactly as it would from the UI, using the same validation. Requires the `eventBusDestination:create` scope and the Log Streaming feature to be licensed. When destinations are managed via environment variables, the write is rejected with 409 and nothing is created; reads still return the current values. requestBody: description: The destination to create. required: true content: application/json: schema: $ref: '#/components/schemas/destination' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/destination' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' /settings/log-streaming/destinations/{id}/test: post: x-eov-operation-id: testDestination x-required-scope: eventBusDestination:test x-eov-operation-handler: v1/handlers/log-streaming/log-streaming.handler tags: - LogStreaming summary: Send a test message to a log streaming destination description: | Send a test message to the destination to verify it is reachable and configured correctly. Requires the `eventBusDestination:test` scope and the Log Streaming feature to be licensed. parameters: - name: id in: path description: The id of the log streaming destination. required: true schema: type: string responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/test-result' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' /settings/log-streaming/destinations/{id}: get: x-eov-operation-id: getDestination x-required-scope: eventBusDestination:read x-eov-operation-handler: v1/handlers/log-streaming/log-streaming.handler tags: - LogStreaming summary: Retrieve a log streaming destination description: | Retrieve a single log streaming destination by id. Requires the `eventBusDestination:read` scope and the Log Streaming feature to be licensed. parameters: - name: id in: path description: The id of the log streaming destination. required: true schema: type: string responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/destination' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' put: x-eov-operation-id: updateDestination x-required-scope: eventBusDestination:update x-eov-operation-handler: v1/handlers/log-streaming/log-streaming.handler tags: - LogStreaming summary: Update a log streaming destination description: | Replace an existing log streaming destination. The update takes effect exactly as it would from the UI, using the same validation. Requires the `eventBusDestination:update` scope and the Log Streaming feature to be licensed. When destinations are managed via environment variables, the write is rejected with 409 and nothing is changed; reads still return the current values. parameters: - name: id in: path description: The id of the log streaming destination. required: true schema: type: string requestBody: description: The destination fields to apply. required: true content: application/json: schema: $ref: '#/components/schemas/destination' responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/destination' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' delete: x-eov-operation-id: deleteDestination x-required-scope: eventBusDestination:delete x-eov-operation-handler: v1/handlers/log-streaming/log-streaming.handler tags: - LogStreaming summary: Delete a log streaming destination description: | Remove a log streaming destination. Requires the `eventBusDestination:delete` scope and the Log Streaming feature to be licensed. When destinations are managed via environment variables, the delete is rejected with 409 and nothing is removed; reads still return the current values. parameters: - name: id in: path description: The id of the log streaming destination. required: true schema: type: string responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/destination' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' /credentials: get: operationId: getCredentials 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. x-required-scope: credential:list parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true responses: '200': description: Operation successful. content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string name: type: string type: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time shared: type: array items: type: object properties: id: type: string name: type: string role: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - name - role - createdAt - updatedAt required: - id - name - type - createdAt - updatedAt - shared nextCursor: type: string nullable: true required: - data - nextCursor '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' post: operationId: createCredential tags: - Credential summary: Create a credential description: Creates a credential that can be used by nodes of the specified type. x-required-scope: credential:create x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true requestBody: required: true content: application/json: schema: type: object properties: id: type: string minLength: 1 maxLength: 16 pattern: ^[a-zA-Z0-9_-]+$ description: An unused credential ID of 1–16 letters, digits, underscores, or hyphens. The supplied ID is preserved exactly. Omit to generate an ID. example: R2DjclaysHbqn778 name: type: string example: Joe's Github Credentials type: type: string example: githubApi data: type: object additionalProperties: nullable: true writeOnly: true example: accessToken: ada612vad6fa5df4adf5a5dsf4389adsf76da7s isResolvable: type: boolean description: Whether this credential has resolvable fields example: false createdAt: type: string format: date-time readOnly: true example: 2022-04-29T11:02:29.842Z updatedAt: type: string format: date-time readOnly: true example: 2022-04-29T11:02:29.842Z projectId: type: string description: Project to create the credential in. Defaults to the user's personal project. example: VmwOO9HeTEj20kxM required: - name - type - data responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/credentialPublicDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '415': $ref: '#/components/responses/unsupportedMediaType' /credentials/{credentialId}: get: operationId: getCredential tags: - Credential summary: Get credential by ID description: Retrieves a credential by ID. Credential data (secrets) is not included. x-required-scope: credential:read x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the credential. name: credentialId in: path responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/credentialPublicDto.generated' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' patch: operationId: updateCredential tags: - Credential summary: Update credential by ID description: Updates an existing credential. You must be the owner of the credential. x-required-scope: credential:update x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the credential. name: credentialId in: path requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The name of the credential example: Updated Credential Name type: type: string description: The credential type. If changing type, data must also be provided. example: githubApi data: type: object additionalProperties: nullable: true description: The credential data. Required when changing credential type. writeOnly: true example: accessToken: new_token_value isGlobal: type: boolean description: Whether this credential is available globally example: false isResolvable: type: boolean description: Whether this credential has resolvable fields example: false isPartialData: type: boolean default: false description: If true, unredacts and merges existing credential data with the provided data. If false, replaces the entire data object. example: false responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/credentialPublicDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '415': $ref: '#/components/responses/unsupportedMediaType' delete: operationId: deleteCredential tags: - Credential summary: Delete credential by ID description: Deletes a credential from your instance. You must be the owner of the credential. x-required-scope: credential:delete x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the credential. name: credentialId in: path responses: '200': description: Operation successful. content: application/json: schema: type: object properties: id: type: string name: type: string type: type: string isManaged: type: boolean isGlobal: type: boolean isResolvable: type: boolean resolvableAllowFallback: type: boolean resolverId: type: string nullable: true createdAt: type: string format: date-time updatedAt: type: string format: date-time usageScope: type: string enum: - project - instance required: - id - name - type - isManaged - isGlobal - isResolvable - resolvableAllowFallback - resolverId - createdAt - updatedAt - usageScope '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' /credentials/{credentialId}/transfer: put: operationId: transferCredential tags: - Credential summary: Transfer a credential to another project. description: Transfer a credential to another project. x-required-scope: credential:move x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the credential. name: credentialId in: path requestBody: required: true content: application/json: schema: type: object properties: destinationProjectId: type: string description: The ID of the project to transfer the credential to. example: VmwOO9HeTEj20kxM required: - destinationProjectId 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' '415': $ref: '#/components/responses/unsupportedMediaType' /credentials/{credentialId}/test: post: operationId: testCredential tags: - Credential summary: Test credential by ID description: Tests a credential by ID using the stored credential data. x-required-scope: credential:read x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the credential. name: credentialId in: path responses: '200': description: Operation successful. content: application/json: schema: type: object properties: status: type: string enum: - OK - Error example: OK message: type: string example: Connection successful! required: - status - message '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' /credentials/schema/{credentialTypeName}: get: operationId: getCredentialType tags: - Credential summary: Show credential data schema x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The credential type name that you want to get the schema for name: credentialTypeName in: path responses: '200': description: Operation successful. content: application/json: schema: type: object properties: additionalProperties: type: boolean enum: - false type: type: string enum: - object properties: type: object additionalProperties: nullable: true description: JSON Schema fragment for each of the credential type's fields, keyed by field name. example: apiKey: type: string domain: type: string required: type: array items: type: string description: Names of the fields that are required for this credential type. example: - apiKey - domain allOf: type: array items: nullable: true required: - additionalProperties - type - properties - required additionalProperties: false '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/notFound' /executions: get: operationId: getExecutions tags: - Executions summary: Retrieve all executions description: Retrieve all executions from your instance. x-required-scope: execution:list parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - schema: type: string enum: - 'true' - 'false' default: 'false' description: Whether or not to include the execution's detailed data. required: false name: includeData in: query - schema: type: string enum: - 'true' - 'false' default: 'false' description: Whether to return the full execution data even if it exceeds the configured size limit (EXECUTIONS_DATA_MAX_DISPLAY_SIZE). Oversized executions are otherwise returned without their data. required: false name: ignoreDataSizeLimit in: query - schema: type: string enum: - 'true' - 'false' description: Controls execution data redaction. When `true`, execution output data is always redacted. When `false`, requests unredacted (revealed) data — requires the `execution:reveal` scope. When omitted, follows the workflow redaction policy. required: false name: redactExecutionData in: query - schema: type: string enum: - canceled - crashed - error - new - running - success - unknown - waiting description: Status to filter the executions by. required: false name: status in: query - schema: type: string description: Workflow to filter the executions by. example: '1000' required: false name: workflowId in: query - schema: type: string example: VmwOO9HeTEj20kxM required: false name: projectId in: query - schema: type: string format: date-time description: Only return executions that started after this time. example: 2024-01-01T00:00:00.000Z required: false name: startedAfter in: query - schema: type: string format: date-time description: Only return executions that started before this time. example: 2024-12-31T23:59:59.999Z required: false name: startedBefore in: query x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true responses: '200': description: Operation successful. content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string example: '1000' finished: type: boolean description: Whether the execution ran to completion. Use `status` instead. example: true deprecated: true mode: type: string enum: - cli - error - integrated - internal - manual - retry - trigger - webhook - evaluation - chat - agent example: manual retryOf: type: string nullable: true description: ID of the execution this one is a retry of. retrySuccessId: type: string nullable: true description: ID of the retry that succeeded, if this execution failed and a retry did not. example: '2' status: type: string enum: - canceled - crashed - error - new - running - success - unknown - waiting startedAt: type: string nullable: true format: date-time description: Null until the execution leaves the queue and starts running. stoppedAt: type: string nullable: true format: date-time description: When the execution stopped. Null for the `new`, `running` and `unknown` statuses; a `waiting` execution has stopped its current run, so it has a value. workflowId: type: string example: '1000' waitTill: type: string nullable: true format: date-time description: The time at which a waiting execution resumes. storedAt: type: string description: Where the execution data is stored. enum: - db - fs - s3 - az jsonSizeBytes: type: number description: Size of the stored execution data in bytes. 0 means unknown. example: 0 workflowVersionId: type: string nullable: true description: ID of the workflow version this execution ran. data: type: object description: Detailed execution data. Only included when `includeData` is `true`. additionalProperties: true properties: redactionInfo: type: object nullable: true description: Present when execution data has been redacted. properties: isRedacted: type: boolean description: Whether the execution data was redacted. reason: type: string description: The reason for redaction. canReveal: type: boolean description: Whether the current user has permission to reveal the redacted data. workflowData: type: object description: The workflow as it was saved when the execution ran. Only included when `includeData` is `true`. Older executions carry more fields than newer ones. additionalProperties: true customData: type: object description: Execution metadata set by the workflow. Only included when `includeData` is `true`. additionalProperties: type: string dataTooLargeToDisplay: type: boolean description: Present and true when the execution data was larger than `EXECUTIONS_DATA_MAX_DISPLAY_SIZE`. `data` is then empty and `jsonSizeBytes` holds the real size. Use `ignoreDataSizeLimit` to read it anyway. required: - id - finished - mode - retryOf - retrySuccessId - status - startedAt - stoppedAt - workflowId - waitTill nextCursor: type: string nullable: true description: Paginate through executions by setting the cursor parameter to a nextCursor attribute returned by a previous request. Default value fetches the first "page" of the collection. example: eyJsYXN0SWQiOiIxMDAwIiwibGltaXQiOjEwMH0= required: - data - nextCursor '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' /executions/{executionId}: get: operationId: getExecution tags: - Executions summary: Retrieve an execution description: Retrieve an execution from your instance. x-required-scope: execution:read x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: integer minimum: 1 required: true description: The ID of the execution. name: executionId in: path - schema: type: string enum: - 'true' - 'false' default: 'false' description: Whether or not to include the execution's detailed data. required: false name: includeData in: query - schema: type: string enum: - 'true' - 'false' default: 'false' description: Whether to return the full execution data even if it exceeds the configured size limit (EXECUTIONS_DATA_MAX_DISPLAY_SIZE). Oversized executions are otherwise returned without their data. required: false name: ignoreDataSizeLimit in: query - schema: type: string enum: - 'true' - 'false' description: Controls execution data redaction. When `true`, execution output data is always redacted. When `false`, requests unredacted (revealed) data — requires the `execution:reveal` scope. When omitted, follows the workflow redaction policy. required: false name: redactExecutionData in: query responses: '200': description: Operation successful. content: application/json: schema: type: object properties: id: type: string example: '1000' finished: type: boolean description: Whether the execution ran to completion. Use `status` instead. example: true deprecated: true mode: type: string enum: - cli - error - integrated - internal - manual - retry - trigger - webhook - evaluation - chat - agent example: manual retryOf: type: string nullable: true description: ID of the execution this one is a retry of. retrySuccessId: type: string nullable: true description: ID of the retry that succeeded, if this execution failed and a retry did not. example: '2' status: type: string enum: - canceled - crashed - error - new - running - success - unknown - waiting createdAt: type: string format: date-time startedAt: type: string nullable: true format: date-time description: Null until the execution leaves the queue and starts running. stoppedAt: type: string nullable: true format: date-time description: When the execution stopped. Null for the `new`, `running` and `unknown` statuses; a `waiting` execution has stopped its current run, so it has a value. deletedAt: type: string nullable: true format: date-time description: Always null. Soft-deleted executions are not returned. workflowId: type: string example: '1000' waitTill: type: string nullable: true format: date-time description: The time at which a waiting execution resumes. storedAt: type: string description: Where the execution data is stored. enum: - db - fs - s3 - az tracingContext: type: object nullable: true properties: traceparent: type: string tracestate: type: string required: - traceparent description: W3C trace context propagated with the execution. deduplicationKey: type: string nullable: true description: Key used to stop a duplicate execution from being created. jsonSizeBytes: type: number description: Size of the stored execution data in bytes. 0 means unknown. example: 0 binaryDataSizeBytes: type: number description: Size of the stored binary data in bytes. 0 means unknown. example: 0 workflowVersionId: type: string nullable: true description: ID of the workflow version this execution ran. usedPrivateCredentials: type: boolean description: Whether the execution used credentials that are not shared with the project. example: false data: type: object description: Detailed execution data. Only included when `includeData` is `true`. additionalProperties: true properties: redactionInfo: type: object nullable: true description: Present when execution data has been redacted. properties: isRedacted: type: boolean description: Whether the execution data was redacted. reason: type: string description: The reason for redaction. canReveal: type: boolean description: Whether the current user has permission to reveal the redacted data. customData: type: object description: Execution metadata set by the workflow. Only included when `includeData` is `true`. additionalProperties: type: string workflowData: type: object description: The workflow as it was saved when the execution ran. Only included when `includeData` is `true`. Older executions carry more fields than newer ones. additionalProperties: true dataTooLargeToDisplay: type: boolean description: Present and true when the execution data was larger than `EXECUTIONS_DATA_MAX_DISPLAY_SIZE`. `data` is then empty and `jsonSizeBytes` holds the real size. Use `ignoreDataSizeLimit` to read it anyway. required: - id - finished - mode - retryOf - retrySuccessId - status - createdAt - startedAt - stoppedAt - deletedAt - workflowId - waitTill - storedAt - tracingContext - deduplicationKey - jsonSizeBytes - binaryDataSizeBytes - workflowVersionId - usedPrivateCredentials '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' delete: operationId: deleteExecution tags: - Executions summary: Delete an execution description: Deletes an execution from your instance. x-required-scope: execution:delete x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: integer minimum: 1 required: true description: The ID of the execution. name: executionId in: path responses: '200': description: Operation successful. content: application/json: schema: type: object properties: id: type: number description: ID of the deleted execution. This endpoint returns it as a number, where every other execution endpoint returns a string. example: 1000 finished: type: boolean description: Whether the execution ran to completion. Use `status` instead. example: true deprecated: true mode: type: string enum: - cli - error - integrated - internal - manual - retry - trigger - webhook - evaluation - chat - agent example: manual retryOf: type: string nullable: true description: ID of the execution this one is a retry of. retrySuccessId: type: string nullable: true description: ID of the retry that succeeded, if this execution failed and a retry did not. example: '2' status: type: string enum: - canceled - crashed - error - new - running - success - unknown - waiting createdAt: type: string format: date-time startedAt: type: string nullable: true format: date-time description: Null until the execution leaves the queue and starts running. stoppedAt: type: string nullable: true format: date-time description: When the execution stopped. Null for the `new`, `running` and `unknown` statuses; a `waiting` execution has stopped its current run, so it has a value. deletedAt: type: string nullable: true format: date-time description: Always null. Soft-deleted executions are not returned. workflowId: type: string example: '1000' waitTill: type: string nullable: true format: date-time description: The time at which a waiting execution resumes. storedAt: type: string description: Where the execution data is stored. enum: - db - fs - s3 - az tracingContext: type: object nullable: true properties: traceparent: type: string tracestate: type: string required: - traceparent description: W3C trace context propagated with the execution. deduplicationKey: type: string nullable: true description: Key used to stop a duplicate execution from being created. jsonSizeBytes: type: number description: Size of the stored execution data in bytes. 0 means unknown. example: 0 binaryDataSizeBytes: type: number description: Size of the stored binary data in bytes. 0 means unknown. example: 0 workflowVersionId: type: string nullable: true description: ID of the workflow version this execution ran. usedPrivateCredentials: type: boolean description: Whether the execution used credentials that are not shared with the project. example: false required: - id - finished - mode - retryOf - retrySuccessId - status - createdAt - startedAt - stoppedAt - deletedAt - workflowId - waitTill - storedAt - tracingContext - deduplicationKey - jsonSizeBytes - binaryDataSizeBytes - workflowVersionId - usedPrivateCredentials '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' /executions/{executionId}/tags: get: operationId: getExecutionTags tags: - Executions summary: Get execution tags description: Get annotation tags for an execution. x-required-scope: executionTags:list x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: integer minimum: 1 required: true description: The ID of the execution. name: executionId in: path responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/executionTagsPublicDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' put: operationId: updateExecutionTags tags: - Executions summary: Update tags of an execution description: Update annotation tags of an execution. x-required-scope: executionTags:update x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: integer minimum: 1 required: true description: The ID of the execution. name: executionId in: path requestBody: required: true content: application/json: schema: type: array items: type: object properties: id: type: string example: 2tUt1wbLX592XDdX required: - id additionalProperties: false responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/executionTagsPublicDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '415': $ref: '#/components/responses/unsupportedMediaType' /executions/stop: post: operationId: stopManyExecutions tags: - Executions summary: Stop multiple executions description: Stop multiple executions from your instance based on filter criteria. x-required-scope: execution:stop x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true requestBody: required: true content: application/json: schema: type: object properties: status: type: array items: type: string enum: - queued - running - waiting minItems: 1 description: Array of execution statuses to stop. Must include at least one status. example: - queued - running - waiting workflowId: type: string description: Optional workflow ID to filter executions. If not provided, will stop executions across all accessible workflows. The literal value `all` has the same effect as omitting it. 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 required: - status responses: '200': description: Operation successful. content: application/json: schema: type: object properties: stopped: type: integer description: The number of executions that were successfully stopped. example: 5 required: - stopped '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '415': $ref: '#/components/responses/unsupportedMediaType' /executions/{executionId}/stop: post: operationId: stopExecution tags: - Executions summary: Stop an execution description: Stop an execution by id. x-required-scope: execution:stop x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: integer minimum: 1 required: true description: The ID of the execution. name: executionId in: path responses: '200': description: Operation successful. content: application/json: schema: type: object properties: mode: type: string enum: - cli - error - integrated - internal - manual - retry - trigger - webhook - evaluation - chat - agent example: manual startedAt: type: string format: date-time description: The time at which the execution started. stoppedAt: type: string format: date-time description: The time at which the execution stopped. Absent when no stop time was recorded. finished: type: boolean description: Whether the execution ran to completion. Use `status` instead. example: false deprecated: true status: type: string enum: - canceled - crashed - error - new - running - success - unknown - waiting example: canceled required: - mode - startedAt - finished - status '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' /executions/{executionId}/retry: post: operationId: retryExecution tags: - Executions summary: Retry an execution description: Retry an execution from your instance. x-required-scope: execution:retry x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: integer minimum: 1 required: true description: The ID of the execution. name: executionId in: path requestBody: 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: type: object properties: id: type: string description: ID of the new execution that the retry started. example: '1001' mode: type: string enum: - cli - error - integrated - internal - manual - retry - trigger - webhook - evaluation - chat - agent example: retry startedAt: type: string nullable: true format: date-time description: The time at which the new execution started. workflowId: type: string example: '1000' finished: type: boolean description: Whether the execution ran to completion. Use `status` instead. example: true deprecated: true retryOf: type: string nullable: true description: ID of the execution this one is a retry of. status: type: string enum: - canceled - crashed - error - new - running - success - unknown - waiting waitTill: type: string nullable: true format: date-time description: The time at which a waiting execution resumes. data: type: object description: Run data of the new execution. additionalProperties: true properties: redactionInfo: type: object nullable: true description: Present when execution data has been redacted. properties: isRedacted: type: boolean description: Whether the execution data was redacted. reason: type: string description: The reason for redaction. canReveal: type: boolean description: Whether the current user has permission to reveal the redacted data. workflowData: type: object description: The workflow as it was saved when the original execution ran. `loadWorkflow` changes which workflow the retry runs, not what this field reports. additionalProperties: true customData: type: object description: Execution metadata carried over from the original execution. additionalProperties: type: string annotation: type: object properties: id: type: number vote: type: string nullable: true description: Vote left on the original execution. enum: - up - down tags: type: array items: type: object properties: id: type: string name: type: string required: - id - name required: - id - vote - tags description: Annotation on the original execution. Absent when it carries none. storedAt: type: string description: Where the execution data is stored. enum: - db - fs - s3 - az required: - id - mode - startedAt - workflowId - finished - retryOf - status - data - workflowData - customData - storedAt '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '415': $ref: '#/components/responses/unsupportedMediaType' /insights/summary: get: operationId: getInsightsSummary tags: - Insights summary: Retrieve insights summary description: Retrieve the insights summary for the selected date range. x-required-scope: insights:read x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string format: date-time description: ISO 8601 start date. Defaults to 7 days ago. required: false name: startDate in: query - schema: type: string format: date-time description: ISO 8601 end date. Defaults to now. required: false name: endDate in: query - schema: type: string description: Project identifier to filter insights by project. example: VmwOO9HeTEj20kxM required: false name: projectId in: query responses: '200': description: Operation successful. content: application/json: schema: type: object properties: total: type: object properties: value: type: number deviation: type: number nullable: true unit: type: string enum: - count required: - value - deviation - unit failed: type: object properties: value: type: number deviation: type: number nullable: true unit: type: string enum: - count required: - value - deviation - unit failureRate: type: object properties: value: type: number deviation: type: number nullable: true unit: type: string enum: - ratio required: - value - deviation - unit timeSaved: type: object properties: value: type: number deviation: type: number nullable: true unit: type: string enum: - minute required: - value - deviation - unit averageRunTime: type: object properties: value: type: number deviation: type: number nullable: true unit: type: string enum: - millisecond required: - value - deviation - unit required: - total - failed - failureRate - timeSaved - averageRunTime '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' /node-type-policies/instance: get: operationId: getInstancePolicy tags: - NodeTypePolicy summary: Retrieve the instance node type policy description: 'Returns the composed instance-scope policy: its default action and the rules of every attached policy document in evaluation order. An instance that was never configured reports `scopeId: null`, no rules, `defaultAction: allow`, and `version: 0`.' x-required-scope: nodeTypePolicy:manage x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/policyEffectivePublicDto.generated' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '503': $ref: '#/components/responses/serviceUnavailable' put: operationId: putInstancePolicy tags: - NodeTypePolicy summary: Replace the instance node type policy description: Sets the instance default action and replaces the rules of its single policy document, creating both on first write. `version` must equal the version last read; a stale value is rejected with 409. Rule ids must be unique within the list. x-required-scope: nodeTypePolicy:manage x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true requestBody: required: true content: application/json: schema: type: object properties: rules: type: array items: type: object properties: id: type: string minLength: 1 action: type: string enum: - allow - deny - delegate selector: oneOf: - type: object properties: kind: type: string enum: - name value: type: string minLength: 1 required: - kind - value - type: object properties: kind: type: string enum: - package value: type: string minLength: 1 required: - kind - value required: - id - action - selector defaultAction: type: string enum: - allow - deny - delegate version: type: integer minimum: 0 required: - rules - defaultAction - version responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/policyEffectiveWriteResultPublicDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' '415': $ref: '#/components/responses/unsupportedMediaType' '503': $ref: '#/components/responses/serviceUnavailable' /node-type-policies/projects/{projectId}: get: operationId: getProjectPolicy tags: - NodeTypePolicy summary: Retrieve a project's node type policy description: "Returns the project's own composed policy, not the result of combining it with the instance policy. A project that was never configured reports `scopeId: null`, no rules, `defaultAction: allow`, and `version: 0`." x-required-scope: nodeTypePolicy:manage x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the project. name: projectId in: path responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/policyEffectivePublicDto.generated' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '503': $ref: '#/components/responses/serviceUnavailable' put: operationId: putProjectPolicy tags: - NodeTypePolicy summary: Replace a project's node type policy description: Sets the project's default action and replaces the rules of its single policy document, creating both on first write. The `delegate` action is not accepted at project scope. `version` must equal the version last read; a stale value is rejected with 409, as is a project document that is shared with another scope. x-required-scope: nodeTypePolicy:manage x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the project. name: projectId in: path requestBody: required: true content: application/json: schema: type: object properties: rules: type: array items: type: object properties: id: type: string minLength: 1 action: type: string enum: - allow - deny selector: oneOf: - type: object properties: kind: type: string enum: - name value: type: string minLength: 1 required: - kind - value - type: object properties: kind: type: string enum: - package value: type: string minLength: 1 required: - kind - value required: - id - action - selector defaultAction: type: string enum: - allow - deny version: type: integer minimum: 0 required: - rules - defaultAction - version responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/policyEffectiveWriteResultPublicDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' '415': $ref: '#/components/responses/unsupportedMediaType' '503': $ref: '#/components/responses/serviceUnavailable' /node-type-policies/policies: get: operationId: listPolicyDocuments tags: - NodeTypePolicy summary: List node type policy documents description: Returns a cursor-paginated list of reusable policy documents. x-required-scope: nodeTypePolicy:manage parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true responses: '200': description: Operation successful. content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string kind: type: string rules: type: array items: type: object properties: id: type: string minLength: 1 action: type: string enum: - allow - deny - delegate selector: oneOf: - type: object properties: kind: type: string enum: - name value: type: string minLength: 1 required: - kind - value - type: object properties: kind: type: string enum: - package value: type: string minLength: 1 required: - kind - value required: - id - action - selector version: type: integer minimum: 0 exclusiveMinimum: true updatedBy: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - kind - rules - version - updatedBy - createdAt - updatedAt nextCursor: type: string nullable: true required: - data - nextCursor '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '503': $ref: '#/components/responses/serviceUnavailable' post: operationId: createPolicyDocument tags: - NodeTypePolicy summary: Create a node type policy document description: Creates a reusable policy document that is not yet attached to any scope. Rule ids must be unique within the list. `warnings` lists rules that an earlier rule already shadows. x-required-scope: nodeTypePolicy:manage x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true requestBody: required: true content: application/json: schema: type: object properties: rules: type: array items: type: object properties: id: type: string minLength: 1 action: type: string enum: - allow - deny - delegate selector: oneOf: - type: object properties: kind: type: string enum: - name value: type: string minLength: 1 required: - kind - value - type: object properties: kind: type: string enum: - package value: type: string minLength: 1 required: - kind - value required: - id - action - selector required: - rules responses: '201': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/policyDocumentWriteResultPublicDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '503': $ref: '#/components/responses/serviceUnavailable' /node-type-policies/policies/{policyId}: get: operationId: getPolicyDocument tags: - NodeTypePolicy summary: Retrieve a node type policy document x-required-scope: nodeTypePolicy:manage x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the node type policy document. name: policyId in: path responses: '200': description: Operation successful. content: application/json: schema: type: object properties: id: type: string kind: type: string rules: type: array items: type: object properties: id: type: string minLength: 1 action: type: string enum: - allow - deny - delegate selector: oneOf: - type: object properties: kind: type: string enum: - name value: type: string minLength: 1 required: - kind - value - type: object properties: kind: type: string enum: - package value: type: string minLength: 1 required: - kind - value required: - id - action - selector version: type: integer minimum: 0 exclusiveMinimum: true updatedBy: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - kind - rules - version - updatedBy - createdAt - updatedAt '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '503': $ref: '#/components/responses/serviceUnavailable' put: operationId: updatePolicyDocument tags: - NodeTypePolicy summary: Replace the rules of a node type policy document description: Replaces the document's whole rule list. `version` must equal the version last read; a stale value is rejected with 409. Every scope the document is attached to has its version bumped. A `delegate` rule is rejected when the document is attached to a project scope. x-required-scope: nodeTypePolicy:manage x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the node type policy document. name: policyId in: path requestBody: required: true content: application/json: schema: type: object properties: rules: type: array items: type: object properties: id: type: string minLength: 1 action: type: string enum: - allow - deny - delegate selector: oneOf: - type: object properties: kind: type: string enum: - name value: type: string minLength: 1 required: - kind - value - type: object properties: kind: type: string enum: - package value: type: string minLength: 1 required: - kind - value required: - id - action - selector version: type: integer minimum: 0 required: - rules - version responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/policyDocumentWriteResultPublicDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '415': $ref: '#/components/responses/unsupportedMediaType' '503': $ref: '#/components/responses/serviceUnavailable' delete: operationId: deletePolicyDocument tags: - NodeTypePolicy summary: Delete a node type policy document description: Deletes a policy document. A document that is still attached to a scope is rejected with 409; detach it first. x-required-scope: nodeTypePolicy:manage x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the node type policy document. name: policyId in: path responses: '204': description: Operation successful. '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '503': $ref: '#/components/responses/serviceUnavailable' /node-type-policies/scopes/{scopeId}/attachments: put: operationId: replaceAttachments tags: - NodeTypePolicy summary: Replace a scope's attached policy documents description: Replaces every attachment on a scope. `scopeId` comes from the scope's `GET` response once it has been written. Each `policyId` and each `(isFloor, priority)` pair must be unique within the list. Last write wins; the scope's version is bumped. x-required-scope: nodeTypePolicy:manage x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the node type policy scope. name: scopeId in: path requestBody: required: true content: application/json: schema: type: object properties: attachments: type: array items: type: object properties: policyId: type: string minLength: 1 priority: type: integer isFloor: type: boolean required: - policyId - priority - isFloor required: - attachments responses: '200': description: Operation successful. content: application/json: schema: type: object properties: attachments: type: array items: type: object properties: policyId: type: string rules: type: array items: type: object properties: id: type: string minLength: 1 action: type: string enum: - allow - deny - delegate selector: oneOf: - type: object properties: kind: type: string enum: - name value: type: string minLength: 1 required: - kind - value - type: object properties: kind: type: string enum: - package value: type: string minLength: 1 required: - kind - value required: - id - action - selector priority: type: integer isFloor: type: boolean required: - policyId - rules - priority - isFloor version: type: integer minimum: 0 exclusiveMinimum: true required: - attachments - version '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '415': $ref: '#/components/responses/unsupportedMediaType' '503': $ref: '#/components/responses/serviceUnavailable' /projects: get: operationId: getProjects tags: - Projects summary: Retrieve projects description: Retrieve projects from your instance. x-required-scope: project:list parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true responses: '200': description: Operation successful. content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string readOnly: true example: VmwOO9HeTEj20kxM name: type: string example: Marketing type: type: string enum: - personal - team readOnly: true example: team icon: type: object description: Icon of the project, or null when the project has none properties: type: type: string enum: - emoji - icon value: type: string color: type: string required: - type - value nullable: true description: type: string nullable: true example: Workflows the marketing team owns. customTelemetryTags: type: array items: type: object properties: key: type: string value: type: string required: - key - value creatorId: type: string nullable: true example: f9a2cbb8-0b1e-4b64-9c1c-0d5f5f1f2a3b createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true required: - id - name - type - icon - description - customTelemetryTags - creatorId - createdAt - updatedAt nextCursor: type: string nullable: true description: Paginate through projects by setting the cursor parameter to a nextCursor attribute returned by a previous request. Default value fetches the first "page" of the collection. example: eyJvZmZzZXQiOjEwMCwibGltaXQiOjEwMH0= required: - data - nextCursor '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' post: operationId: createProject tags: - Projects summary: Create a project description: Create a project on your instance. x-required-scope: project:create x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 255 example: Marketing id: type: string readOnly: true type: type: string readOnly: true required: - name additionalProperties: false responses: '201': description: Operation successful. content: application/json: schema: type: object properties: id: type: string readOnly: true example: VmwOO9HeTEj20kxM name: type: string example: Marketing type: type: string enum: - personal - team readOnly: true example: team icon: type: object description: Icon of the project, or null when the project has none properties: type: type: string enum: - emoji - icon value: type: string color: type: string required: - type - value nullable: true description: type: string nullable: true example: Workflows the marketing team owns. customTelemetryTags: type: array items: type: object properties: key: type: string value: type: string required: - key - value creatorId: type: string nullable: true example: f9a2cbb8-0b1e-4b64-9c1c-0d5f5f1f2a3b createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true role: type: string description: The caller's role in the new project. example: project:admin scopes: type: array items: type: string description: Scopes the caller holds in the new project. required: - id - name - type - icon - description - customTelemetryTags - creatorId - createdAt - updatedAt - role - scopes '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' /projects/{projectId}: put: operationId: updateProject tags: - Projects summary: Update a project description: Update a project on your instance. x-required-scope: project:update x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the project. name: projectId in: path requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 255 example: Marketing id: type: string readOnly: true type: type: string readOnly: true required: - name additionalProperties: false 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' '415': $ref: '#/components/responses/unsupportedMediaType' delete: operationId: deleteProject tags: - Projects summary: Delete a project description: Delete a project from your instance. x-required-scope: project:delete x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the project. name: projectId in: path 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' /projects/{projectId}/users: get: operationId: getProjectUsers tags: - Projects summary: List project members description: Returns a list of all members of a project including their role. Requires user:list scope. x-required-scope: user:list parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - schema: type: string required: true description: The ID of the project. name: projectId in: path x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true responses: '200': description: Operation successful. content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string description: The user's unique identifier. readOnly: true example: 123e4567-e89b-12d3-a456-426614174000 email: type: string format: email description: The user's email address. readOnly: true example: john.doe@company.com firstName: type: string nullable: true maxLength: 32 description: The user's first name. readOnly: true example: john lastName: type: string nullable: true maxLength: 32 description: The user's last name. readOnly: true example: Doe createdAt: type: string format: date-time description: When the user was created. readOnly: true updatedAt: type: string format: date-time description: When the user was last updated. readOnly: true role: type: string nullable: true description: The user's role in the project (e.g. project:admin, project:viewer). readOnly: true example: project:viewer required: - id - email - firstName - lastName - createdAt - updatedAt - role description: A project member (user with their role in the project). nextCursor: type: string nullable: true description: Paginate through project members by setting the cursor parameter to the nextCursor attribute returned by a previous request. Default value fetches the first page of the collection. example: eyJvZmZzZXQiOjEwMCwibGltaXQiOjEwMH0= required: - data - nextCursor '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' post: operationId: addUsersToProject tags: - Projects summary: Add one or more users to a project description: Add one or more users to a project on your instance. x-required-scope: project:manageMembers x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the project. name: projectId in: path requestBody: required: true content: application/json: schema: type: object properties: relations: type: array items: type: object properties: userId: type: string minLength: 1 description: The unique identifier of the user. example: 91765f0d-3b29-45df-adb9-35b23937eb92 role: type: string minLength: 1 description: The role assigned to the user in the project. example: project:viewer required: - userId - role minItems: 1 description: A list of userIds and roles to add to the project. required: - relations responses: '201': description: Operation successful. '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '415': $ref: '#/components/responses/unsupportedMediaType' /projects/{projectId}/users/{userId}: patch: operationId: changeUserRoleInProject tags: - Projects summary: Change a user's role in a project description: Change a user's role in a project. x-required-scope: project:manageMembers x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the project. name: projectId in: path - schema: type: string required: true description: The ID of the user. name: userId in: path requestBody: required: true content: application/json: schema: type: object properties: role: type: string minLength: 1 description: The role assigned to the user in the project. example: project:viewer required: - role 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' '415': $ref: '#/components/responses/unsupportedMediaType' delete: operationId: deleteUserFromProject tags: - Projects summary: Delete a user from a project description: Delete a user from a project on your instance. x-required-scope: project:manageMembers x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the project. name: projectId in: path - schema: type: string required: true description: The ID of the user. name: userId in: path responses: '204': description: Operation successful. '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' /promotions/providers: post: operationId: createPromotionProvider tags: - Promotions summary: Create a promotion provider description: Creates a provider and its authentication material. An SSH provider returns the generated public key; add it to the remote as a deploy key. x-required-scope: gitConnection:create x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 128 type: type: string enum: - git auth: oneOf: - type: object properties: authType: type: string enum: - ssh-key keyType: type: string enum: - ed25519 - rsa default: ed25519 required: - authType additionalProperties: false - type: object properties: authType: type: string enum: - token username: type: string minLength: 1 password: type: string minLength: 1 required: - authType - username - password additionalProperties: false required: - name - type - auth additionalProperties: false responses: '201': description: Operation successful. content: application/json: schema: type: object properties: provider: type: object properties: id: type: string minLength: 1 maxLength: 36 name: type: string type: type: string enum: - git authType: type: string enum: - ssh-key - token config: anyOf: - type: object properties: schemaVersion: type: number enum: - 1 publicKey: type: string minLength: 1 keyType: type: string enum: - ed25519 - rsa required: - schemaVersion - publicKey - keyType additionalProperties: false - type: object properties: schemaVersion: type: number enum: - 1 required: - schemaVersion additionalProperties: false createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - name - type - authType - config - createdAt - updatedAt publicKey: type: string nullable: true required: - provider - publicKey '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '503': $ref: '#/components/responses/serviceUnavailable' get: operationId: getPromotionProviders tags: - Promotions summary: List promotion providers description: Returns a cursor-paginated list of providers, without their public keys. x-required-scope: gitConnection:list parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true responses: '200': description: Operation successful. content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string minLength: 1 maxLength: 36 name: type: string type: type: string enum: - git authType: type: string enum: - ssh-key - token createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - name - type - authType - createdAt - updatedAt nextCursor: type: string nullable: true required: - data - nextCursor '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '503': $ref: '#/components/responses/serviceUnavailable' /promotions/providers/{promotionProviderId}: get: operationId: getPromotionProvider tags: - Promotions summary: Retrieve a promotion provider description: Returns the provider with its public configuration. Secrets are never returned. x-required-scope: gitConnection:read x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the promotion provider. name: promotionProviderId in: path responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/promotionProviderPublicDto.generated' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '503': $ref: '#/components/responses/serviceUnavailable' put: operationId: updatePromotionProvider tags: - Promotions summary: Update a promotion provider description: Renames the provider, and replaces its credentials when `auth` is sent. New credentials apply to every connection that uses this provider. The authentication method cannot change. x-required-scope: gitConnection:update x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the promotion provider. name: promotionProviderId in: path requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 128 auth: oneOf: - type: object properties: authType: type: string enum: - ssh-key keyType: type: string enum: - ed25519 - rsa required: - authType additionalProperties: false - type: object properties: authType: type: string enum: - token username: type: string minLength: 1 password: type: string minLength: 1 required: - authType - username - password additionalProperties: false additionalProperties: false minProperties: 1 responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/promotionProviderPublicDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '415': $ref: '#/components/responses/unsupportedMediaType' '503': $ref: '#/components/responses/serviceUnavailable' delete: operationId: deletePromotionProvider tags: - Promotions summary: Delete a promotion provider description: A provider used by a connection cannot be deleted. x-required-scope: gitConnection:delete x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the promotion provider. name: promotionProviderId in: path responses: '204': description: Operation successful. '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '503': $ref: '#/components/responses/serviceUnavailable' /promotions/connections: post: operationId: createPromotionConnection tags: - Promotions summary: Create a promotion connection description: Creates a connection on an existing provider, with up to one initial configuration for each direction. Only one instance connection can exist. x-required-scope: gitConnection:create x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 128 scope: type: string enum: - instance - projects providerId: type: string minLength: 1 maxLength: 36 target: type: object properties: schemaVersion: type: number enum: - 1 remoteUrl: type: string minLength: 1 required: - schemaVersion - remoteUrl additionalProperties: false configs: type: object properties: apply: type: object properties: name: type: string minLength: 1 maxLength: 128 settings: type: object properties: schemaVersion: type: number enum: - 1 branchName: type: string minLength: 1 maxLength: 255 required: - schemaVersion - branchName additionalProperties: false required: - settings additionalProperties: false promote: type: object properties: name: type: string minLength: 1 maxLength: 128 settings: type: object properties: schemaVersion: type: number enum: - 1 baseBranchName: type: string minLength: 1 maxLength: 255 createBranchOnPromotion: type: boolean required: - schemaVersion - baseBranchName - createBranchOnPromotion additionalProperties: false required: - settings additionalProperties: false additionalProperties: false required: - name - scope - providerId - target additionalProperties: false responses: '201': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/promotionConnectionPublicDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '415': $ref: '#/components/responses/unsupportedMediaType' '503': $ref: '#/components/responses/serviceUnavailable' get: operationId: getPromotionConnections tags: - Promotions summary: List promotion connections description: Returns a cursor-paginated list of connections with their configurations. Filter by `scope` for the instance connection, or by `providerId` to see which connections a provider edit affects. x-required-scope: gitConnection:list parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - schema: type: string enum: - instance - projects required: false name: scope in: query - schema: type: string minLength: 1 maxLength: 36 required: false name: providerId in: query x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true responses: '200': description: Operation successful. content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string minLength: 1 maxLength: 36 name: type: string scope: type: string enum: - instance - projects target: type: object properties: schemaVersion: type: number enum: - 1 remoteUrl: type: string minLength: 1 required: - schemaVersion - remoteUrl additionalProperties: false provider: type: object properties: id: type: string minLength: 1 maxLength: 36 name: type: string type: type: string enum: - git authType: type: string enum: - ssh-key - token createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - name - type - authType - createdAt - updatedAt configs: type: object properties: apply: type: object properties: id: type: string minLength: 1 maxLength: 36 name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time settings: type: object properties: schemaVersion: type: number enum: - 1 branchName: type: string minLength: 1 maxLength: 255 required: - schemaVersion - branchName additionalProperties: false required: - id - name - createdAt - updatedAt - settings promote: type: object properties: id: type: string minLength: 1 maxLength: 36 name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time settings: type: object properties: schemaVersion: type: number enum: - 1 baseBranchName: type: string minLength: 1 maxLength: 255 createBranchOnPromotion: type: boolean required: - schemaVersion - baseBranchName - createBranchOnPromotion additionalProperties: false required: - id - name - createdAt - updatedAt - settings createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - name - scope - target - provider - configs - createdAt - updatedAt nextCursor: type: string nullable: true required: - data - nextCursor '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '503': $ref: '#/components/responses/serviceUnavailable' /promotions/connections/{promotionConnectionId}: get: operationId: getPromotionConnection tags: - Promotions summary: Retrieve a promotion connection description: Returns the connection with its provider summary and its configurations. x-required-scope: gitConnection:read x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the promotion connection. name: promotionConnectionId in: path responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/promotionConnectionPublicDto.generated' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '503': $ref: '#/components/responses/serviceUnavailable' put: operationId: updatePromotionConnection tags: - Promotions summary: Update a promotion connection description: Updates the name, target, or provider. Scope cannot change, and configurations have their own routes. x-required-scope: gitConnection:update x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the promotion connection. name: promotionConnectionId in: path requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 128 target: type: object properties: schemaVersion: type: number enum: - 1 remoteUrl: type: string minLength: 1 required: - schemaVersion - remoteUrl additionalProperties: false providerId: type: string minLength: 1 maxLength: 36 additionalProperties: false minProperties: 1 responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/promotionConnectionPublicDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '415': $ref: '#/components/responses/unsupportedMediaType' '503': $ref: '#/components/responses/serviceUnavailable' delete: operationId: deletePromotionConnection tags: - Promotions summary: Delete a promotion connection description: Deletes the connection with its configurations, project links, and local checkouts. Its provider is kept. x-required-scope: gitConnection:delete x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the promotion connection. name: promotionConnectionId in: path responses: '204': description: Operation successful. '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '503': $ref: '#/components/responses/serviceUnavailable' /promotions/connections/{promotionConnectionId}/configs/apply: put: operationId: upsertPromotionApplyConfig tags: - Promotions summary: Create or replace the Apply configuration description: Replaces the whole configuration, so an omitted name resets it to "Apply". Answers 200 whether it created or replaced. x-required-scope: gitConnection:update x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the promotion connection. name: promotionConnectionId in: path requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 128 settings: type: object properties: schemaVersion: type: number enum: - 1 branchName: type: string minLength: 1 maxLength: 255 required: - schemaVersion - branchName additionalProperties: false required: - settings additionalProperties: false responses: '200': description: Operation successful. content: application/json: schema: type: object properties: id: type: string minLength: 1 maxLength: 36 name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time checkout: type: object properties: hasCheckout: type: boolean matchesConfig: type: boolean required: - hasCheckout - matchesConfig settings: type: object properties: schemaVersion: type: number enum: - 1 branchName: type: string minLength: 1 maxLength: 255 required: - schemaVersion - branchName additionalProperties: false required: - id - name - createdAt - updatedAt - checkout - settings '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '415': $ref: '#/components/responses/unsupportedMediaType' '503': $ref: '#/components/responses/serviceUnavailable' /promotions/connections/{promotionConnectionId}/configs/promote: put: operationId: upsertPromotionPromoteConfig tags: - Promotions summary: Create or replace the Promote configuration description: Replaces the whole configuration, so an omitted name resets it to "Promote" and `createBranchOnPromotion` is always required. Answers 200 whether it created or replaced. x-required-scope: gitConnection:update x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the promotion connection. name: promotionConnectionId in: path requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 128 settings: type: object properties: schemaVersion: type: number enum: - 1 baseBranchName: type: string minLength: 1 maxLength: 255 createBranchOnPromotion: type: boolean required: - schemaVersion - baseBranchName - createBranchOnPromotion additionalProperties: false required: - settings additionalProperties: false responses: '200': description: Operation successful. content: application/json: schema: type: object properties: id: type: string minLength: 1 maxLength: 36 name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time checkout: type: object properties: hasCheckout: type: boolean matchesConfig: type: boolean required: - hasCheckout - matchesConfig settings: type: object properties: schemaVersion: type: number enum: - 1 baseBranchName: type: string minLength: 1 maxLength: 255 createBranchOnPromotion: type: boolean required: - schemaVersion - baseBranchName - createBranchOnPromotion additionalProperties: false required: - id - name - createdAt - updatedAt - checkout - settings '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '415': $ref: '#/components/responses/unsupportedMediaType' '503': $ref: '#/components/responses/serviceUnavailable' /promotions/connections/{promotionConnectionId}/configs/{direction}: delete: operationId: deletePromotionConfig tags: - Promotions summary: Remove one direction description: Deletes the configuration and its local checkout. Nothing in Git changes. x-required-scope: gitConnection:update x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the promotion connection. name: promotionConnectionId in: path - schema: type: string enum: - apply - promote required: true description: 'The direction of the promotion: apply or promote.' name: direction in: path responses: '204': description: Operation successful. '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '503': $ref: '#/components/responses/serviceUnavailable' /promotions/connections/{promotionConnectionId}/{direction}/clone: post: operationId: clonePromotionCheckout tags: - Promotions summary: Clone one direction's repository description: Clones the configured branch into local storage on the instance that handles the request. Safe to call repeatedly. Cloning one direction does not make the other ready. x-required-scope: gitConnection:clone x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the promotion connection. name: promotionConnectionId in: path - schema: type: string enum: - apply - promote required: true description: 'The direction of the promotion: apply or promote.' name: direction in: path responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/promotionCheckoutPublicDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '503': $ref: '#/components/responses/serviceUnavailable' /promotions/connections/{promotionConnectionId}/{direction}/disconnect: post: operationId: disconnectPromotionCheckout tags: - Promotions summary: Remove one direction's local checkout description: Removes the local checkout and keeps the configuration, its credentials, and the trusted SSH host keys. x-required-scope: gitConnection:clone x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the promotion connection. name: promotionConnectionId in: path - schema: type: string enum: - apply - promote required: true description: 'The direction of the promotion: apply or promote.' name: direction in: path responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/promotionCheckoutPublicDto.generated' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '503': $ref: '#/components/responses/serviceUnavailable' /promotions/connections/{promotionConnectionId}/projects: get: operationId: getPromotionConnectionProjects tags: - Promotions summary: List projects linked to a promotion connection x-required-scope: gitConnection:read x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the promotion connection. name: promotionConnectionId in: path responses: '200': description: Operation successful. content: application/json: schema: type: object properties: projectIds: type: array items: type: string minLength: 1 maxLength: 36 required: - projectIds '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '503': $ref: '#/components/responses/serviceUnavailable' /promotions/connections/{promotionConnectionId}/projects/{projectId}: post: operationId: addProjectToPromotionConnection tags: - Promotions summary: Link a project to a promotion connection description: Links a team project to a project-scoped connection. A project can be linked to only one connection. x-required-scope: gitConnection:manageProjects x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the promotion connection. name: promotionConnectionId in: path - schema: type: string required: true description: The ID of the project. name: projectId in: path responses: '200': description: Operation successful. content: application/json: schema: type: object properties: projectId: type: string minLength: 1 maxLength: 36 connectionId: type: string minLength: 1 maxLength: 36 required: - projectId - connectionId '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '503': $ref: '#/components/responses/serviceUnavailable' delete: operationId: removeProjectFromPromotionConnection tags: - Promotions summary: Unlink a project from a promotion connection x-required-scope: gitConnection:manageProjects x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the promotion connection. name: promotionConnectionId in: path - schema: type: string required: true description: The ID of the project. name: projectId in: path responses: '204': description: Operation successful. '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '503': $ref: '#/components/responses/serviceUnavailable' /promotions/connections/{promotionConnectionId}/promote: post: operationId: promotePackage tags: - Promotions summary: Promote all team projects description: Exports every team project, commits it, and pushes to the configured base branch or a new timestamped branch. The response reports the target branch in `git.branchName`. Personal projects are ignored. Requires the Promote direction to be cloned first, and is available on the instance connection only. The API key also needs variable:list when the workflows reference variables. x-required-scope: gitConnection:push x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the promotion connection. name: promotionConnectionId in: path requestBody: required: true content: application/json: schema: type: object properties: commitMessage: type: string minLength: 1 maxLength: 1000 force: type: boolean required: - commitMessage additionalProperties: false responses: '200': description: Operation successful. content: application/json: schema: type: object properties: connectionId: type: string minLength: 1 maxLength: 36 configId: type: string minLength: 1 maxLength: 36 counts: type: object properties: workflows: type: integer minimum: 0 folders: type: integer minimum: 0 credentials: type: integer minimum: 0 dataTables: type: integer minimum: 0 variables: type: integer minimum: 0 tags: type: integer minimum: 0 required: - workflows - folders - credentials - dataTables - variables - tags git: type: object properties: commitSha: type: string branchName: type: string required: - commitSha - branchName required: - connectionId - configId - counts - git '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '415': $ref: '#/components/responses/unsupportedMediaType' '503': $ref: '#/components/responses/serviceUnavailable' /promotions/connections/{promotionConnectionId}/apply: post: operationId: applyPackage tags: - Promotions summary: Apply a package to the instance description: Checks the full package at the configured branch tip. Optionally send expectedSource with the configId, branchName, and full commitSha from the reviewed change preview; status `source-changed` means the branch moved since that review and nothing was imported. Returns status `blocked` before import writes if bindings need setup. Retain configId and git for Continue. Status `applied` includes counts and warnings. Inspect status before reading counts. Existing target variable values, including empty strings, are preserved. Requires a cloned Apply direction on an instance connection. The API key needs the gitConnection:pull scope. The importer checks user write permissions; granular API-key write scopes are not passed to it. x-required-scope: gitConnection:pull x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the promotion connection. name: promotionConnectionId in: path requestBody: content: application/json: schema: type: object properties: expectedSource: type: object properties: configId: type: string minLength: 1 maxLength: 36 branchName: type: string minLength: 1 commitSha: type: string pattern: ^[0-9a-f]{40}([0-9a-f]{24})?$ required: - configId - branchName - commitSha additionalProperties: false additionalProperties: false responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/applyPackageResultDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '503': $ref: '#/components/responses/serviceUnavailable' /promotions/connections/{promotionConnectionId}/apply/continue: post: operationId: continueApplyPackage tags: - Promotions summary: Continue Apply after binding setup description: Rechecks the configured source and current target bindings. Send expectedSource with the configId, branchName, and full commitSha from the reviewed Apply result. Status `source-changed` requires a new Apply review. Status `blocked` returns fresh binding details without import writes. Status `applied` includes counts and warnings. Inspect status before reading counts. Existing target variable values are preserved. Requires the same cloned instance connection and permissions as Apply. The importer checks user write permissions; granular API-key write scopes are not passed to it. No server session or exactly-once guarantee is provided. x-required-scope: gitConnection:pull x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the promotion connection. name: promotionConnectionId in: path requestBody: required: true content: application/json: schema: type: object properties: expectedSource: type: object properties: configId: type: string minLength: 1 maxLength: 36 branchName: type: string minLength: 1 commitSha: type: string pattern: ^[0-9a-f]{40}([0-9a-f]{24})?$ required: - configId - branchName - commitSha additionalProperties: false required: - expectedSource additionalProperties: false responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/applyPackageResultDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '503': $ref: '#/components/responses/serviceUnavailable' /promotions/projects/{projectId}/changes/{direction}: get: operationId: getPromotionChanges tags: - Promotions summary: List the changes of a project in one direction description: Compares a team project on this instance with the branch of its promotion configuration and lists the workflows that differ. For `promote` the rows are what a promotion sends to the branch, and the key needs the gitConnection:push scope. For `apply` the rows are what applying the branch changes on this instance, and the key needs the gitConnection:pull scope. `commitSha` is the commit the rows were read from. Requires the direction to be cloned first. x-required-scope: gitConnection:push,gitConnection:pull x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the project. name: projectId in: path - schema: type: string enum: - apply - promote required: true description: 'The direction of the promotion: apply or promote.' name: direction in: path - schema: type: string required: false name: search in: query - schema: type: string enum: - name - updatedAt - status default: name required: false name: sort in: query - schema: type: string enum: - asc - desc default: asc required: false name: order in: query responses: '200': description: Operation successful. content: application/json: schema: type: object properties: commitSha: type: string nullable: true changes: type: array items: type: object properties: id: type: string minLength: 1 maxLength: 36 name: type: string type: type: string enum: - workflow status: type: string enum: - new - modified - renamed - renamed-and-modified - archived - deleted version: type: integer nullable: true minimum: 0 updatedAt: type: string nullable: true updatedBy: type: string nullable: true dependencyCount: type: integer minimum: 0 required: - id - name - type - status - version - updatedAt - updatedBy - dependencyCount required: - commitSha - changes '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '503': $ref: '#/components/responses/serviceUnavailable' /role-mapping-rules: get: operationId: getRoleMappingRules tags: - RoleMappingRule summary: Retrieve role-mapping rules description: Returns the configured role-mapping rules. `order` is the rule's evaluation position within its own `type`, so instance and project rules each have their own sequence starting at 0 — filter by `type` to retrieve a single evaluation order. x-required-scope: roleMappingRule:list parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - schema: type: string enum: - instance - project required: false name: type in: query x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true responses: '200': description: Operation successful. content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string expression: type: string role: type: string type: type: string enum: - instance - project order: type: integer projectIds: type: array items: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - expression - role - type - order - projectIds - createdAt - updatedAt nextCursor: type: string nullable: true required: - data - nextCursor '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' post: operationId: createRoleMappingRule tags: - RoleMappingRule summary: Create a role-mapping rule description: Creates a rule that maps an identity-provider claim expression to a role. Set `type` to `instance` for a rule granting a global role, or `project` for a rule granting a project role on the projects named in `projectIds`. Omitting `order` appends the rule to the end of the evaluation order for its type. x-required-scope: roleMappingRule:create x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true requestBody: required: true content: application/json: schema: type: object properties: expression: type: string minLength: 1 role: type: string minLength: 1 maxLength: 128 type: type: string enum: - instance - project order: type: integer minimum: 0 projectIds: type: array items: type: string required: - expression - role - type responses: '201': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/roleMappingRulePublicDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '415': $ref: '#/components/responses/unsupportedMediaType' /role-mapping-rules/{roleMappingRuleId}/move: post: operationId: moveRoleMappingRule tags: - RoleMappingRule summary: Move a role-mapping rule description: Changes a rule's position in the evaluation order for its type. `targetIndex` is the desired 0-based position within the rule's own `type` sequence; a value beyond the last position moves the rule to the end. x-required-scope: roleMappingRule:update x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the role mapping rule. name: roleMappingRuleId in: path requestBody: required: true content: application/json: schema: type: object properties: targetIndex: type: integer minimum: 0 required: - targetIndex responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/roleMappingRulePublicDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '415': $ref: '#/components/responses/unsupportedMediaType' /role-mapping-rules/{roleMappingRuleId}: patch: operationId: updateRoleMappingRule tags: - RoleMappingRule summary: Update a role-mapping rule description: Updates a rule's claim expression, role, and/or project assignments. A rule's type cannot be changed once created, so `type` isn't accepted here, and reordering is handled by the move endpoint. x-required-scope: roleMappingRule:update x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the role mapping rule. name: roleMappingRuleId in: path requestBody: content: application/json: schema: type: object properties: expression: type: string minLength: 1 role: type: string minLength: 1 maxLength: 128 projectIds: type: array items: type: string responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/roleMappingRulePublicDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '415': $ref: '#/components/responses/unsupportedMediaType' delete: operationId: deleteRoleMappingRule tags: - RoleMappingRule summary: Delete a role-mapping rule description: Deletes a role-mapping rule. The remaining rules of the same type close the gap, so their `order` values stay a contiguous sequence starting at 0. x-required-scope: roleMappingRule:delete x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the role mapping rule. name: roleMappingRuleId in: path responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/roleMappingRulePublicDto.generated' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' /roles: get: operationId: getAllRoles tags: - Role summary: Retrieve all roles description: Returns all roles grouped by type (global and project). Set `withUsageCount` to include how many users and projects use each role. x-required-scope: role:list x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' required: false name: withUsageCount in: query responses: '200': description: Operation successful. content: application/json: schema: type: object properties: global: type: array items: type: object properties: slug: type: string displayName: type: string description: type: string nullable: true systemRole: type: boolean roleType: type: string enum: - global scopes: type: array items: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time licensed: type: boolean usedByUsers: type: number usedByProjects: type: number required: - slug - displayName - description - systemRole - roleType - scopes - createdAt - updatedAt - licensed project: type: array items: type: object properties: slug: type: string displayName: type: string description: type: string nullable: true systemRole: type: boolean roleType: type: string enum: - project scopes: type: array items: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time licensed: type: boolean usedByUsers: type: number usedByProjects: type: number required: - slug - displayName - description - systemRole - roleType - scopes - createdAt - updatedAt - licensed required: - global - project '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' post: operationId: createRole tags: - Role summary: Create a custom role description: Creates a custom role. Set `roleType` to `global` for an instance-wide role or `project` for a project role. x-required-scope: role:manage,role:manageProject x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true requestBody: required: true content: application/json: schema: type: object properties: displayName: type: string minLength: 2 maxLength: 100 description: type: string maxLength: 500 roleType: type: string enum: - project - global scopes: type: array items: type: string required: - displayName - roleType - scopes responses: '201': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/rolePublicDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' /roles/{roleSlug}: get: operationId: getRole tags: - Role summary: Retrieve a role description: Returns a single role with its scopes. Set `withUsageCount` to include how many users and projects use the role. x-required-scope: role:read x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The slug of the role. name: roleSlug in: path - schema: type: string enum: - 'true' - 'false' default: 'false' required: false name: withUsageCount in: query responses: '200': description: Operation successful. content: application/json: schema: type: object properties: slug: type: string displayName: type: string description: type: string nullable: true systemRole: type: boolean roleType: type: string enum: - project - global scopes: type: array items: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time licensed: type: boolean usedByUsers: type: number usedByProjects: type: number required: - slug - displayName - description - systemRole - roleType - scopes - createdAt - updatedAt - licensed '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' put: operationId: updateRole tags: - Role summary: Update a custom role description: Replaces a custom role's display name, description, and scopes. System roles cannot be updated. x-required-scope: role:manage,role:manageProject x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The slug of the role. name: roleSlug in: path requestBody: required: true content: application/json: schema: type: object properties: displayName: type: string minLength: 2 maxLength: 100 description: type: string nullable: true maxLength: 500 scopes: type: array items: type: string required: - displayName - description - scopes responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/rolePublicDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '415': $ref: '#/components/responses/unsupportedMediaType' delete: operationId: deleteRole tags: - Role summary: Delete a custom role description: Deletes a custom role. System roles cannot be deleted. A role with users assigned cannot be deleted unless `reassignRoleSlug` is set to move those users to another role first. x-required-scope: role:manage,role:manageProject x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The slug of the role. name: roleSlug in: path - schema: anyOf: - type: string enum: - global:admin - global:member - global:chatUser - type: string minLength: 1 required: false name: reassignRoleSlug in: query responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/rolePublicDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' /source-control/status: get: operationId: getSourceControlStatus tags: - SourceControl summary: Preview pending source control changes description: Previews the pending changes between the instance and the connected Git branch in either the `push` or `pull` direction. x-required-scope: sourceControl:read x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string enum: - push - pull required: true name: direction in: query responses: '200': description: Operation successful. content: application/json: schema: type: object properties: data: type: array items: type: object properties: file: type: string id: type: string name: type: string type: type: string enum: - credential - workflow - tags - variables - file - folders - project - datatable status: type: string enum: - new - modified - deleted - created - renamed - conflicted - ignored - staged - unknown location: type: string enum: - local - remote conflict: type: boolean updatedAt: type: string pushed: type: boolean isLocalPublished: type: boolean isRemoteArchived: type: boolean parentFolderId: type: string nullable: true folderPath: type: array items: type: string remoteFolderPath: type: array items: type: string owner: type: object properties: type: type: string enum: - personal - team projectId: type: string projectName: type: string required: - type - projectId - projectName publishingError: type: string publishingErrorDetails: type: object properties: reason: type: string enum: - review_pending - changes_requested - insufficient_api_key_scope - insufficient_permissions workflowReviewRequestId: type: string minLength: 1 versionId: type: string minLength: 1 required: - reason additionalProperties: false contentImportPolicy: type: object properties: violations: type: array items: type: object properties: kind: type: string checkId: type: string message: type: string subject: type: string subjectType: type: string scope: type: string matchedRuleId: type: string required: - kind - checkId - message checkErrors: type: array items: type: object properties: checkId: type: string correlationId: type: string required: - checkId - correlationId required: - violations - checkErrors required: - file - id - name - type - status - location - conflict - updatedAt required: - data '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' /source-control/push: post: operationId: pushSourceControl tags: - SourceControl summary: Push local source control changes description: Commits and pushes the selected files to the connected Git branch. Each entry in `fileNames` is resolved against a fresh preview of the pending changes. x-required-scope: sourceControl:push x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true requestBody: required: true content: application/json: schema: type: object properties: commitMessage: type: string minLength: 1 maxLength: 1000 fileNames: type: array items: type: object properties: id: type: string minLength: 1 type: type: string enum: - credential - workflow - tags - variables - file - folders - project - datatable required: - id - type minItems: 1 force: type: boolean required: - commitMessage - fileNames responses: '200': description: Operation successful. content: application/json: schema: type: object properties: data: type: array items: type: object properties: file: type: string id: type: string name: type: string type: type: string enum: - credential - workflow - tags - variables - file - folders - project - datatable status: type: string enum: - new - modified - deleted - created - renamed - conflicted - ignored - staged - unknown location: type: string enum: - local - remote conflict: type: boolean updatedAt: type: string pushed: type: boolean isLocalPublished: type: boolean isRemoteArchived: type: boolean parentFolderId: type: string nullable: true folderPath: type: array items: type: string remoteFolderPath: type: array items: type: string owner: type: object properties: type: type: string enum: - personal - team projectId: type: string projectName: type: string required: - type - projectId - projectName publishingError: type: string publishingErrorDetails: type: object properties: reason: type: string enum: - review_pending - changes_requested - insufficient_api_key_scope - insufficient_permissions workflowReviewRequestId: type: string minLength: 1 versionId: type: string minLength: 1 required: - reason additionalProperties: false contentImportPolicy: type: object properties: violations: type: array items: type: object properties: kind: type: string checkId: type: string message: type: string subject: type: string subjectType: type: string scope: type: string matchedRuleId: type: string required: - kind - checkId - message checkErrors: type: array items: type: object properties: checkId: type: string correlationId: type: string required: - checkId - correlationId required: - violations - checkErrors required: - file - id - name - type - status - location - conflict - updatedAt required: - data '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': description: 'The push includes files with unresolved conflicts. Retry with `force: true` to push anyway.' content: application/json: schema: type: object properties: message: type: string conflicts: type: array items: type: object properties: file: type: string id: type: string name: type: string type: type: string enum: - credential - workflow - tags - variables - file - folders - project - datatable status: type: string enum: - new - modified - deleted - created - renamed - conflicted - ignored - staged - unknown location: type: string enum: - local - remote conflict: type: boolean updatedAt: type: string pushed: type: boolean isLocalPublished: type: boolean isRemoteArchived: type: boolean parentFolderId: type: string nullable: true folderPath: type: array items: type: string remoteFolderPath: type: array items: type: string owner: type: object properties: type: type: string enum: - personal - team projectId: type: string projectName: type: string required: - type - projectId - projectName publishingError: type: string publishingErrorDetails: type: object properties: reason: type: string enum: - review_pending - changes_requested - insufficient_api_key_scope - insufficient_permissions workflowReviewRequestId: type: string minLength: 1 versionId: type: string minLength: 1 required: - reason additionalProperties: false contentImportPolicy: type: object properties: violations: type: array items: type: object properties: kind: type: string checkId: type: string message: type: string subject: type: string subjectType: type: string scope: type: string matchedRuleId: type: string required: - kind - checkId - message checkErrors: type: array items: type: object properties: checkId: type: string correlationId: type: string required: - checkId - correlationId required: - violations - checkErrors required: - file - id - name - type - status - location - conflict - updatedAt required: - message - conflicts '415': $ref: '#/components/responses/unsupportedMediaType' /source-control/pull: post: operationId: pullSourceControl tags: - SourceControl summary: Pull changes from the remote repository description: Fetches changes from the connected Git branch into the instance. x-required-scope: sourceControl:pull x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true requestBody: required: true content: application/json: schema: type: object properties: force: type: boolean description: Discard local changes and force the pull to complete. autoPublish: type: string enum: - none - all - published default: none description: |- Controls automatic workflow publishing after import: - `none`: Keep workflows in their local published state (default) - `all`: Publish all imported workflows - `published`: Publish only workflows that were published locally before import responses: '200': description: Operation successful. content: application/json: schema: type: array items: type: object properties: file: type: string id: type: string name: type: string type: type: string enum: - credential - workflow - tags - variables - file - folders - project - datatable status: type: string enum: - new - modified - deleted - created - renamed - conflicted - ignored - staged - unknown location: type: string enum: - local - remote conflict: type: boolean updatedAt: type: string pushed: type: boolean isLocalPublished: type: boolean isRemoteArchived: type: boolean parentFolderId: type: string nullable: true folderPath: type: array items: type: string remoteFolderPath: type: array items: type: string owner: type: object properties: type: type: string enum: - personal - team projectId: type: string projectName: type: string required: - type - projectId - projectName publishingError: type: string publishingErrorDetails: type: object properties: reason: type: string enum: - review_pending - changes_requested - insufficient_api_key_scope - insufficient_permissions workflowReviewRequestId: type: string minLength: 1 versionId: type: string minLength: 1 required: - reason additionalProperties: false contentImportPolicy: type: object properties: violations: type: array items: type: object properties: kind: type: string checkId: type: string message: type: string subject: type: string subjectType: type: string scope: type: string matchedRuleId: type: string required: - kind - checkId - message checkErrors: type: array items: type: object properties: checkId: type: string correlationId: type: string required: - checkId - correlationId required: - violations - checkErrors required: - file - id - name - type - status - location - conflict - updatedAt '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': description: 'Conflict due to uncommitted local changes or merge conflicts. The response body lists every file in the pull diff; files causing the conflict have `conflict: true` or `status: modified`. Retry with `force: true` to discard local changes.' content: application/json: schema: type: array items: type: object properties: file: type: string id: type: string name: type: string type: type: string enum: - credential - workflow - tags - variables - file - folders - project - datatable status: type: string enum: - new - modified - deleted - created - renamed - conflicted - ignored - staged - unknown location: type: string enum: - local - remote conflict: type: boolean updatedAt: type: string pushed: type: boolean isLocalPublished: type: boolean isRemoteArchived: type: boolean parentFolderId: type: string nullable: true folderPath: type: array items: type: string remoteFolderPath: type: array items: type: string owner: type: object properties: type: type: string enum: - personal - team projectId: type: string projectName: type: string required: - type - projectId - projectName publishingError: type: string publishingErrorDetails: type: object properties: reason: type: string enum: - review_pending - changes_requested - insufficient_api_key_scope - insufficient_permissions workflowReviewRequestId: type: string minLength: 1 versionId: type: string minLength: 1 required: - reason additionalProperties: false contentImportPolicy: type: object properties: violations: type: array items: type: object properties: kind: type: string checkId: type: string message: type: string subject: type: string subjectType: type: string scope: type: string matchedRuleId: type: string required: - kind - checkId - message checkErrors: type: array items: type: object properties: checkId: type: string correlationId: type: string required: - checkId - correlationId required: - violations - checkErrors required: - file - id - name - type - status - location - conflict - updatedAt '415': $ref: '#/components/responses/unsupportedMediaType' /tags: get: operationId: getTags tags: - Tags summary: Retrieve all tags description: Retrieve all tags from your instance. x-required-scope: tag:list parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true responses: '200': description: Operation successful. content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string readOnly: true example: 2tUt1wbLX592XDdX name: type: string example: Production createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true required: - id - name - createdAt - updatedAt nextCursor: type: string nullable: true required: - data - nextCursor '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' post: operationId: createTag tags: - Tags summary: Create a tag description: Create a tag in your instance. x-required-scope: tag:create x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true requestBody: required: true content: application/json: schema: type: object properties: id: type: string readOnly: true example: 2tUt1wbLX592XDdX name: type: string example: Production createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true required: - name additionalProperties: false responses: '201': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/tagPublicDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' '415': $ref: '#/components/responses/unsupportedMediaType' /tags/{tagId}: get: operationId: getTag tags: - Tags summary: Retrieves a tag description: Retrieves a tag. x-required-scope: tag:read x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the tag. name: tagId in: path responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/tagPublicDto.generated' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' put: operationId: updateTag tags: - Tags summary: Update a tag description: Update a tag. x-required-scope: tag:update x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the tag. name: tagId in: path requestBody: required: true content: application/json: schema: type: object properties: id: type: string readOnly: true example: 2tUt1wbLX592XDdX name: type: string example: Production createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true required: - name additionalProperties: false responses: '200': description: Operation successful. content: application/json: schema: type: object properties: id: type: string readOnly: true example: 2tUt1wbLX592XDdX name: type: string example: Production createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true required: - id - name '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '415': $ref: '#/components/responses/unsupportedMediaType' delete: operationId: deleteTag tags: - Tags summary: Delete a tag description: Deletes a tag. x-required-scope: tag:delete x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the tag. name: tagId in: path responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/tagPublicDto.generated' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' /variables: get: operationId: getVariables tags: - Variables summary: Retrieve variables description: Retrieve variables from your instance. x-required-scope: variable:list parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - schema: type: string example: VmwOO9HeTEj20kxM required: false name: projectId in: query - schema: type: string enum: - empty required: false name: state in: query x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true responses: '200': description: Operation successful. content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string readOnly: true key: type: string value: type: string example: test type: type: string readOnly: true project: type: object nullable: true properties: id: type: string readOnly: true example: VmwOO9HeTEj20kxM name: type: string example: Marketing type: type: string enum: - personal - team readOnly: true example: team icon: type: object description: Icon of the project, or null when the project has none properties: type: type: string enum: - emoji - icon value: type: string color: type: string required: - type - value nullable: true description: type: string nullable: true example: Workflows the marketing team owns. customTelemetryTags: type: array items: type: object properties: key: type: string value: type: string required: - key - value creatorId: type: string nullable: true example: f9a2cbb8-0b1e-4b64-9c1c-0d5f5f1f2a3b createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true required: - id - name - type - icon - description - customTelemetryTags - creatorId - createdAt - updatedAt required: - id - key - value - type - project nextCursor: type: string nullable: true required: - data - nextCursor '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' post: operationId: createVariable tags: - Variables summary: Create a variable description: Create a variable in your instance. x-required-scope: variable:create x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true requestBody: required: true content: application/json: schema: type: object properties: id: type: string readOnly: true key: type: string minLength: 1 maxLength: 50 pattern: ^[A-Za-z_][A-Za-z0-9_]*$ value: type: string maxLength: 1000 example: test type: type: string readOnly: true projectId: type: string maxLength: 36 example: VmwOO9HeTEj20kxM required: - key - value additionalProperties: false responses: '201': description: Operation successful. '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' /variables/{id}: put: operationId: updateVariable tags: - Variables summary: Update a variable description: Update a variable from your instance. x-required-scope: variable:update x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the variable. name: id in: path requestBody: required: true content: application/json: schema: type: object properties: id: type: string readOnly: true key: type: string minLength: 1 maxLength: 50 pattern: ^[A-Za-z0-9_]+$ value: type: string maxLength: 1000 example: test type: type: string readOnly: true projectId: type: string nullable: true maxLength: 36 example: VmwOO9HeTEj20kxM required: - key - value additionalProperties: false 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' '415': $ref: '#/components/responses/unsupportedMediaType' delete: operationId: deleteVariable tags: - Variables summary: Delete a variable description: Delete a variable from your instance. x-required-scope: variable:delete x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the variable. name: id in: path responses: '204': description: Operation successful. '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' /workflows: get: operationId: getWorkflows tags: - Workflow summary: Retrieve all workflows description: Retrieve all workflows from your instance. x-required-scope: workflow:list parameters: - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - schema: type: string enum: - 'true' - 'false' required: false name: active in: query - schema: type: string required: false name: tags in: query - schema: type: string required: false name: name in: query - schema: type: string required: false name: projectId in: query - schema: type: string enum: - 'true' - 'false' default: 'false' required: false name: excludePinnedData in: query x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true responses: '200': description: Operation successful. content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string name: type: string active: type: boolean activeVersionId: type: string nullable: true createdAt: type: string format: date-time updatedAt: type: string format: date-time isArchived: type: boolean versionId: type: string triggerCount: type: number nodes: type: array description: Nodes that make up the workflow items: type: object properties: id: type: string example: 0f5532f9-36ba-4bef-86c7-30d607400b15 name: type: string example: Jira webhookId: type: string disabled: type: boolean notesInFlow: type: boolean notes: type: string type: type: string example: n8n-nodes-base.jira typeVersion: type: number example: 1 executeOnce: type: boolean example: false alwaysOutputData: type: boolean example: false retryOnFail: type: boolean example: false maxTries: type: number waitBetweenTries: type: number continueOnFail: type: boolean example: false description: use onError instead deprecated: true onError: type: string example: stopWorkflow position: type: array items: type: number example: - -100 - 80 parameters: type: object additionalProperties: true credentials: type: object example: jiraSoftwareCloudApi: name: jiraApi customTelemetryTags: type: object properties: tag: type: array items: type: object properties: key: type: string value: type: string required: - key - value createdAt: type: string format: date-time updatedAt: type: string format: date-time connections: type: object description: Connections between nodes, keyed by source node name example: Jira: main: - - node: Jira type: main index: 0 nodeGroups: type: array description: Visual groupings of nodes shown as frames on the canvas items: type: object properties: id: type: string description: Unique identifier for the node group example: 9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d name: type: string description: Display name of the node group example: Data processing description: type: string maxLength: 155 description: Optional plain-text description of the node group example: Cleans and normalizes incoming records nodeIds: type: array description: IDs of the nodes that belong to this group items: type: string required: - id - name - nodeIds settings: type: object description: Execution and behaviour settings for the workflow properties: saveExecutionProgress: oneOf: - type: boolean - type: string enum: - DEFAULT saveManualExecutions: oneOf: - type: boolean - type: string enum: - DEFAULT saveDataErrorExecution: type: string enum: - DEFAULT - all - none saveDataSuccessExecution: type: string enum: - DEFAULT - all - none executionTimeout: type: number example: 3600 errorWorkflow: type: string example: VzqKEW0ShTXA5vPj description: The ID of the workflow that contains the error trigger node. timezone: type: string example: America/New_York executionOrder: type: string example: v1 binaryMode: type: string enum: - separate - combined description: Controls how binary data is resolved from a node's input. This is a derived, internal setting rather than something intended to be set programmatically. It is included in workflow responses for reference, but any value sent when creating or updating a workflow is ignored. callerPolicy: type: string enum: - any - none - workflowsFromAList - workflowsFromSameOwner example: workflowsFromSameOwner description: |- Controls which workflows are allowed to call this workflow using the Execute Workflow node. Defaults to workflowsFromSameOwner. Available options: - `any`: Any workflow can call this workflow (no restrictions) - `none`: No other workflows can call this workflow (completely blocked) - `workflowsFromSameOwner` (default): Only workflows owned by the same project can call this workflow - `workflowsFromAList`: Only the workflows listed in `callerIds` can call this workflow callerIds: type: string example: 14, 18, 23 description: Comma-separated list of workflow IDs allowed to call this workflow (only used with the workflowsFromAList policy) timeSavedMode: type: string enum: - fixed - dynamic description: |- Controls how the time saved per execution is calculated. Available options: - `fixed`: Uses the value in `timeSavedPerExecution`. Use when the time saved is the same for every execution. - `dynamic`: Calculates the time saved from actual execution metrics. `timeSavedPerExecution` is ignored. timeSavedPerExecution: type: number description: Estimated time saved per execution in minutes redactionPolicy: type: string enum: - none - non-manual - manual-only - all example: non-manual description: |- Controls whether execution data is redacted for this workflow. Available options: - `none` (default): No redaction. All execution data is stored. - `non-manual`: Redact production (non-manually triggered) executions only. - `manual-only`: Redact manually triggered executions only. - `all`: Redact all executions, manual and production. availableInMCP: type: boolean example: false description: Controls whether this workflow is reachable over the Model Context Protocol (MCP). Defaults to false. The workflow must be active and must hold at least one active Webhook node. customTelemetryTags: type: array items: type: object properties: key: type: string value: type: string required: - key - value credentialResolverId: type: string description: ID of the credential resolver that resolves credentials for this workflow. This is a derived, internal setting managed through the credential resolver configuration rather than something intended to be set programmatically. It is included in workflow responses for reference, but any value sent when creating or updating a workflow is ignored. nullable: true staticData: type: object description: Data the workflow keeps between executions example: lastId: 1 nullable: true pinData: type: object description: Pinned sample data for nodes, keyed by node name nullable: true meta: type: object description: Workflow metadata such as template information properties: onboardingId: type: string templateId: type: string instanceId: type: string templateCredsSetupCompleted: type: boolean nullable: true tags: type: array items: type: object properties: id: type: string readOnly: true example: 2tUt1wbLX592XDdX name: type: string example: Production createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true required: - id - name - createdAt - updatedAt shared: type: array items: type: object properties: role: type: string workflowId: type: string projectId: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - role - workflowId - projectId - createdAt - updatedAt activeVersion: type: object nullable: true properties: versionId: type: string workflowId: type: string nodes: type: array description: Nodes that make up the workflow items: type: object properties: id: type: string example: 0f5532f9-36ba-4bef-86c7-30d607400b15 name: type: string example: Jira webhookId: type: string disabled: type: boolean notesInFlow: type: boolean notes: type: string type: type: string example: n8n-nodes-base.jira typeVersion: type: number example: 1 executeOnce: type: boolean example: false alwaysOutputData: type: boolean example: false retryOnFail: type: boolean example: false maxTries: type: number waitBetweenTries: type: number continueOnFail: type: boolean example: false description: use onError instead deprecated: true onError: type: string example: stopWorkflow position: type: array items: type: number example: - -100 - 80 parameters: type: object additionalProperties: true credentials: type: object example: jiraSoftwareCloudApi: name: jiraApi customTelemetryTags: type: object properties: tag: type: array items: type: object properties: key: type: string value: type: string required: - key - value createdAt: type: string format: date-time updatedAt: type: string format: date-time connections: type: object description: Connections between nodes, keyed by source node name example: Jira: main: - - node: Jira type: main index: 0 nodeGroups: type: array description: Visual groupings of nodes shown as frames on the canvas items: type: object properties: id: type: string description: Unique identifier for the node group example: 9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d name: type: string description: Display name of the node group example: Data processing description: type: string maxLength: 155 description: Optional plain-text description of the node group example: Cleans and normalizes incoming records nodeIds: type: array description: IDs of the nodes that belong to this group items: type: string required: - id - name - nodeIds authors: type: string name: type: string nullable: true description: type: string nullable: true autosaved: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - versionId - workflowId - nodes - connections - nodeGroups - authors - name - description - autosaved - createdAt - updatedAt required: - id - name - active - activeVersionId - createdAt - updatedAt - isArchived - versionId - triggerCount - nodes - connections - nodeGroups - settings - staticData - meta - shared - activeVersion nextCursor: type: string nullable: true required: - data - nextCursor '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' post: operationId: createWorkflow tags: - Workflow summary: Create a workflow description: Create a workflow in your instance. x-required-scope: workflow:create x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true requestBody: required: true content: application/json: schema: type: object properties: id: type: string readOnly: true example: 2tUt1wbLX592XDdX name: type: string example: Workflow 1 active: type: boolean readOnly: true createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true isArchived: type: boolean readOnly: true versionId: type: string description: Current version identifier used for optimistic locking readOnly: true triggerCount: type: integer description: Number of active trigger nodes in the workflow readOnly: true nodes: type: array items: type: object properties: id: type: string example: 0f5532f9-36ba-4bef-86c7-30d607400b15 name: type: string example: Jira webhookId: type: string disabled: type: boolean notesInFlow: type: boolean notes: type: string type: type: string example: n8n-nodes-base.jira typeVersion: type: number example: 1 executeOnce: type: boolean example: false alwaysOutputData: type: boolean example: false retryOnFail: type: boolean example: false maxTries: type: number waitBetweenTries: type: number continueOnFail: type: boolean description: use onError instead example: false deprecated: true onError: type: string example: stopWorkflow position: type: array items: type: number example: - -100 - 80 parameters: type: object additionalProperties: nullable: true credentials: type: object additionalProperties: nullable: true example: jiraSoftwareCloudApi: name: jiraApi customTelemetryTags: type: object properties: tag: type: array items: type: object properties: key: type: string value: type: string required: - key - value additionalProperties: false additionalProperties: false createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true additionalProperties: false description: Nodes that make up the workflow connections: type: object description: Connections between nodes, keyed by source node name example: Jira: main: - - node: Jira type: main index: 0 settings: type: object properties: saveExecutionProgress: type: boolean saveManualExecutions: type: boolean saveDataErrorExecution: type: string enum: - all - none saveDataSuccessExecution: type: string enum: - all - none executionTimeout: type: number example: 3600 errorWorkflow: type: string description: The ID of the workflow that contains the error trigger node. example: VzqKEW0ShTXA5vPj timezone: type: string example: America/New_York executionOrder: type: string example: v1 binaryMode: type: string enum: - separate - combined description: Controls how binary data is resolved from a node's input. This is a derived, internal setting rather than something intended to be set programmatically. It is included in workflow responses for reference, but any value sent when creating or updating a workflow is ignored. callerPolicy: type: string enum: - any - none - workflowsFromAList - workflowsFromSameOwner description: |- Controls which workflows are allowed to call this workflow using the Execute Workflow node. Defaults to workflowsFromSameOwner. Available options: - `any`: Any workflow can call this workflow (no restrictions) - `none`: No other workflows can call this workflow (completely blocked) - `workflowsFromSameOwner` (default): Only workflows owned by the same project can call this workflow - `workflowsFromAList`: Only the workflows listed in `callerIds` can call this workflow example: workflowsFromSameOwner callerIds: type: string description: Comma-separated list of workflow IDs allowed to call this workflow (only used with the workflowsFromAList policy) example: 14, 18, 23 timeSavedMode: type: string enum: - fixed - dynamic description: |- Controls how the time saved per execution is calculated. Available options: - `fixed`: Uses the value in `timeSavedPerExecution`. Use when the time saved is the same for every execution. - `dynamic`: Calculates the time saved from actual execution metrics. `timeSavedPerExecution` is ignored. timeSavedPerExecution: type: number description: Estimated time saved per execution in minutes redactionPolicy: type: string enum: - none - non-manual - manual-only - all description: |- Controls whether execution data is redacted for this workflow. Available options: - `none` (default): No redaction. All execution data is stored. - `non-manual`: Redact production (non-manually triggered) executions only. - `manual-only`: Redact manually triggered executions only. - `all`: Redact all executions, manual and production. example: non-manual availableInMCP: type: boolean description: Controls whether this workflow is reachable over the Model Context Protocol (MCP). Defaults to false. The workflow must be active and must hold at least one active Webhook node. example: false customTelemetryTags: type: array items: type: object properties: key: type: string value: type: string required: - key - value additionalProperties: false credentialResolverId: type: string description: ID of the credential resolver that resolves credentials for this workflow. This is a derived, internal setting managed through the credential resolver configuration rather than something intended to be set programmatically. It is included in workflow responses for reference, but any value sent when creating or updating a workflow is ignored. additionalProperties: false nodeGroups: type: array items: type: object properties: id: type: string description: Unique identifier for the node group example: 9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d name: type: string description: Display name of the node group example: Data processing description: type: string maxLength: 155 description: Optional plain-text description of the node group example: Cleans and normalizes incoming records nodeIds: type: array items: type: string description: IDs of the nodes that belong to this group required: - id - name - nodeIds additionalProperties: false description: Visual groupings of nodes shown as frames on the canvas staticData: anyOf: - type: string format: jsonString - type: object additionalProperties: nullable: true - nullable: true description: Data the workflow keeps between executions example: lastId: 1 pinData: type: object nullable: true additionalProperties: nullable: true description: Pinned sample data for nodes, keyed by node name projectId: type: string description: Target project to create the workflow in. Defaults to the user's personal project. example: VmwOO9HeTEj20kxM parentFolderId: type: string nullable: true description: ID of the folder to place the workflow in. Omit or null to place at the project root. example: X8ovzm8lTQjcXRZQ meta: type: object description: Workflow metadata such as template information readOnly: true properties: onboardingId: type: string templateId: type: string instanceId: type: string templateCredsSetupCompleted: type: boolean nullable: true tags: type: array readOnly: true items: type: object additionalProperties: false required: - name properties: id: type: string readOnly: true example: 2tUt1wbLX592XDdX name: type: string example: Production createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true shared: type: array items: type: object properties: role: type: string example: workflow:owner workflowId: type: string example: 2tUt1wbLX592XDdX projectId: type: string example: 2tUt1wbLX592XDdX project: type: object properties: id: type: string readOnly: true name: type: string type: type: string readOnly: true createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true additionalProperties: false description: Accepted for compatibility and ignored. The owner share is derived from the target project. activeVersion: type: object readOnly: true nullable: true additionalProperties: false properties: versionId: type: string readOnly: true description: Unique identifier for this workflow version example: 7c6b9e3f-8d4a-4b2c-9f1e-6a5d3b8c7e4f workflowId: type: string readOnly: true description: The workflow this version belongs to example: 2tUt1wbLX592XDdX nodes: type: array description: Nodes that make up the workflow items: type: object properties: id: type: string example: 0f5532f9-36ba-4bef-86c7-30d607400b15 name: type: string example: Jira webhookId: type: string disabled: type: boolean notesInFlow: type: boolean notes: type: string type: type: string example: n8n-nodes-base.jira typeVersion: type: number example: 1 executeOnce: type: boolean example: false alwaysOutputData: type: boolean example: false retryOnFail: type: boolean example: false maxTries: type: number waitBetweenTries: type: number continueOnFail: type: boolean example: false description: use onError instead deprecated: true onError: type: string example: stopWorkflow position: type: array items: type: number example: - -100 - 80 parameters: type: object additionalProperties: true credentials: type: object example: jiraSoftwareCloudApi: name: jiraApi customTelemetryTags: type: object additionalProperties: false properties: tag: type: array items: type: object additionalProperties: false required: - key - value properties: key: type: string value: type: string createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true additionalProperties: false readOnly: true connections: type: object description: Connections between nodes, keyed by source node name example: Jira: main: - - node: Jira type: main index: 0 readOnly: true nodeGroups: type: array description: Visual groupings of nodes shown as frames on the canvas items: type: object properties: id: type: string description: Unique identifier for the node group example: 9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d name: type: string description: Display name of the node group example: Data processing description: type: string maxLength: 155 description: Optional plain-text description of the node group example: Cleans and normalizes incoming records nodeIds: type: array description: IDs of the nodes that belong to this group items: type: string required: - id - name - nodeIds additionalProperties: false readOnly: true authors: type: string readOnly: true description: Comma-separated list of author IDs who contributed to this version example: 1,2,3 name: type: string nullable: true readOnly: true description: Optional name for this workflow version example: Production release description: type: string nullable: true readOnly: true description: Optional description for this workflow version autosaved: type: boolean readOnly: true description: Whether this version was created by autosave createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true required: - name - nodes - connections - settings additionalProperties: false responses: '200': description: Operation successful. content: application/json: schema: type: object properties: id: type: string name: type: string description: type: string nullable: true active: type: boolean activeVersionId: type: string nullable: true createdAt: type: string format: date-time updatedAt: type: string format: date-time isArchived: type: boolean versionId: type: string versionCounter: type: number sourceWorkflowId: type: string nullable: true triggerCount: type: number nodes: type: array description: Nodes that make up the workflow items: type: object properties: id: type: string example: 0f5532f9-36ba-4bef-86c7-30d607400b15 name: type: string example: Jira webhookId: type: string disabled: type: boolean notesInFlow: type: boolean notes: type: string type: type: string example: n8n-nodes-base.jira typeVersion: type: number example: 1 executeOnce: type: boolean example: false alwaysOutputData: type: boolean example: false retryOnFail: type: boolean example: false maxTries: type: number waitBetweenTries: type: number continueOnFail: type: boolean example: false description: use onError instead deprecated: true onError: type: string example: stopWorkflow position: type: array items: type: number example: - -100 - 80 parameters: type: object additionalProperties: true credentials: type: object example: jiraSoftwareCloudApi: name: jiraApi customTelemetryTags: type: object properties: tag: type: array items: type: object properties: key: type: string value: type: string required: - key - value createdAt: type: string format: date-time updatedAt: type: string format: date-time connections: type: object description: Connections between nodes, keyed by source node name example: Jira: main: - - node: Jira type: main index: 0 nodeGroups: type: array description: Visual groupings of nodes shown as frames on the canvas items: type: object properties: id: type: string description: Unique identifier for the node group example: 9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d name: type: string description: Display name of the node group example: Data processing description: type: string maxLength: 155 description: Optional plain-text description of the node group example: Cleans and normalizes incoming records nodeIds: type: array description: IDs of the nodes that belong to this group items: type: string required: - id - name - nodeIds settings: type: object description: Execution and behaviour settings for the workflow properties: saveExecutionProgress: oneOf: - type: boolean - type: string enum: - DEFAULT saveManualExecutions: oneOf: - type: boolean - type: string enum: - DEFAULT saveDataErrorExecution: type: string enum: - DEFAULT - all - none saveDataSuccessExecution: type: string enum: - DEFAULT - all - none executionTimeout: type: number example: 3600 errorWorkflow: type: string example: VzqKEW0ShTXA5vPj description: The ID of the workflow that contains the error trigger node. timezone: type: string example: America/New_York executionOrder: type: string example: v1 binaryMode: type: string enum: - separate - combined description: Controls how binary data is resolved from a node's input. This is a derived, internal setting rather than something intended to be set programmatically. It is included in workflow responses for reference, but any value sent when creating or updating a workflow is ignored. callerPolicy: type: string enum: - any - none - workflowsFromAList - workflowsFromSameOwner example: workflowsFromSameOwner description: |- Controls which workflows are allowed to call this workflow using the Execute Workflow node. Defaults to workflowsFromSameOwner. Available options: - `any`: Any workflow can call this workflow (no restrictions) - `none`: No other workflows can call this workflow (completely blocked) - `workflowsFromSameOwner` (default): Only workflows owned by the same project can call this workflow - `workflowsFromAList`: Only the workflows listed in `callerIds` can call this workflow callerIds: type: string example: 14, 18, 23 description: Comma-separated list of workflow IDs allowed to call this workflow (only used with the workflowsFromAList policy) timeSavedMode: type: string enum: - fixed - dynamic description: |- Controls how the time saved per execution is calculated. Available options: - `fixed`: Uses the value in `timeSavedPerExecution`. Use when the time saved is the same for every execution. - `dynamic`: Calculates the time saved from actual execution metrics. `timeSavedPerExecution` is ignored. timeSavedPerExecution: type: number description: Estimated time saved per execution in minutes redactionPolicy: type: string enum: - none - non-manual - manual-only - all example: non-manual description: |- Controls whether execution data is redacted for this workflow. Available options: - `none` (default): No redaction. All execution data is stored. - `non-manual`: Redact production (non-manually triggered) executions only. - `manual-only`: Redact manually triggered executions only. - `all`: Redact all executions, manual and production. availableInMCP: type: boolean example: false description: Controls whether this workflow is reachable over the Model Context Protocol (MCP). Defaults to false. The workflow must be active and must hold at least one active Webhook node. customTelemetryTags: type: array items: type: object properties: key: type: string value: type: string required: - key - value credentialResolverId: type: string description: ID of the credential resolver that resolves credentials for this workflow. This is a derived, internal setting managed through the credential resolver configuration rather than something intended to be set programmatically. It is included in workflow responses for reference, but any value sent when creating or updating a workflow is ignored. nullable: true staticData: type: object description: Data the workflow keeps between executions example: lastId: 1 nullable: true pinData: type: object description: Pinned sample data for nodes, keyed by node name nullable: true meta: type: object description: Workflow metadata such as template information properties: onboardingId: type: string templateId: type: string instanceId: type: string templateCredsSetupCompleted: type: boolean nullable: true tags: type: array items: type: object properties: id: type: string readOnly: true example: 2tUt1wbLX592XDdX name: type: string example: Production createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true required: - id - name - createdAt - updatedAt shared: type: array items: type: object properties: role: type: string workflowId: type: string projectId: type: string project: type: object properties: id: type: string readOnly: true example: VmwOO9HeTEj20kxM name: type: string example: Marketing type: type: string enum: - personal - team readOnly: true example: team icon: type: object description: Icon of the project, or null when the project has none properties: type: type: string enum: - emoji - icon value: type: string color: type: string required: - type - value nullable: true description: type: string nullable: true example: Workflows the marketing team owns. customTelemetryTags: type: array items: type: object properties: key: type: string value: type: string required: - key - value creatorId: type: string nullable: true example: f9a2cbb8-0b1e-4b64-9c1c-0d5f5f1f2a3b createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true required: - id - name - type - icon - description - customTelemetryTags - creatorId - createdAt - updatedAt createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - role - workflowId - projectId - project - createdAt - updatedAt activeVersion: type: object nullable: true properties: versionId: type: string workflowId: type: string nodes: type: array description: Nodes that make up the workflow items: type: object properties: id: type: string example: 0f5532f9-36ba-4bef-86c7-30d607400b15 name: type: string example: Jira webhookId: type: string disabled: type: boolean notesInFlow: type: boolean notes: type: string type: type: string example: n8n-nodes-base.jira typeVersion: type: number example: 1 executeOnce: type: boolean example: false alwaysOutputData: type: boolean example: false retryOnFail: type: boolean example: false maxTries: type: number waitBetweenTries: type: number continueOnFail: type: boolean example: false description: use onError instead deprecated: true onError: type: string example: stopWorkflow position: type: array items: type: number example: - -100 - 80 parameters: type: object additionalProperties: true credentials: type: object example: jiraSoftwareCloudApi: name: jiraApi customTelemetryTags: type: object properties: tag: type: array items: type: object properties: key: type: string value: type: string required: - key - value createdAt: type: string format: date-time updatedAt: type: string format: date-time connections: type: object description: Connections between nodes, keyed by source node name example: Jira: main: - - node: Jira type: main index: 0 nodeGroups: type: array description: Visual groupings of nodes shown as frames on the canvas items: type: object properties: id: type: string description: Unique identifier for the node group example: 9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d name: type: string description: Display name of the node group example: Data processing description: type: string maxLength: 155 description: Optional plain-text description of the node group example: Cleans and normalizes incoming records nodeIds: type: array description: IDs of the nodes that belong to this group items: type: string required: - id - name - nodeIds authors: type: string name: type: string nullable: true description: type: string nullable: true autosaved: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time workflowPublishHistory: type: array items: type: object properties: id: type: number workflowId: type: string versionId: type: string nullable: true event: type: string enum: - activated - deactivated userId: type: string nullable: true createdAt: type: string format: date-time required: - id - workflowId - versionId - event - userId - createdAt required: - versionId - workflowId - nodes - connections - nodeGroups - authors - name - description - autosaved - createdAt - updatedAt - workflowPublishHistory parentFolder: type: object nullable: true properties: id: type: string name: type: string parentFolderId: type: string nullable: true createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - name - parentFolderId - createdAt - updatedAt description: Folder the workflow was placed in, or null at the project root required: - id - name - description - active - activeVersionId - createdAt - updatedAt - isArchived - versionId - versionCounter - sourceWorkflowId - triggerCount - nodes - connections - nodeGroups - settings - staticData - meta - shared - activeVersion - parentFolder '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' /workflows/{workflowId}: get: operationId: getWorkflow tags: - Workflow summary: Retrieve a workflow description: Retrieve a workflow. x-required-scope: workflow:read x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the workflow. name: workflowId in: path - schema: type: string enum: - 'true' - 'false' default: 'false' required: false name: excludePinnedData in: query responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/workflowPublicDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' put: operationId: updateWorkflow tags: - Workflow summary: Update a workflow description: 'Update a workflow. If the workflow is published, the updated version will be automatically re-published unless `publishIfActive` is set to `false`. Because that re-publication puts a new version live, it additionally requires the `workflow:activate` API key scope and the `workflow:publish` project permission. A caller without either can still save: the new version is stored as a draft and the response is a `403` naming the missing permission, leaving the published version live. Saving an unpublished workflow, or saving with `publishIfActive=false`, only needs `workflow:update`.' x-required-scope: workflow:update x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the workflow. name: workflowId in: path - schema: type: string enum: - 'true' - 'false' default: 'true' description: Whether to publish the update if the workflow is currently published. Set to `false` to save the change as a draft on the existing published version instead of releasing it. Has no effect on a workflow that isn't currently published. required: false name: publishIfActive in: query requestBody: required: true content: application/json: schema: type: object properties: id: type: string readOnly: true example: 2tUt1wbLX592XDdX name: type: string example: Workflow 1 active: type: boolean readOnly: true createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true isArchived: type: boolean readOnly: true versionId: type: string description: Current version identifier used for optimistic locking readOnly: true triggerCount: type: integer description: Number of active trigger nodes in the workflow readOnly: true nodes: type: array items: type: object properties: id: type: string example: 0f5532f9-36ba-4bef-86c7-30d607400b15 name: type: string example: Jira webhookId: type: string disabled: type: boolean notesInFlow: type: boolean notes: type: string type: type: string example: n8n-nodes-base.jira typeVersion: type: number example: 1 executeOnce: type: boolean example: false alwaysOutputData: type: boolean example: false retryOnFail: type: boolean example: false maxTries: type: number waitBetweenTries: type: number continueOnFail: type: boolean description: use onError instead example: false deprecated: true onError: type: string example: stopWorkflow position: type: array items: type: number example: - -100 - 80 parameters: type: object additionalProperties: nullable: true credentials: type: object additionalProperties: nullable: true example: jiraSoftwareCloudApi: name: jiraApi customTelemetryTags: type: object properties: tag: type: array items: type: object properties: key: type: string value: type: string required: - key - value additionalProperties: false additionalProperties: false createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true additionalProperties: false description: Nodes that make up the workflow connections: type: object description: Connections between nodes, keyed by source node name example: Jira: main: - - node: Jira type: main index: 0 settings: type: object properties: saveExecutionProgress: type: boolean saveManualExecutions: type: boolean saveDataErrorExecution: type: string enum: - all - none saveDataSuccessExecution: type: string enum: - all - none executionTimeout: type: number example: 3600 errorWorkflow: type: string description: The ID of the workflow that contains the error trigger node. example: VzqKEW0ShTXA5vPj timezone: type: string example: America/New_York executionOrder: type: string example: v1 binaryMode: type: string enum: - separate - combined description: Controls how binary data is resolved from a node's input. This is a derived, internal setting rather than something intended to be set programmatically. It is included in workflow responses for reference, but any value sent when creating or updating a workflow is ignored. callerPolicy: type: string enum: - any - none - workflowsFromAList - workflowsFromSameOwner description: |- Controls which workflows are allowed to call this workflow using the Execute Workflow node. Defaults to workflowsFromSameOwner. Available options: - `any`: Any workflow can call this workflow (no restrictions) - `none`: No other workflows can call this workflow (completely blocked) - `workflowsFromSameOwner` (default): Only workflows owned by the same project can call this workflow - `workflowsFromAList`: Only the workflows listed in `callerIds` can call this workflow example: workflowsFromSameOwner callerIds: type: string description: Comma-separated list of workflow IDs allowed to call this workflow (only used with the workflowsFromAList policy) example: 14, 18, 23 timeSavedMode: type: string enum: - fixed - dynamic description: |- Controls how the time saved per execution is calculated. Available options: - `fixed`: Uses the value in `timeSavedPerExecution`. Use when the time saved is the same for every execution. - `dynamic`: Calculates the time saved from actual execution metrics. `timeSavedPerExecution` is ignored. timeSavedPerExecution: type: number description: Estimated time saved per execution in minutes redactionPolicy: type: string enum: - none - non-manual - manual-only - all description: |- Controls whether execution data is redacted for this workflow. Available options: - `none` (default): No redaction. All execution data is stored. - `non-manual`: Redact production (non-manually triggered) executions only. - `manual-only`: Redact manually triggered executions only. - `all`: Redact all executions, manual and production. example: non-manual availableInMCP: type: boolean description: Controls whether this workflow is reachable over the Model Context Protocol (MCP). Defaults to false. The workflow must be active and must hold at least one active Webhook node. example: false customTelemetryTags: type: array items: type: object properties: key: type: string value: type: string required: - key - value additionalProperties: false credentialResolverId: type: string description: ID of the credential resolver that resolves credentials for this workflow. This is a derived, internal setting managed through the credential resolver configuration rather than something intended to be set programmatically. It is included in workflow responses for reference, but any value sent when creating or updating a workflow is ignored. additionalProperties: false nodeGroups: type: array items: type: object properties: id: type: string description: Unique identifier for the node group example: 9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d name: type: string description: Display name of the node group example: Data processing description: type: string maxLength: 155 description: Optional plain-text description of the node group example: Cleans and normalizes incoming records nodeIds: type: array items: type: string description: IDs of the nodes that belong to this group required: - id - name - nodeIds additionalProperties: false description: Visual groupings of nodes shown as frames on the canvas staticData: anyOf: - type: string format: jsonString - type: object additionalProperties: nullable: true - nullable: true description: Data the workflow keeps between executions example: lastId: 1 pinData: type: object nullable: true additionalProperties: nullable: true description: Pinned sample data for nodes, keyed by node name parentFolderId: type: string nullable: true description: ID of the folder to move the workflow into. Pass null to move it to the project root; omit to leave its current folder unchanged. writeOnly: true example: X8ovzm8lTQjcXRZQ meta: type: object description: Workflow metadata such as template information readOnly: true properties: onboardingId: type: string templateId: type: string instanceId: type: string templateCredsSetupCompleted: type: boolean nullable: true tags: type: array readOnly: true items: type: object additionalProperties: false required: - name properties: id: type: string readOnly: true example: 2tUt1wbLX592XDdX name: type: string example: Production createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true shared: type: array items: type: object properties: role: type: string example: workflow:owner workflowId: type: string example: 2tUt1wbLX592XDdX projectId: type: string example: 2tUt1wbLX592XDdX project: type: object properties: id: type: string readOnly: true name: type: string type: type: string readOnly: true createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true additionalProperties: false description: Accepted for compatibility and ignored. The owner share is derived from the target project. activeVersion: type: object readOnly: true nullable: true additionalProperties: false properties: versionId: type: string readOnly: true description: Unique identifier for this workflow version example: 7c6b9e3f-8d4a-4b2c-9f1e-6a5d3b8c7e4f workflowId: type: string readOnly: true description: The workflow this version belongs to example: 2tUt1wbLX592XDdX nodes: type: array description: Nodes that make up the workflow items: type: object properties: id: type: string example: 0f5532f9-36ba-4bef-86c7-30d607400b15 name: type: string example: Jira webhookId: type: string disabled: type: boolean notesInFlow: type: boolean notes: type: string type: type: string example: n8n-nodes-base.jira typeVersion: type: number example: 1 executeOnce: type: boolean example: false alwaysOutputData: type: boolean example: false retryOnFail: type: boolean example: false maxTries: type: number waitBetweenTries: type: number continueOnFail: type: boolean example: false description: use onError instead deprecated: true onError: type: string example: stopWorkflow position: type: array items: type: number example: - -100 - 80 parameters: type: object additionalProperties: true credentials: type: object example: jiraSoftwareCloudApi: name: jiraApi customTelemetryTags: type: object additionalProperties: false properties: tag: type: array items: type: object additionalProperties: false required: - key - value properties: key: type: string value: type: string createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true additionalProperties: false readOnly: true connections: type: object description: Connections between nodes, keyed by source node name example: Jira: main: - - node: Jira type: main index: 0 readOnly: true nodeGroups: type: array description: Visual groupings of nodes shown as frames on the canvas items: type: object properties: id: type: string description: Unique identifier for the node group example: 9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d name: type: string description: Display name of the node group example: Data processing description: type: string maxLength: 155 description: Optional plain-text description of the node group example: Cleans and normalizes incoming records nodeIds: type: array description: IDs of the nodes that belong to this group items: type: string required: - id - name - nodeIds additionalProperties: false readOnly: true authors: type: string readOnly: true description: Comma-separated list of author IDs who contributed to this version example: 1,2,3 name: type: string nullable: true readOnly: true description: Optional name for this workflow version example: Production release description: type: string nullable: true readOnly: true description: Optional description for this workflow version autosaved: type: boolean readOnly: true description: Whether this version was created by autosave createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true description: type: string description: Description of the workflow example: My workflow description required: - name - nodes - connections - settings additionalProperties: false responses: '200': description: Operation successful. content: application/json: schema: type: object properties: id: type: string name: type: string description: type: string nullable: true active: type: boolean activeVersionId: type: string nullable: true createdAt: type: string format: date-time updatedAt: type: string format: date-time isArchived: type: boolean versionId: type: string versionCounter: type: number sourceWorkflowId: type: string nullable: true triggerCount: type: number nodes: type: array description: Nodes that make up the workflow items: type: object properties: id: type: string example: 0f5532f9-36ba-4bef-86c7-30d607400b15 name: type: string example: Jira webhookId: type: string disabled: type: boolean notesInFlow: type: boolean notes: type: string type: type: string example: n8n-nodes-base.jira typeVersion: type: number example: 1 executeOnce: type: boolean example: false alwaysOutputData: type: boolean example: false retryOnFail: type: boolean example: false maxTries: type: number waitBetweenTries: type: number continueOnFail: type: boolean example: false description: use onError instead deprecated: true onError: type: string example: stopWorkflow position: type: array items: type: number example: - -100 - 80 parameters: type: object additionalProperties: true credentials: type: object example: jiraSoftwareCloudApi: name: jiraApi customTelemetryTags: type: object properties: tag: type: array items: type: object properties: key: type: string value: type: string required: - key - value createdAt: type: string format: date-time updatedAt: type: string format: date-time connections: type: object description: Connections between nodes, keyed by source node name example: Jira: main: - - node: Jira type: main index: 0 nodeGroups: type: array description: Visual groupings of nodes shown as frames on the canvas items: type: object properties: id: type: string description: Unique identifier for the node group example: 9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d name: type: string description: Display name of the node group example: Data processing description: type: string maxLength: 155 description: Optional plain-text description of the node group example: Cleans and normalizes incoming records nodeIds: type: array description: IDs of the nodes that belong to this group items: type: string required: - id - name - nodeIds settings: type: object description: Execution and behaviour settings for the workflow properties: saveExecutionProgress: oneOf: - type: boolean - type: string enum: - DEFAULT saveManualExecutions: oneOf: - type: boolean - type: string enum: - DEFAULT saveDataErrorExecution: type: string enum: - DEFAULT - all - none saveDataSuccessExecution: type: string enum: - DEFAULT - all - none executionTimeout: type: number example: 3600 errorWorkflow: type: string example: VzqKEW0ShTXA5vPj description: The ID of the workflow that contains the error trigger node. timezone: type: string example: America/New_York executionOrder: type: string example: v1 binaryMode: type: string enum: - separate - combined description: Controls how binary data is resolved from a node's input. This is a derived, internal setting rather than something intended to be set programmatically. It is included in workflow responses for reference, but any value sent when creating or updating a workflow is ignored. callerPolicy: type: string enum: - any - none - workflowsFromAList - workflowsFromSameOwner example: workflowsFromSameOwner description: |- Controls which workflows are allowed to call this workflow using the Execute Workflow node. Defaults to workflowsFromSameOwner. Available options: - `any`: Any workflow can call this workflow (no restrictions) - `none`: No other workflows can call this workflow (completely blocked) - `workflowsFromSameOwner` (default): Only workflows owned by the same project can call this workflow - `workflowsFromAList`: Only the workflows listed in `callerIds` can call this workflow callerIds: type: string example: 14, 18, 23 description: Comma-separated list of workflow IDs allowed to call this workflow (only used with the workflowsFromAList policy) timeSavedMode: type: string enum: - fixed - dynamic description: |- Controls how the time saved per execution is calculated. Available options: - `fixed`: Uses the value in `timeSavedPerExecution`. Use when the time saved is the same for every execution. - `dynamic`: Calculates the time saved from actual execution metrics. `timeSavedPerExecution` is ignored. timeSavedPerExecution: type: number description: Estimated time saved per execution in minutes redactionPolicy: type: string enum: - none - non-manual - manual-only - all example: non-manual description: |- Controls whether execution data is redacted for this workflow. Available options: - `none` (default): No redaction. All execution data is stored. - `non-manual`: Redact production (non-manually triggered) executions only. - `manual-only`: Redact manually triggered executions only. - `all`: Redact all executions, manual and production. availableInMCP: type: boolean example: false description: Controls whether this workflow is reachable over the Model Context Protocol (MCP). Defaults to false. The workflow must be active and must hold at least one active Webhook node. customTelemetryTags: type: array items: type: object properties: key: type: string value: type: string required: - key - value credentialResolverId: type: string description: ID of the credential resolver that resolves credentials for this workflow. This is a derived, internal setting managed through the credential resolver configuration rather than something intended to be set programmatically. It is included in workflow responses for reference, but any value sent when creating or updating a workflow is ignored. nullable: true staticData: type: object description: Data the workflow keeps between executions example: lastId: 1 nullable: true pinData: type: object description: Pinned sample data for nodes, keyed by node name nullable: true meta: type: object description: Workflow metadata such as template information properties: onboardingId: type: string templateId: type: string instanceId: type: string templateCredsSetupCompleted: type: boolean nullable: true tags: type: array items: type: object properties: id: type: string readOnly: true example: 2tUt1wbLX592XDdX name: type: string example: Production createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true required: - id - name - createdAt - updatedAt activeVersion: type: object nullable: true properties: versionId: type: string workflowId: type: string nodes: type: array description: Nodes that make up the workflow items: type: object properties: id: type: string example: 0f5532f9-36ba-4bef-86c7-30d607400b15 name: type: string example: Jira webhookId: type: string disabled: type: boolean notesInFlow: type: boolean notes: type: string type: type: string example: n8n-nodes-base.jira typeVersion: type: number example: 1 executeOnce: type: boolean example: false alwaysOutputData: type: boolean example: false retryOnFail: type: boolean example: false maxTries: type: number waitBetweenTries: type: number continueOnFail: type: boolean example: false description: use onError instead deprecated: true onError: type: string example: stopWorkflow position: type: array items: type: number example: - -100 - 80 parameters: type: object additionalProperties: true credentials: type: object example: jiraSoftwareCloudApi: name: jiraApi customTelemetryTags: type: object properties: tag: type: array items: type: object properties: key: type: string value: type: string required: - key - value createdAt: type: string format: date-time updatedAt: type: string format: date-time connections: type: object description: Connections between nodes, keyed by source node name example: Jira: main: - - node: Jira type: main index: 0 nodeGroups: type: array description: Visual groupings of nodes shown as frames on the canvas items: type: object properties: id: type: string description: Unique identifier for the node group example: 9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d name: type: string description: Display name of the node group example: Data processing description: type: string maxLength: 155 description: Optional plain-text description of the node group example: Cleans and normalizes incoming records nodeIds: type: array description: IDs of the nodes that belong to this group items: type: string required: - id - name - nodeIds authors: type: string name: type: string nullable: true description: type: string nullable: true autosaved: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time workflowPublishHistory: type: array items: type: object properties: id: type: number workflowId: type: string versionId: type: string nullable: true event: type: string enum: - activated - deactivated userId: type: string nullable: true createdAt: type: string format: date-time required: - id - workflowId - versionId - event - userId - createdAt required: - versionId - workflowId - nodes - connections - nodeGroups - authors - name - description - autosaved - createdAt - updatedAt required: - id - name - description - active - activeVersionId - createdAt - updatedAt - isArchived - versionId - versionCounter - sourceWorkflowId - triggerCount - nodes - connections - nodeGroups - settings - staticData - meta - activeVersion '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': description: The update would re-publish the workflow, but the API key lacks `workflow:activate` or the caller lacks `workflow:publish` on the project. The update is still saved as a draft, named by `versionId`, and the published version stays live. content: application/json: schema: type: object properties: message: type: string reason: type: string enum: - insufficient_api_key_scope - insufficient_permissions versionId: type: string required: - message '404': $ref: '#/components/responses/notFound' '409': description: Conflict, e.g. re-publication blocked by an open workflow review (then `reason` and `workflowReviewRequestId` are present; the update itself is still saved as a draft) or a webhook path conflict. content: application/json: schema: type: object properties: message: type: string reason: type: string enum: - review_pending - changes_requested workflowReviewRequestId: type: string required: - message '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' delete: operationId: deleteWorkflow tags: - Workflow summary: Delete a workflow description: Delete a workflow. x-required-scope: workflow:delete x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the workflow. name: workflowId in: path responses: '200': description: Operation successful. content: application/json: schema: type: object properties: id: type: string name: type: string description: type: string nullable: true active: type: boolean activeVersionId: type: string nullable: true createdAt: type: string format: date-time updatedAt: type: string format: date-time isArchived: type: boolean versionId: type: string versionCounter: type: number sourceWorkflowId: type: string nullable: true triggerCount: type: number nodes: type: array description: Nodes that make up the workflow items: type: object properties: id: type: string example: 0f5532f9-36ba-4bef-86c7-30d607400b15 name: type: string example: Jira webhookId: type: string disabled: type: boolean notesInFlow: type: boolean notes: type: string type: type: string example: n8n-nodes-base.jira typeVersion: type: number example: 1 executeOnce: type: boolean example: false alwaysOutputData: type: boolean example: false retryOnFail: type: boolean example: false maxTries: type: number waitBetweenTries: type: number continueOnFail: type: boolean example: false description: use onError instead deprecated: true onError: type: string example: stopWorkflow position: type: array items: type: number example: - -100 - 80 parameters: type: object additionalProperties: true credentials: type: object example: jiraSoftwareCloudApi: name: jiraApi customTelemetryTags: type: object properties: tag: type: array items: type: object properties: key: type: string value: type: string required: - key - value createdAt: type: string format: date-time updatedAt: type: string format: date-time connections: type: object description: Connections between nodes, keyed by source node name example: Jira: main: - - node: Jira type: main index: 0 nodeGroups: type: array description: Visual groupings of nodes shown as frames on the canvas items: type: object properties: id: type: string description: Unique identifier for the node group example: 9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d name: type: string description: Display name of the node group example: Data processing description: type: string maxLength: 155 description: Optional plain-text description of the node group example: Cleans and normalizes incoming records nodeIds: type: array description: IDs of the nodes that belong to this group items: type: string required: - id - name - nodeIds settings: type: object description: Execution and behaviour settings for the workflow properties: saveExecutionProgress: oneOf: - type: boolean - type: string enum: - DEFAULT saveManualExecutions: oneOf: - type: boolean - type: string enum: - DEFAULT saveDataErrorExecution: type: string enum: - DEFAULT - all - none saveDataSuccessExecution: type: string enum: - DEFAULT - all - none executionTimeout: type: number example: 3600 errorWorkflow: type: string example: VzqKEW0ShTXA5vPj description: The ID of the workflow that contains the error trigger node. timezone: type: string example: America/New_York executionOrder: type: string example: v1 binaryMode: type: string enum: - separate - combined description: Controls how binary data is resolved from a node's input. This is a derived, internal setting rather than something intended to be set programmatically. It is included in workflow responses for reference, but any value sent when creating or updating a workflow is ignored. callerPolicy: type: string enum: - any - none - workflowsFromAList - workflowsFromSameOwner example: workflowsFromSameOwner description: |- Controls which workflows are allowed to call this workflow using the Execute Workflow node. Defaults to workflowsFromSameOwner. Available options: - `any`: Any workflow can call this workflow (no restrictions) - `none`: No other workflows can call this workflow (completely blocked) - `workflowsFromSameOwner` (default): Only workflows owned by the same project can call this workflow - `workflowsFromAList`: Only the workflows listed in `callerIds` can call this workflow callerIds: type: string example: 14, 18, 23 description: Comma-separated list of workflow IDs allowed to call this workflow (only used with the workflowsFromAList policy) timeSavedMode: type: string enum: - fixed - dynamic description: |- Controls how the time saved per execution is calculated. Available options: - `fixed`: Uses the value in `timeSavedPerExecution`. Use when the time saved is the same for every execution. - `dynamic`: Calculates the time saved from actual execution metrics. `timeSavedPerExecution` is ignored. timeSavedPerExecution: type: number description: Estimated time saved per execution in minutes redactionPolicy: type: string enum: - none - non-manual - manual-only - all example: non-manual description: |- Controls whether execution data is redacted for this workflow. Available options: - `none` (default): No redaction. All execution data is stored. - `non-manual`: Redact production (non-manually triggered) executions only. - `manual-only`: Redact manually triggered executions only. - `all`: Redact all executions, manual and production. availableInMCP: type: boolean example: false description: Controls whether this workflow is reachable over the Model Context Protocol (MCP). Defaults to false. The workflow must be active and must hold at least one active Webhook node. customTelemetryTags: type: array items: type: object properties: key: type: string value: type: string required: - key - value credentialResolverId: type: string description: ID of the credential resolver that resolves credentials for this workflow. This is a derived, internal setting managed through the credential resolver configuration rather than something intended to be set programmatically. It is included in workflow responses for reference, but any value sent when creating or updating a workflow is ignored. nullable: true staticData: type: object description: Data the workflow keeps between executions example: lastId: 1 nullable: true pinData: type: object description: Pinned sample data for nodes, keyed by node name nullable: true meta: type: object description: Workflow metadata such as template information properties: onboardingId: type: string templateId: type: string instanceId: type: string templateCredsSetupCompleted: type: boolean nullable: true tags: type: array items: type: object properties: id: type: string readOnly: true example: 2tUt1wbLX592XDdX name: type: string example: Production createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true required: - id - name - createdAt - updatedAt shared: type: array items: type: object properties: role: type: string workflowId: type: string projectId: type: string project: type: object properties: id: type: string readOnly: true example: VmwOO9HeTEj20kxM name: type: string example: Marketing type: type: string enum: - personal - team readOnly: true example: team icon: type: object description: Icon of the project, or null when the project has none properties: type: type: string enum: - emoji - icon value: type: string color: type: string required: - type - value nullable: true description: type: string nullable: true example: Workflows the marketing team owns. customTelemetryTags: type: array items: type: object properties: key: type: string value: type: string required: - key - value creatorId: type: string nullable: true example: f9a2cbb8-0b1e-4b64-9c1c-0d5f5f1f2a3b createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true required: - id - name - type - icon - description - customTelemetryTags - creatorId - createdAt - updatedAt createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - role - workflowId - projectId - project - createdAt - updatedAt activeVersion: type: object nullable: true properties: versionId: type: string workflowId: type: string nodes: type: array description: Nodes that make up the workflow items: type: object properties: id: type: string example: 0f5532f9-36ba-4bef-86c7-30d607400b15 name: type: string example: Jira webhookId: type: string disabled: type: boolean notesInFlow: type: boolean notes: type: string type: type: string example: n8n-nodes-base.jira typeVersion: type: number example: 1 executeOnce: type: boolean example: false alwaysOutputData: type: boolean example: false retryOnFail: type: boolean example: false maxTries: type: number waitBetweenTries: type: number continueOnFail: type: boolean example: false description: use onError instead deprecated: true onError: type: string example: stopWorkflow position: type: array items: type: number example: - -100 - 80 parameters: type: object additionalProperties: true credentials: type: object example: jiraSoftwareCloudApi: name: jiraApi customTelemetryTags: type: object properties: tag: type: array items: type: object properties: key: type: string value: type: string required: - key - value createdAt: type: string format: date-time updatedAt: type: string format: date-time connections: type: object description: Connections between nodes, keyed by source node name example: Jira: main: - - node: Jira type: main index: 0 nodeGroups: type: array description: Visual groupings of nodes shown as frames on the canvas items: type: object properties: id: type: string description: Unique identifier for the node group example: 9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d name: type: string description: Display name of the node group example: Data processing description: type: string maxLength: 155 description: Optional plain-text description of the node group example: Cleans and normalizes incoming records nodeIds: type: array description: IDs of the nodes that belong to this group items: type: string required: - id - name - nodeIds authors: type: string name: type: string nullable: true description: type: string nullable: true autosaved: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time workflowPublishHistory: type: array items: type: object properties: id: type: number workflowId: type: string versionId: type: string nullable: true event: type: string enum: - activated - deactivated userId: type: string nullable: true createdAt: type: string format: date-time required: - id - workflowId - versionId - event - userId - createdAt required: - versionId - workflowId - nodes - connections - nodeGroups - authors - name - description - autosaved - createdAt - updatedAt - workflowPublishHistory required: - id - name - description - active - activeVersionId - createdAt - updatedAt - isArchived - versionId - versionCounter - sourceWorkflowId - triggerCount - nodes - connections - nodeGroups - settings - staticData - meta - shared '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' /workflows/{workflowId}/archive: post: operationId: archiveWorkflow 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.' x-required-scope: workflow:delete x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the workflow. name: workflowId in: path responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/workflowPublicDto.generated' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' /workflows/{workflowId}/unarchive: post: operationId: unarchiveWorkflow tags: - Workflow summary: Unarchive a workflow description: Restores an archived workflow. x-required-scope: workflow:delete x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the workflow. name: workflowId in: path responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/workflowPublicDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' /workflows/{workflowId}/transfer: put: operationId: transferWorkflow tags: - Workflow summary: Transfer a workflow to another project description: Transfer a workflow to another project. x-required-scope: workflow:move x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the workflow. name: workflowId in: path requestBody: required: true content: application/json: schema: type: object properties: destinationProjectId: type: string required: - destinationProjectId 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' '415': $ref: '#/components/responses/unsupportedMediaType' /workflows/{workflowId}/publish: post: operationId: publishWorkflow tags: - Workflow summary: Publish a workflow description: Publish a workflow. In n8n v1, this action was termed activating a workflow. x-required-scope: workflow:activate x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the workflow. name: workflowId in: path requestBody: content: application/json: schema: type: object properties: versionId: type: string description: The specific version ID to publish. If not provided, the latest version is used. name: type: string description: Optional name for the workflow version during publication. description: type: string description: Optional description for the workflow version during publication. responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/workflowPublishPublicDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': description: Conflict, e.g. publication blocked by an open workflow review (then `reason` and `workflowReviewRequestId` are present) or a webhook path conflict. content: application/json: schema: type: object properties: message: type: string reason: type: string enum: - review_pending - changes_requested workflowReviewRequestId: type: string required: - message '415': $ref: '#/components/responses/unsupportedMediaType' /workflows/{workflowId}/unpublish: post: operationId: unpublishWorkflow tags: - Workflow summary: Unpublish a workflow description: Unpublish a workflow. In n8n v1, this action was termed deactivating a workflow. x-required-scope: workflow:deactivate x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the workflow. name: workflowId in: path responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/workflowPublicDto.generated' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' /workflows/{workflowId}/activate: post: operationId: activateWorkflow tags: - Workflow summary: Publish a workflow description: 'Deprecated: use POST /workflows/{id}/publish instead. Publish a workflow. In n8n v1, this action was termed activating a workflow.' x-required-scope: workflow:activate deprecated: true x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the workflow. name: workflowId in: path requestBody: 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. responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/workflowPublishPublicDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': description: Conflict, e.g. publication blocked by an open workflow review (then `reason` and `workflowReviewRequestId` are present) or a webhook path conflict. content: application/json: schema: type: object properties: message: type: string reason: type: string enum: - review_pending - changes_requested workflowReviewRequestId: type: string required: - message '415': $ref: '#/components/responses/unsupportedMediaType' /workflows/{workflowId}/deactivate: post: operationId: deactivateWorkflow tags: - Workflow summary: Deactivate a workflow description: 'Deprecated: use POST /workflows/{id}/unpublish instead. Deactivate a workflow.' x-required-scope: workflow:deactivate deprecated: true x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the workflow. name: workflowId in: path responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/workflowPublicDto.generated' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' /workflows/{workflowId}/history: get: operationId: getWorkflowHistory tags: - Workflow summary: Retrieve workflow version history description: Returns a paginated list of workflow versions (version IDs and metadata) for a workflow. x-required-scope: workflow:read parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - schema: type: string required: true description: The ID of the workflow. name: workflowId in: path x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true responses: '200': description: Operation successful. content: application/json: schema: type: object properties: data: type: array items: type: object properties: versionId: type: string workflowId: type: string authors: type: string name: type: string nullable: true description: type: string nullable: true createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - versionId - workflowId - authors - name - description - createdAt - updatedAt nextCursor: type: string nullable: true required: - data - nextCursor '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' /workflows/{workflowId}/versions/{workflowVersionId}: get: operationId: getWorkflowVersion tags: - Workflow summary: Retrieve a workflow version description: Retrieve a single version of a workflow from its version history. x-required-scope: workflow:read x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the workflow. name: workflowId in: path - schema: type: string required: true description: The ID of the workflow version. name: workflowVersionId in: path responses: '200': description: Operation successful. content: application/json: schema: type: object properties: versionId: type: string workflowId: type: string nodes: type: array description: Nodes that make up the workflow items: type: object properties: id: type: string example: 0f5532f9-36ba-4bef-86c7-30d607400b15 name: type: string example: Jira webhookId: type: string disabled: type: boolean notesInFlow: type: boolean notes: type: string type: type: string example: n8n-nodes-base.jira typeVersion: type: number example: 1 executeOnce: type: boolean example: false alwaysOutputData: type: boolean example: false retryOnFail: type: boolean example: false maxTries: type: number waitBetweenTries: type: number continueOnFail: type: boolean example: false description: use onError instead deprecated: true onError: type: string example: stopWorkflow position: type: array items: type: number example: - -100 - 80 parameters: type: object additionalProperties: true credentials: type: object example: jiraSoftwareCloudApi: name: jiraApi customTelemetryTags: type: object properties: tag: type: array items: type: object properties: key: type: string value: type: string required: - key - value createdAt: type: string format: date-time updatedAt: type: string format: date-time connections: type: object description: Connections between nodes, keyed by source node name example: Jira: main: - - node: Jira type: main index: 0 nodeGroups: type: array description: Visual groupings of nodes shown as frames on the canvas items: type: object properties: id: type: string description: Unique identifier for the node group example: 9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d name: type: string description: Display name of the node group example: Data processing description: type: string maxLength: 155 description: Optional plain-text description of the node group example: Cleans and normalizes incoming records nodeIds: type: array description: IDs of the nodes that belong to this group items: type: string required: - id - name - nodeIds authors: type: string name: type: string nullable: true description: type: string nullable: true createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - versionId - workflowId - nodes - connections - nodeGroups - authors - name - description - createdAt - updatedAt '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' /workflows/{workflowId}/tags: get: operationId: getWorkflowTags tags: - Workflow summary: Get workflow tags description: Get workflow tags. x-required-scope: workflowTags:list x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the workflow. name: workflowId in: path responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/workflowTagsPublicDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' put: operationId: updateWorkflowTags tags: - Workflow summary: Update tags of a workflow description: Update tags of a workflow. x-required-scope: workflowTags:update x-eov-operation-id: unreachable x-eov-operation-handler: v1/handlers/decorator-routed.handler x-decorator-routed: true parameters: - schema: type: string required: true description: The ID of the workflow. name: workflowId in: path requestBody: required: true content: application/json: schema: type: array items: type: object properties: id: type: string example: 2tUt1wbLX592XDdX required: - id additionalProperties: false responses: '200': description: Operation successful. content: application/json: schema: $ref: '#/components/schemas/workflowTagsPublicDto.generated' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '415': $ref: '#/components/responses/unsupportedMediaType' components: schemas: audit: type: object properties: Credentials Risk Report: type: object example: risk: credentials sections: - title: Credentials not used in any workflow description: These credentials are not used in any workflow. Keeping unused credentials in your instance is an unneeded security risk. recommendation: Consider deleting these credentials if you no longer need them. location: - kind: credential id: '1' name: My Test Account Database Risk Report: type: object example: risk: database sections: - title: Expressions in "Execute Query" fields in SQL nodes description: This SQL node has an expression in the "Query" field of an "Execute Query" operation. Building a SQL query with an expression may lead to a SQL injection attack. recommendation: Consider using the "Query Parameters" field to pass parameters to the query or validating the input of the expression in the "Query" field.: null location: - kind: node workflowId: '1' workflowName: My Workflow nodeId: 51eb5852-ce0b-4806-b4ff-e41322a4041a nodeName: MySQL nodeType: n8n-nodes-base.mySql Filesystem Risk Report: type: object example: risk: filesystem sections: - title: Nodes that interact with the filesystem description: This node reads from and writes to any accessible file in the host filesystem. Sensitive file content may be manipulated through a node operation. recommendation: Consider protecting any sensitive files in the host filesystem or refactoring the workflow so that it does not require host filesystem interaction.: null location: - kind: node workflowId: '1' workflowName: My Workflow nodeId: 51eb5852-ce0b-4806-b4ff-e41322a4041a nodeName: Ready Binary file nodeType: n8n-nodes-base.readBinaryFile Nodes Risk Report: type: object example: risk: nodes sections: - title: Community nodes description: This node is sourced from the community. Community nodes are not vetted by the n8n team and have full access to the host system. recommendation: Consider reviewing the source code in any community nodes installed in this n8n instance and uninstalling any community nodes no longer used.: null location: - kind: community nodeType: n8n-nodes-test.test packageUrl: https://www.npmjs.com/package/n8n-nodes-test Instance Risk Report: type: object example: risk: execution sections: - title: Unprotected webhooks in instance description: These webhook nodes have the "Authentication" field set to "None" and are not directly connected to a node to validate the payload. Every unprotected webhook allows your workflow to be called by any third party who knows the webhook URL. recommendation: Consider setting the "Authentication" field to an option other than "None" or validating the payload with one of the following nodes.: null location: - kind: community nodeType: n8n-nodes-test.test packageUrl: https://www.npmjs.com/package/n8n-nodes-test ldap-configuration: type: object additionalProperties: false description: | Full LDAP configuration. Every field is returned by GET; send the full object back as PUT body. required: - loginEnabled - loginLabel - connectionUrl - allowUnauthorizedCerts - connectionSecurity - connectionPort - baseDn - bindingAdminDn - bindingAdminPassword - firstNameAttribute - lastNameAttribute - emailAttribute - loginIdAttribute - ldapIdAttribute - userFilter - synchronizationEnabled - synchronizationInterval - searchPageSize - searchTimeout - enforceEmailUniqueness properties: loginEnabled: type: boolean description: Whether LDAP login is enabled. example: false loginLabel: type: string description: Label shown on the LDAP login button. example: LDAP connectionUrl: type: string description: LDAP server URL. example: ldap://ldap.example.com allowUnauthorizedCerts: type: boolean description: Whether to allow unauthorized (self-signed) certificates. example: false connectionSecurity: type: string enum: - none - tls - startTls description: TLS/SSL security mode for the LDAP connection. example: none connectionPort: type: integer description: LDAP server port. example: 389 baseDn: type: string description: Base DN for LDAP search queries. example: dc=example,dc=com bindingAdminDn: type: string description: DN of the LDAP admin user for binding. example: cn=admin,dc=example,dc=com bindingAdminPassword: type: string description: | Password for the LDAP admin user. Redacted on GET; returns the blanking placeholder when a password is stored, empty string when unset. Send the blanking placeholder from a prior GET to keep the stored password unchanged. firstNameAttribute: type: string description: LDAP attribute mapped to the user's first name. example: givenName lastNameAttribute: type: string description: LDAP attribute mapped to the user's last name. example: sn emailAttribute: type: string description: LDAP attribute mapped to the user's email. example: mail loginIdAttribute: type: string description: LDAP attribute used for login (usually the same as emailAttribute). example: mail ldapIdAttribute: type: string description: LDAP attribute that uniquely identifies a user. example: uid userFilter: type: string description: | Additional LDAP filter to apply when searching for users. Use an empty string for no additional filter. example: (objectClass=inetOrgPerson) synchronizationEnabled: type: boolean description: Whether automatic LDAP synchronization is enabled. example: false synchronizationInterval: type: integer description: Interval in minutes between automatic synchronizations. Ignored if synchronizationEnabled is false. example: 60 searchPageSize: type: integer description: Number of LDAP entries to fetch per search page. example: 1000 searchTimeout: type: integer description: LDAP search timeout in seconds. example: 60 enforceEmailUniqueness: type: boolean description: | Whether to enforce that email addresses are unique across LDAP users. When true, if two users have the same email, only the first will be imported. example: true ldap-configuration.update: type: object additionalProperties: false description: Full LDAP configuration. Use empty strings for unset fields. required: - loginEnabled - loginLabel - connectionUrl - allowUnauthorizedCerts - connectionSecurity - connectionPort - baseDn - bindingAdminDn - bindingAdminPassword - firstNameAttribute - lastNameAttribute - emailAttribute - loginIdAttribute - ldapIdAttribute - userFilter - synchronizationEnabled - synchronizationInterval - searchPageSize - searchTimeout - enforceEmailUniqueness properties: loginEnabled: type: boolean description: | Whether LDAP login is enabled. Setting this to false is destructive — it deletes all stored LDAP user identities and disables synchronization. example: false loginLabel: type: string description: Label shown on the LDAP login button. example: LDAP connectionUrl: type: string description: LDAP server URL. example: ldap://ldap.example.com allowUnauthorizedCerts: type: boolean description: Whether to allow unauthorized (self-signed) certificates. example: false connectionSecurity: type: string enum: - none - tls - startTls description: TLS/SSL security mode for the LDAP connection. example: none connectionPort: type: integer description: LDAP server port. example: 389 baseDn: type: string description: Base DN for LDAP search queries. example: dc=example,dc=com bindingAdminDn: type: string description: DN of the LDAP admin user for binding. example: cn=admin,dc=example,dc=com bindingAdminPassword: type: string description: | Password for the LDAP admin user. To keep an existing password unchanged, submit the blanking placeholder from a prior GET response. Use an empty string to clear the password. firstNameAttribute: type: string description: LDAP attribute mapped to the user's first name. example: givenName lastNameAttribute: type: string description: LDAP attribute mapped to the user's last name. example: sn emailAttribute: type: string description: LDAP attribute mapped to the user's email. example: mail loginIdAttribute: type: string description: LDAP attribute used for login (usually the same as emailAttribute). example: mail ldapIdAttribute: type: string description: LDAP attribute that uniquely identifies a user. example: uid userFilter: type: string description: | Additional LDAP filter to apply when searching for users. Use an empty string for no additional filter. example: (objectClass=inetOrgPerson) synchronizationEnabled: type: boolean description: Whether automatic LDAP synchronization is enabled. example: false synchronizationInterval: type: integer description: Interval in minutes between automatic synchronizations. Ignored if synchronizationEnabled is false. example: 60 searchPageSize: type: integer description: Number of LDAP entries to fetch per search page. example: 1000 searchTimeout: type: integer description: LDAP search timeout in seconds. example: 60 enforceEmailUniqueness: type: boolean description: | Whether to enforce that email addresses are unique across LDAP users. When true, if two users have the same email, only the first will be imported. example: true ldap-sync-history: type: object additionalProperties: false description: LDAP synchronization history record. required: - id - runMode - status - startedAt - endedAt - scanned - created - updated - disabled - error properties: id: type: integer description: Unique identifier for this sync run. example: 1 runMode: type: string enum: - dry - live description: Whether the sync was a dry run or applied live. example: live status: type: string description: Status of the synchronization (e.g., success, error). example: success startedAt: type: string format: date-time description: Timestamp when the synchronization started. example: 2025-07-21T10:30:00Z endedAt: type: string format: date-time description: Timestamp when the synchronization completed. example: 2025-07-21T10:35:00Z scanned: type: integer description: Number of LDAP entries scanned during synchronization. example: 42 created: type: integer description: Number of new users created during synchronization. example: 5 updated: type: integer description: Number of existing users updated during synchronization. example: 3 disabled: type: integer description: Number of users disabled during synchronization. example: 0 error: type: string description: Error message if the synchronization failed. Empty string if successful. example: '' ldap-sync-history.list: type: object properties: data: type: array items: $ref: '#/components/schemas/ldap-sync-history' nextCursor: type: string nullable: true description: | Paginate through the synchronization history by setting the cursor parameter to the nextCursor attribute returned by the previous request. A null value means there are no more records. example: MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA ldap-sync.update: type: object additionalProperties: false description: Request body for triggering an LDAP synchronization. required: - type properties: type: type: string enum: - live - dry description: | Type of synchronization. 'live' applies changes to the database, 'dry' performs a test run without persisting changes. example: live security-policy: type: object additionalProperties: false required: - personalSpacePublishing - personalSpaceSharing - publishedPersonalWorkflowsCount - sharedPersonalWorkflowsCount - sharedPersonalCredentialsCount - redactionEnforcement properties: personalSpacePublishing: type: boolean description: Whether members may publish workflows and agents from their personal space. example: true personalSpaceSharing: type: boolean description: Whether members may share workflows and credentials from their personal space. example: true publishedPersonalWorkflowsCount: type: integer readOnly: true description: Number of currently published personal workflows, shown for awareness before tightening the policy. example: 3 sharedPersonalWorkflowsCount: type: integer readOnly: true description: Number of personal workflows currently shared with other users. example: 5 sharedPersonalCredentialsCount: type: integer readOnly: true description: Number of personal credentials currently shared with other users. example: 2 redactionEnforcement: type: object additionalProperties: false required: - floor properties: floor: type: string enum: - off - production - all description: Minimum execution-data redaction level enforced across the instance. example: production security-policy.update: type: object additionalProperties: false description: Full security policy. All writable fields must be provided; partial updates are not supported. required: - personalSpacePublishing - personalSpaceSharing - redactionEnforcement properties: personalSpacePublishing: type: boolean description: Whether members may publish workflows and agents from their personal space. example: false personalSpaceSharing: type: boolean description: Whether members may share workflows and credentials from their personal space. example: false redactionEnforcement: type: object additionalProperties: false required: - floor properties: floor: type: string enum: - off - production - all description: Minimum execution-data redaction level enforced across the instance. example: production publishedPersonalWorkflowsCount: type: integer description: | Read-only usage count returned by GET. Ignored on write so a GET response can be sent back as a PUT body. sharedPersonalWorkflowsCount: type: integer description: | Read-only usage count returned by GET. Ignored on write so a GET response can be sent back as a PUT body. sharedPersonalCredentialsCount: type: integer description: | Read-only usage count returned by GET. Ignored on write so a GET response can be sent back as a PUT body. otel-settings: type: object additionalProperties: false description: | The OpenTelemetry configuration, matching the fields exposed in the UI. On a write this is a full replacement: every field must be provided, except `exporterProtocol`, which defaults to `http/protobuf` when omitted. Fields managed declaratively via environment variables are returned with their effective value and ignored on write. required: - enabled - exporterEndpoint - exporterTracingPath - exporterServiceName - exporterHeaders - tracesSampleRate - startupConnectivityTimeoutMs - includeNodeSpans - injectOutbound - productionExecutionsOnly properties: enabled: type: boolean description: Whether OpenTelemetry tracing is enabled. example: true exporterProtocol: type: string enum: - http/protobuf - grpc default: http/protobuf description: | The wire protocol used to export spans. Collectors conventionally serve OTLP/HTTP on port 4318 and OTLP/gRPC on port 4317. The endpoint scheme (`http://` or `https://`) controls TLS for both protocols. Optional: a write that omits it selects `http/protobuf`, but an instance that sets this field to another value with an environment variable rejects that write with 409. example: http/protobuf exporterEndpoint: type: string format: uri description: | The base URL of the OTLP collector to export traces to. The value must be an `http://` or `https://` URL, because the scheme selects TLS — for gRPC, `https://` uses SSL and `http://` is plaintext. example: http://localhost:4318 exporterTracingPath: type: string description: | The path appended to the endpoint for the OTLP traces signal. Ignored when `exporterProtocol` is `grpc`, which takes no URL path. example: /v1/traces exporterServiceName: type: string minLength: 1 description: The `service.name` resource attribute reported on every span. example: n8n exporterHeaders: type: string description: | Additional headers sent to the OTLP collector, as a single string of comma-separated `key=value` pairs (e.g. `authorization=Bearer my-token,x-tenant-id=acme`). Whitespace around each key and value is trimmed; a value may contain spaces but not commas. Use an empty string when unused. example: authorization=Bearer my-token,x-tenant-id=acme tracesSampleRate: type: number minimum: 0 maximum: 1 description: The ratio of traces to sample, between 0 (none) and 1 (all). example: 1 startupConnectivityTimeoutMs: type: integer minimum: 0 description: | How long, in milliseconds, to wait when checking the collector is reachable. Also used as the timeout for the test-trace endpoint. example: 2000 includeNodeSpans: type: boolean description: Whether to emit a span for each node execution in addition to the workflow span. example: true injectOutbound: type: boolean description: Whether to inject trace context headers into outbound HTTP requests made by nodes. example: true productionExecutionsOnly: type: boolean description: | When true, only production executions of published (active) workflows are traced, not manual/test runs. example: true otel-test-trace: type: object additionalProperties: false description: | The connection details to test against an OTLP collector. Fields managed declaratively via environment variables are overridden with their effective value before the test is sent. required: - exporterEndpoint - exporterTracingPath - exporterServiceName - exporterHeaders - startupConnectivityTimeoutMs properties: exporterProtocol: type: string enum: - http/protobuf - grpc default: http/protobuf description: | The wire protocol used to send the test span. Collectors conventionally serve OTLP/HTTP on port 4318 and OTLP/gRPC on port 4317. The endpoint scheme (`http://` or `https://`) controls TLS for both protocols. Optional: omitting it selects `http/protobuf`, unless an environment variable manages this field, which then supplies the value. example: http/protobuf exporterEndpoint: type: string format: uri description: | The base URL of the OTLP collector to export traces to. The value must be an `http://` or `https://` URL, because the scheme selects TLS — for gRPC, `https://` uses SSL and `http://` is plaintext. example: http://localhost:4318 exporterTracingPath: type: string description: | The path appended to the endpoint for the OTLP traces signal. Ignored when `exporterProtocol` is `grpc`, which takes no URL path. example: /v1/traces exporterServiceName: type: string minLength: 1 description: The `service.name` resource attribute reported on the test span. example: n8n exporterHeaders: type: string description: | Additional headers sent to the OTLP collector, as a single string of comma-separated `key=value` pairs (e.g. `authorization=Bearer my-token,x-tenant-id=acme`). Whitespace around each key and value is trimmed; a value may contain spaces but not commas. Use an empty string when unused. example: authorization=Bearer my-token,x-tenant-id=acme startupConnectivityTimeoutMs: type: integer minimum: 0 description: How long, in milliseconds, to wait for the collector to respond. example: 2000 otel-test-trace-result: type: object additionalProperties: false description: The outcome of the test connection to the OTLP collector. required: - success properties: success: type: boolean description: Whether the test span was accepted by the collector. example: true error: type: string description: | The error reported by the collector or exporter. Present only when `success` is false. example: 'Failed to connect: 401 Unauthorized' oidc-configuration: type: object additionalProperties: false required: - clientId - clientSecret - discoveryEndpoint - loginEnabled - prompt - authenticationContextClassReference - additionalScopes - emailVerifiedRequired - rpInitiatedLogoutEnabled properties: clientId: type: string description: The client ID issued when registering n8n with the OIDC provider. example: n8n-client clientSecret: type: string description: | The client secret issued when registering n8n with the OIDC provider. Redacted on read when set; never echoed back in plaintext. example: '**hidden**' discoveryEndpoint: type: string format: uri description: The OIDC provider's well-known discovery endpoint. example: https://accounts.google.com/.well-known/openid-configuration loginEnabled: type: boolean description: Whether OIDC single sign-on is enabled. example: false prompt: type: string enum: - none - login - consent - select_account - create description: The prompt parameter to use when authenticating with the OIDC provider. example: select_account authenticationContextClassReference: type: array items: type: string description: | ACR values to include in the authorization request (acr_values parameter), in order of preference. example: - mfa - pwd additionalScopes: type: string description: | Additional scopes to request, space separated. n8n always requests `openid`, `profile` and `email`. example: groups roles emailVerifiedRequired: type: boolean description: | Whether the identity provider must assert that the user's email address is verified before the login is accepted. When disabled, only an explicit negative assertion is rejected. example: false rpInitiatedLogoutEnabled: type: boolean description: | Whether signing out of n8n also ends the session at the OIDC provider via RP-Initiated Logout. When disabled, sign-out is local to n8n only. example: false oidc-configuration.update: type: object additionalProperties: false description: | Full OIDC SSO configuration to set. This is a full replacement: every writable field must be provided. Partial updates are rejected. Submit the redacted secret sentinel for `clientSecret` to keep the stored secret unchanged. required: - clientId - clientSecret - discoveryEndpoint - loginEnabled - prompt - authenticationContextClassReference - additionalScopes - emailVerifiedRequired - rpInitiatedLogoutEnabled properties: clientId: type: string minLength: 1 description: The client ID issued when registering n8n with the OIDC provider. example: n8n-client clientSecret: type: string minLength: 1 description: | The client secret issued when registering n8n with the OIDC provider. Submit the redacted sentinel value returned on read to keep the stored secret unchanged. example: my-client-secret discoveryEndpoint: type: string format: uri description: The OIDC provider's well-known discovery endpoint. example: https://accounts.google.com/.well-known/openid-configuration loginEnabled: type: boolean description: Whether OIDC single sign-on is enabled. example: false prompt: type: string enum: - none - login - consent - select_account - create description: The prompt parameter to use when authenticating. example: select_account authenticationContextClassReference: type: array items: type: string description: | ACR values to include in the authorization request (acr_values parameter), in order of preference. Use an empty array when unused. example: - mfa - pwd additionalScopes: type: string description: | Additional scopes to request, space separated. n8n always requests `openid`, `profile` and `email`. Use an empty string when unused. example: groups roles emailVerifiedRequired: type: boolean description: | Whether the identity provider must assert that the user's email address is verified before the login is accepted. When disabled, only an explicit negative assertion is rejected. example: false rpInitiatedLogoutEnabled: type: boolean description: | Whether signing out of n8n also ends the session at the OIDC provider via RP-Initiated Logout. When disabled, sign-out is local to n8n only. example: false saml-configuration: type: object additionalProperties: false required: - entityID - returnUrl - mapping - metadata - metadataUrl - ignoreSSL - loginBinding - loginEnabled - loginLabel - authnRequestsSigned - wantAssertionsSigned - wantMessageSigned - emailVerifiedRequired - signingPrivateKey - signingCertificate - acsBinding - signatureConfig - relayState properties: entityID: type: string readOnly: true description: Service provider entity ID (metadata URL). example: https://n8n.example.com/rest/sso/saml/metadata returnUrl: type: string readOnly: true description: Assertion Consumer Service (ACS) return URL. example: https://n8n.example.com/rest/sso/saml/acs mapping: type: object description: Mapping of SAML attributes to n8n user fields. additionalProperties: false required: - email - firstName - lastName - userPrincipalName - emailVerified - n8nInstanceRole - n8nProjectRoles properties: email: type: string description: SAML attribute mapped to the user's email. firstName: type: string description: SAML attribute mapped to the user's first name. lastName: type: string description: SAML attribute mapped to the user's last name. userPrincipalName: type: string description: SAML attribute mapped to the user's principal name. emailVerified: type: string description: | SAML attribute that states whether the identity provider verified the user's email. An empty string when unused. n8nInstanceRole: type: string description: SAML attribute mapped to the n8n instance role. n8nProjectRoles: type: array items: type: string description: SAML attributes mapped to n8n project roles, formatted as `:`. metadata: type: string description: | Identity provider metadata in XML format. Redacted on read when set because it contains IdP certificates; never echoed back in plaintext. Use an empty string when unset. example: '**hidden**' metadataUrl: type: string description: URL to fetch identity provider metadata from. Use an empty string when unset. ignoreSSL: type: boolean description: Whether to ignore SSL certificate errors when fetching metadata from a URL. example: false loginBinding: type: string enum: - redirect - post description: SAML login request binding. example: redirect loginEnabled: type: boolean description: Whether SAML login is enabled. example: false loginLabel: type: string description: Label shown on the SAML login button. example: SAML authnRequestsSigned: type: boolean description: Whether authentication requests are signed. example: false wantAssertionsSigned: type: boolean description: Whether signed assertions are required. example: true wantMessageSigned: type: boolean description: Whether signed SAML messages are required. example: true emailVerifiedRequired: type: boolean description: | Whether the identity provider must assert that the user's email address is verified before a login is linked to an existing user by email. When disabled, only an explicit negative assertion is rejected. example: false signingPrivateKey: type: string description: | PEM-encoded private key for signing SAML AuthnRequests. Redacted on read when set; never echoed back in plaintext. Use an empty string when unset. example: '**hidden**' signingCertificate: type: string description: | PEM-encoded certificate containing the public key matching the signing private key. Redacted on read when set; never echoed back in plaintext. Use an empty string when unset. example: '**hidden**' acsBinding: type: string enum: - redirect - post description: Assertion Consumer Service binding. example: post signatureConfig: type: object description: Configuration for the signature in SAML requests and responses. additionalProperties: false required: - prefix - location properties: prefix: type: string example: ds location: type: object additionalProperties: false required: - reference - action properties: reference: type: string example: /samlp:Response/saml:Issuer action: type: string enum: - before - after - prepend - append example: after relayState: type: string description: Default relay state value for SAML requests. Use an empty string when unset. example: https://n8n.example.com saml-configuration.update: type: object additionalProperties: false description: | Full SAML SSO configuration. Every field must be provided; use empty strings or empty arrays when a value is unset. Partial updates are not supported. required: - mapping - metadata - metadataUrl - ignoreSSL - loginBinding - loginEnabled - loginLabel - authnRequestsSigned - wantAssertionsSigned - wantMessageSigned - emailVerifiedRequired - signingPrivateKey - signingCertificate - acsBinding - signatureConfig - relayState properties: mapping: type: object description: Mapping of SAML attributes to n8n user fields. Use empty strings / empty arrays for unused attributes. additionalProperties: false required: - email - firstName - lastName - userPrincipalName - emailVerified - n8nInstanceRole - n8nProjectRoles properties: email: type: string description: SAML attribute mapped to the user's email. firstName: type: string description: SAML attribute mapped to the user's first name. lastName: type: string description: SAML attribute mapped to the user's last name. userPrincipalName: type: string description: SAML attribute mapped to the user's principal name. emailVerified: type: string description: | SAML attribute that states whether the identity provider verified the user's email. Accepted values are `true` and `false`, case-insensitive. Use an empty string when unused. n8nInstanceRole: type: string description: SAML attribute mapped to the n8n instance role. Use an empty string when unused. n8nProjectRoles: type: array items: type: string description: | SAML attributes mapped to n8n project roles, formatted as `:`. Use an empty array when unused. metadata: type: string description: | Identity provider metadata in XML format. Use an empty string to clear stored metadata (also clears metadataUrl when no URL is provided). Use the redaction placeholder from a prior GET to leave an existing value unchanged. metadataUrl: type: string description: | URL to fetch identity provider metadata from. Use an empty string to clear a stored URL. ignoreSSL: type: boolean description: Whether to ignore SSL certificate errors when fetching metadata from a URL. example: false loginBinding: type: string enum: - redirect - post description: SAML login request binding. example: redirect loginEnabled: type: boolean description: Whether SAML login is enabled. example: false loginLabel: type: string description: Label shown on the SAML login button. example: SAML authnRequestsSigned: type: boolean description: Whether authentication requests are signed. example: false wantAssertionsSigned: type: boolean description: Whether signed assertions are required. example: true wantMessageSigned: type: boolean description: Whether signed SAML messages are required. example: true emailVerifiedRequired: type: boolean description: | Whether the identity provider must assert that the user's email address is verified before a login is linked to an existing user by email. When disabled, only an explicit negative assertion is rejected. example: false signingPrivateKey: type: string description: | PEM-encoded private key for signing SAML AuthnRequests. Use an empty string to clear an existing key, or the redaction placeholder from a prior GET to leave it unchanged. signingCertificate: type: string description: | PEM-encoded certificate containing the public key matching the signing private key. Use an empty string when unused or to clear an existing certificate. acsBinding: type: string enum: - redirect - post description: Assertion Consumer Service binding. example: post signatureConfig: type: object description: Configuration for the signature in SAML requests and responses. additionalProperties: false required: - prefix - location properties: prefix: type: string example: ds location: type: object additionalProperties: false required: - reference - action properties: reference: type: string example: /samlp:Response/saml:Issuer action: type: string enum: - before - after - prepend - append example: after relayState: type: string description: Default relay state value for SAML requests. Use an empty string when unused. example: https://n8n.example.com entityID: type: string description: | Service provider entity ID. Returned by GET for convenience; ignored on write so a GET response can be sent back as a PUT body. example: https://n8n.example.com/rest/sso/saml/metadata returnUrl: type: string description: | Assertion Consumer Service return URL. Returned by GET for convenience; ignored on write so a GET response can be sent back as a PUT body. example: https://n8n.example.com/rest/sso/saml/acs node: type: object additionalProperties: false properties: id: type: string example: 0f5532f9-36ba-4bef-86c7-30d607400b15 name: type: string example: Jira webhookId: type: string disabled: type: boolean notesInFlow: type: boolean notes: type: string type: type: string example: n8n-nodes-base.jira typeVersion: type: number example: 1 executeOnce: type: boolean example: false alwaysOutputData: type: boolean example: false retryOnFail: type: boolean example: false maxTries: type: number waitBetweenTries: type: number continueOnFail: type: boolean example: false description: use onError instead deprecated: true onError: type: string example: stopWorkflow position: type: array items: type: number example: - -100 - 80 parameters: type: object additionalProperties: true example: additionalProperties: {} credentials: type: object example: jiraSoftwareCloudApi: id: '35' name: jiraApi customTelemetryTags: type: object additionalProperties: false properties: tag: type: array items: type: object additionalProperties: false required: - key - value properties: key: type: string value: type: string createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true workflowNodeGroup: type: object additionalProperties: false required: - id - name - nodeIds properties: id: type: string description: Unique identifier for the node group example: 9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d name: type: string description: Display name of the node group example: Data processing description: type: string maxLength: 155 description: Optional plain-text description of the node group example: Cleans and normalizes incoming records nodeIds: type: array description: IDs of the nodes that belong to this group items: type: string workflowVersion: type: object additionalProperties: false required: - versionId - workflowId - nodes - connections - authors properties: versionId: type: string readOnly: true description: The version ID of this workflow snapshot example: abc123-def456 workflowId: type: string readOnly: true description: The workflow ID this version belongs to example: 2tUt1wbLX592XDdX nodes: type: array items: $ref: '#/components/schemas/node' description: Nodes as they were in this version readOnly: true connections: type: object example: Jira: main: - - node: Jira type: main index: 0 description: Connections as they were in this version readOnly: true nodeGroups: type: array readOnly: true description: Node groups as they were in this version items: $ref: '#/components/schemas/workflowNodeGroup' authors: type: string readOnly: true description: Authors who created this version example: John Doe name: type: string nullable: true description: Workflow name at this version example: Workflow 1 description: type: string nullable: true description: Workflow description at this version createdAt: type: string format: date-time readOnly: true description: When this version was created updatedAt: type: string format: date-time readOnly: true description: When this version was last updated testRunSummary: type: object properties: id: type: string example: 9f8e7d6c5b4a3210 status: type: string enum: - new - running - completed - error - cancelled runAt: type: string format: date-time nullable: true completedAt: type: string format: date-time nullable: true metrics: type: object nullable: true additionalProperties: true description: Aggregated metrics collected across the run's test cases. errorCode: type: string nullable: true errorDetails: type: object nullable: true additionalProperties: true finalResult: type: string nullable: true enum: - success - error - warning description: Overall result of the run, derived from its test cases once completed. testCaseCount: type: integer example: 42 createdAt: type: string format: date-time updatedAt: type: string format: date-time testRunList: type: object properties: data: type: array items: $ref: '#/components/schemas/testRunSummary' nextCursor: type: string nullable: true description: Paginate through test runs by setting the cursor parameter to the nextCursor attribute returned by a previous request. Default value fetches the first "page" of the collection. example: MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA testRun: type: object properties: id: type: string example: 9f8e7d6c5b4a3210 status: type: string enum: - new - running - completed - error - cancelled createdAt: type: string format: date-time testRunCancel: type: object properties: id: type: string example: 9f8e7d6c5b4a3210 status: type: string enum: - cancelled testCaseExecution: type: object properties: id: type: string example: 1a2b3c4d5e6f7080 status: type: string enum: - new - running - evaluation_running - success - error - warning - cancelled runAt: type: string format: date-time nullable: true completedAt: type: string format: date-time nullable: true metrics: type: object nullable: true additionalProperties: true description: Metrics produced by this test case. errorCode: type: string nullable: true errorDetails: type: object nullable: true additionalProperties: true inputs: type: object nullable: true additionalProperties: true description: Input data for this test case. outputs: type: object nullable: true additionalProperties: true description: Output data produced by this test case. executionId: type: string nullable: true description: ID of the underlying workflow execution, if still retained. testCaseExecutionList: type: object properties: data: type: array items: $ref: '#/components/schemas/testCaseExecution' nextCursor: type: string nullable: true description: Paginate through test cases by setting the cursor parameter to the nextCursor attribute returned by a previous request. Default value fetches the first "page" of the collection. example: MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA user: required: - email type: object properties: id: type: string readOnly: true example: 123e4567-e89b-12d3-a456-426614174000 email: type: string format: email example: john.doe@company.com firstName: maxLength: 32 type: string description: User's first name readOnly: true example: john lastName: maxLength: 32 type: string description: User's last name readOnly: true example: Doe isPending: type: boolean description: Whether the user finished setting up their account in response to the invitation (true) or not (false). readOnly: true createdAt: type: string description: Time the user was created. format: date-time readOnly: true updatedAt: type: string description: Last time the user was updated. format: date-time readOnly: true role: type: string example: global:owner readOnly: true mfaEnabled: type: boolean description: Whether the user has multi-factor authentication (MFA/2FA) enabled. readOnly: true example: false userList: type: object properties: data: type: array items: $ref: '#/components/schemas/user' nextCursor: type: string description: Paginate through users by setting the cursor parameter to a nextCursor attribute returned by a previous request. Default value fetches the first "page" of the collection. nullable: true example: MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA dataTable: type: object properties: id: type: string description: Unique identifier for the data table name: type: string description: Name of the data table columns: type: array description: Column definitions items: type: object properties: id: type: string description: Column ID name: type: string description: Column name type: type: string enum: - string - number - boolean - date description: Column data type index: type: integer description: Column position projectId: type: string description: ID of the project this table belongs to createdAt: type: string format: date-time description: Timestamp when the table was created updatedAt: type: string format: date-time description: Timestamp when the table was last updated sizeBytes: type: integer description: Physical storage in bytes, including indexes and internal overhead. Not reduced immediately by row deletion, and may be a few seconds stale. required: - id - name - columns - projectId - createdAt - updatedAt - sizeBytes dataTableList: type: object properties: data: type: array items: $ref: '#/components/schemas/dataTable' nextCursor: type: string description: Paginate through data tables by setting the cursor parameter to a nextCursor attribute returned by a previous request. Default value fetches the first "page" of the collection. nullable: true example: MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA createDataTableRequest: type: object properties: name: type: string description: Name of the data table minLength: 1 maxLength: 128 columns: type: array description: Column definitions for the table items: type: object properties: name: type: string description: Column name minLength: 1 type: type: string enum: - string - number - boolean - date - json description: Column data type required: - name - type projectId: type: string description: | ID of the project to create the table in. When omitted, the table is created in the user's personal project. required: - name - columns updateDataTableRequest: type: object properties: name: type: string description: New name for the data table minLength: 1 maxLength: 128 required: - name dataTableRow: type: object properties: id: type: integer description: The row ID (auto-generated) createdAt: type: string format: date-time description: The date and time the row was created updatedAt: type: string format: date-time description: The date and time the row was last updated additionalProperties: true description: A data table row with system columns (id, createdAt, updatedAt) and user-defined columns dataTableRowList: type: object properties: data: type: array items: $ref: '#/components/schemas/dataTableRow' nextCursor: type: string description: Paginate through rows by setting the cursor parameter to a nextCursor attribute returned by a previous request. Default value fetches the first "page" of the collection. nullable: true example: MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA insertRowsRequest: type: object properties: data: type: array items: type: object additionalProperties: true description: Array of rows to insert. Each row is an object with column names as keys. minItems: 1 returnType: type: string enum: - count - id - all default: count description: | - count: Return only the number of rows inserted - id: Return an array of inserted row IDs - all: Return the full row data for all inserted rows required: - data updateRowsRequest: type: object properties: filter: type: object properties: type: type: string enum: - and - or default: and filters: type: array minItems: 1 items: type: object properties: columnName: type: string condition: type: string enum: - eq - neq - like - ilike - gt - gte - lt - lte value: {} required: - columnName - condition - value required: - filters description: Filter conditions to match rows for update data: type: object additionalProperties: true description: Column values to update returnData: type: boolean default: false description: If true, return the updated rows; if false, return true on success dryRun: type: boolean default: false description: If true, preview changes without persisting them required: - filter - data upsertRowRequest: type: object properties: filter: type: object properties: type: type: string enum: - and - or default: and filters: type: array minItems: 1 items: type: object properties: columnName: type: string condition: type: string enum: - eq - neq - like - ilike - gt - gte - lt - lte value: {} required: - columnName - condition - value required: - filters description: Filter conditions to match existing row. If no row matches, a new row is inserted. data: type: object additionalProperties: true description: Column values for the row returnData: type: boolean default: false description: If true, return the upserted row; if false, return true on success dryRun: type: boolean default: false description: If true, preview changes without persisting them required: - filter - data dataTableColumn: type: object properties: id: type: string description: Column ID name: type: string description: Column name dataTableId: type: string description: ID of the data table this column belongs to type: type: string enum: - string - number - boolean - date description: Column data type index: type: integer description: Column position required: - id - name - dataTableId - type - index dataTableColumnName: type: string description: Column name. Must start with a letter; only letters, digits, and underscores after that; maximum 63 characters. minLength: 1 maxLength: 63 pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ createColumnRequest: type: object properties: name: $ref: '#/components/schemas/dataTableColumnName' type: type: string enum: - string - number - boolean - date description: Column data type index: type: integer minimum: 0 description: Column position (optional, appended to end if omitted) required: - name - type updateColumnRequest: type: object properties: name: $ref: '#/components/schemas/dataTableColumnName' index: type: integer minimum: 0 description: New zero-based position for the column additionalProperties: false anyOf: - required: - name - required: - index communityPackage: type: object properties: packageName: type: string description: npm package name installedVersion: type: string description: Currently installed version authorName: type: string description: Package author name authorEmail: type: string description: Package author email installedNodes: type: array description: Nodes included in this package items: type: object properties: name: type: string type: type: string latestVersion: type: number createdAt: type: string format: date-time updatedAt: type: string format: date-time updateAvailable: type: string description: Version available for update, if any failedLoading: type: boolean description: Whether the package failed to load communityPackageList: type: array items: $ref: '#/components/schemas/communityPackage' installCommunityPackageRequest: type: object required: - name properties: name: type: string description: npm package name (must start with n8n-nodes-) version: type: string description: Semver version or npm dist-tag, such as latest or beta. When unverified packages are disabled, only versions verified by n8n can be installed. folder.create: type: object additionalProperties: false required: - name properties: name: type: string example: My Folder parentFolderId: type: string example: abc123 folder: type: object additionalProperties: false properties: id: type: string readOnly: true name: type: string example: My Folder parentFolderId: type: string nullable: true createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true folder.update: type: object additionalProperties: false minProperties: 1 properties: name: type: string example: Renamed Folder parentFolderId: type: string example: abc123 exportPackageRequest: type: object additionalProperties: false description: Selects what to export. Provide `workflowIds` and/or `folderIds` to export loose workflows and folders, or `projectIds` to export whole projects, but not both groups in the same request. At least one id must be supplied. properties: workflowIds: type: array maxItems: 300 description: IDs of the workflows to include in the exported package. items: type: string minLength: 1 example: - 2tUt1wbLX592XDdX folderIds: type: array maxItems: 300 description: IDs of the folders to include in the exported package. Each folder is exported with its nested folders. items: type: string minLength: 1 example: - 9xKp2mNqRzAbCdEf projectIds: type: array description: IDs of the projects to include in the exported package. items: type: string minLength: 1 example: - Ox8O54VQrmBrb4qL includeVariableValues: type: boolean default: true description: Whether values of variables referenced by the exported workflows are bundled into the package. When `false`, variables still travel as name/type files and are listed in the package requirements, but no values travel with the package. includeTags: type: boolean default: true description: Whether tags assigned to the exported workflows are bundled into the package. When `false`, no tag files, tag references, or tag requirements travel with the package. missingWorkflowDependencyPolicy: type: string enum: - fail - reference-only - include-in-package description: Policy for missing static sub-workflow dependencies. `fail` aborts the export when any static sub-workflow is missing from the package; `include-in-package` automatically adds missing static sub-workflows. `reference-only` keeps missing static sub-workflows out of the package and lists them in the package requirements as workflows expected to already exist on the target. example: fail default: fail workflowVersionPolicy: type: string enum: - published-strict - prefer-published - ignore-unpublished - latest description: Which version of each workflow travels in the package. `latest` exports the latest version, published or not. `published-strict` exports the published version and aborts the export if any workflow has none. `prefer-published` falls back to the latest version where there is no published one. `ignore-unpublished` leaves unpublished workflows out of the package entirely. The chosen version decides which credentials, data tables, variables and sub-workflows are bundled alongside it; the workflow's name, settings and tags are not versioned and always come from the latest version. example: latest default: latest credentialExportPolicy: type: string enum: - expression-values-only - no-values description: Whether expression values from credential data are bundled into the package. `expression-values-only` includes credential fields whose value is an n8n expression (for example `={{ $secrets.apiKey }}`); literal values never travel either way. `no-values` keeps credential data out of the package entirely, so each credential file carries only its id, name and type. example: expression-values-only default: expression-values-only includeArchivedWorkflows: type: boolean description: 'Whether folder and project exports include their archived workflows. When `false` (default) they are left out. When `true` they travel with `isArchived: true` and are archived on import. Workflows listed in `workflowIds` always export, also when archived.' example: false default: false policyViolation: type: object description: | One reason a policy check objected. `kind`, `subjectType` and `scope` are open strings, not enums, so later policy features can add values — a reader must cope with values it does not recognise. required: - kind - checkId - message properties: kind: type: string description: e.g. `node-type-unavailable`. Do not assume you know every value. checkId: type: string description: Id of the check that objected. message: type: string description: Readable on its own. Do not parse details out of it — use the fields below. subject: type: string description: 'What was objected to: a node type name, a credential type name, …' subjectType: type: string description: What kind of name `subject` is — node and credential type names can look alike. scope: type: string description: Which level objected. Usually `instance` or `project`, but treat it as open. matchedRuleId: type: string description: The rule that decided, if a rule did rather than a fallback default. importBlockingIssue: oneOf: - type: object description: | A workflow whose source id already matches one in the target project, under the `fail` conflict policy. required: - type - sourceWorkflowId - existingWorkflowId - name properties: type: type: string enum: - workflow-conflict sourceWorkflowId: type: string existingWorkflowId: type: string name: type: string - type: object description: | A package workflow whose source id matches multiple workflows in the target project. The import cannot choose a workflow safely. required: - type - sourceWorkflowId - projectId - existingWorkflows properties: type: type: string enum: - workflow-lineage-conflict sourceWorkflowId: type: string projectId: type: string existingWorkflows: type: array items: type: object required: - id - name - isArchived properties: id: type: string name: type: string isArchived: type: boolean - type: object description: | A `source`-policy workflow whose id is already taken on the instance. Workflow ids are globally unique, so the id cannot be created in the target project. The existing workflow can be in another project, can lack an owner share, or can use a different source id. It can also be archived. required: - type - sourceWorkflowId - existingWorkflowId - existingProjectId - isArchived - name properties: type: type: string enum: - workflow-id-conflict sourceWorkflowId: type: string existingWorkflowId: type: string existingProjectId: type: string nullable: true description: | Project that owns the existing workflow, or null when no owning project could be determined. isArchived: type: boolean description: Whether the existing workflow is archived. name: type: string - type: object description: | A workflow whose source id already matches one in the target project but lives outside the requested import folder. Folder-targeted imports cannot update workflows in place at a different location. required: - type - sourceWorkflowId - existingWorkflowId - existingParentFolderId - targetFolderId - name properties: type: type: string enum: - workflow-folder-conflict sourceWorkflowId: type: string existingWorkflowId: type: string existingParentFolderId: type: string nullable: true description: | Folder that currently contains the matched workflow, or null when it lives at the project root. targetFolderId: type: string description: Folder the import was requested to land in. name: type: string - type: object description: | A project defined by the package that already exists on this instance, under `projectConflictPolicy=fail`. required: - type - kind - sourceProjectId - name properties: type: type: string enum: - project-conflict kind: type: string enum: - fail-policy sourceProjectId: type: string name: type: string description: The project's name as it appears in the package. - type: object description: | A package folder that cannot be imported as-is. `kind` distinguishes the cause: `parent-mismatch` (a folder matched by id sits under a different parent than the package places it), `id-in-other-project` (the folder id already exists in a different project — ids are globally unique), or `fail-policy` (the folder already exists and `folderConflictPolicy` is `fail`). required: - type - kind - sourceFolderId - name properties: type: type: string enum: - folder-conflict kind: type: string enum: - parent-mismatch - id-in-other-project - fail-policy sourceFolderId: type: string name: type: string existingParentFolderId: type: string nullable: true description: "For `parent-mismatch`: the matched folder's current parent in the target." expectedParentFolderId: type: string nullable: true description: 'For `parent-mismatch`: the parent the package would place the folder under.' existingProjectId: type: string nullable: true description: 'For `id-in-other-project`: the project that already owns the id.' - type: object description: | A workflow that `folderConflictPolicy=overwrite` would remove, because the package does not contain it, but the caller lacks `workflow:delete` on. Reported instead of removing a subset, which would leave the project matching neither the package nor its previous state. required: - type - workflowId - name - projectId properties: type: type: string enum: - workflow-removal-forbidden workflowId: type: string name: type: string projectId: type: string description: Project the workflow was being reconciled against. - type: object description: | A matched workflow whose archived state differs from the package, so the import must archive or unarchive it, but the caller lacks `workflow:delete` on it. Reported at plan time so nothing is written. required: - type - sourceWorkflowId - existingWorkflowId - name - projectId - transition properties: type: type: string enum: - workflow-archive-forbidden sourceWorkflowId: type: string existingWorkflowId: type: string name: type: string projectId: type: string description: Project that owns the matched workflow. transition: type: string enum: - archive - unarchive description: The step the import needs to bring the workflow to the package's state. - type: object description: | A folder that `folderConflictPolicy=overwrite` would delete — the package does not define it and reconciliation leaves it empty — but the caller lacks `folder:delete` on the target project. Reported instead of removing a subset, which would leave the project matching neither the package nor its previous state. required: - type - folderId - name - projectId properties: type: type: string enum: - folder-removal-forbidden folderId: type: string name: type: string projectId: type: string description: Project the folder was being reconciled against. - type: object description: | A node type — or a version of a node type — used by a package workflow that this instance does not have, under `missingNodeTypeMode=fail`. One issue is reported per missing `(nodeType, typeVersion)` pair. required: - type - nodeType - typeVersion - usedByWorkflows properties: type: type: string enum: - missing-node-type nodeType: type: string description: Full node type name as used by the package's workflows. typeVersion: type: number description: Node type version the package's workflows use. usedByWorkflows: type: array items: type: string description: Package workflow ids that use this node type and version. - type: object description: A credential reference that could not be resolved in the target project. required: - type - kind - sourceId - usedByWorkflows properties: type: type: string enum: - credential-unresolved kind: type: string enum: - not_found - unknown_type - source_not_found - type_mismatch sourceId: type: string targetId: type: string description: Target credential id for an explicit credential binding. expectedType: type: string description: | For `type_mismatch`: the credential type the package's workflow node requires. actualType: type: string description: | For `type_mismatch`: the actual type of the resolved target credential. usedByWorkflows: type: array items: type: string - type: object description: | A tag referenced by the package's workflows that could not be resolved on the target instance. `kind` distinguishes the cause: `rename-drift` (the same-id target tag carries a different name — under `tagConflictPolicy=fail`, or `rename` when the package name is held by another tag), `name-collision` (the id is free but the name belongs to a different tag under `tagMissingMode=create` with `tagConflictPolicy=fail`; also raised when two package tags collide with each other, or when the target tag a reconcile would re-key is claimed by another package tag), `invalid-name` / `invalid-id` (the package tag's name or id cannot be written on this instance), or `permission-denied` (the importing user lacks the global `tag:create` / `tag:update` scope the plan needs). required: - type - kind - usedByWorkflows properties: type: type: string enum: - tag-unresolved kind: type: string enum: - rename-drift - name-collision - invalid-name - invalid-id - permission-denied sourceId: type: string description: Tag id as it appears in the package. Absent for `permission-denied`. name: type: string description: The (trimmed) package tag name. Absent for `permission-denied`. missingScope: type: string enum: - tag:create - tag:update description: 'For `permission-denied`: the global scope the importing user lacks.' existingTagId: type: string description: | Id of the contested target tag — the different tag currently holding the wanted name, or the target tag a blocked reconcile would re-key. Absent when two package tags collide with each other rather than over a target tag. existingName: type: string description: 'For `rename-drift`: the current name of the same-id target tag.' usedByWorkflows: type: array items: type: string description: | Package workflow ids (non-skipped) that reference the source tag — not workflows attached to the contested target tag. - type: object description: | A variable reference that could not be resolved in the target project or the global scope, under `variableMissingMode=must-preexist`. required: - type - name - usedByWorkflows properties: type: type: string enum: - variable-unresolved name: type: string description: Requirement name with no match in the target project or global scope. usedByWorkflows: type: array items: type: string - type: object description: | A variable that resolved in the target project or the global scope, but whose value differs from the one the package bundles for it, under `variableConflictPolicy=fail`. Also reported under `overwrite`, once per scope, when the projects of a package resolve one row and disagree about the value it should hold. Values are never reported — only the name and the scope the variable was found in. required: - type - name - usedByWorkflows properties: type: type: string enum: - variable-conflict name: type: string description: Name of the variable whose value differs. projectId: type: string description: | Project owning the resolved variable. Absent when it resolved at the global scope. usedByWorkflows: type: array items: type: string - type: object description: | Creating the package's variables under `create-stub` or `create-with-value` would exceed the instance variable quota (`quota:maxVariables`). Reported once for the whole import; nothing is created. required: - type - limit - remaining - requested - names - usedByWorkflows properties: type: type: string enum: - variable-limit-exceeded limit: type: integer description: The instance variable quota. remaining: type: integer description: Variable rows still available under the quota. The import is blocked because `requested` exceeds this, not because it exceeds `limit`. requested: type: integer description: Number of new variable rows the import would create (destination-deduplicated). names: type: array items: type: string description: The unique variable names the import would create. usedByWorkflows: type: array items: type: string description: Package workflow ids that reference any of the listed variables. - type: object description: | A workflow the content-import policy refused. Takes down the whole package rather than skipping the workflow: the import rewrites cross-workflow references to the ids each workflow would get, so dropping one leaves the workflows that call it pointing at a row nothing ever wrote. required: - type - sourceWorkflowId - name - violations properties: type: type: string enum: - policy-violation sourceWorkflowId: type: string description: Workflow id as it appears in the package. name: type: string violations: type: array items: $ref: '#/components/schemas/policyViolation' event-types: type: object additionalProperties: false required: - data properties: data: type: array description: Event names that can be streamed to a destination. items: type: string example: - n8n.workflow.started - n8n.workflow.success - n8n.workflow.failed destination.common: type: object properties: id: type: string readOnly: true description: Server-generated unique id of the destination. Returned in responses; not accepted in requests. example: 88be6560-bfb4-455c-8aa1-06971e9e5522 label: type: string description: Human-readable name shown in the UI. example: My destination enabled: type: boolean description: Whether the destination currently receives events. example: true subscribedEvents: type: array items: type: string description: | Event names (or group prefixes, e.g. `n8n.workflow`, which matches all `n8n.workflow.*` events) this destination receives. Retrieve the full list of streamable event names from `GET /settings/log-streaming/event-types`. example: - n8n.workflow - n8n.audit anonymizeAuditMessages: type: boolean description: Whether audit message payloads are anonymized before being sent. example: false circuitBreaker: type: object additionalProperties: true description: | Circuit-breaker tuning for delivery. After repeated failures the destination stops sending for a cool-down window instead of hammering an unhealthy target. All fields are optional; sensible defaults apply when omitted. properties: maxFailures: type: integer description: Maximum failures within the sliding window before the breaker opens. failureWindow: type: integer description: Sliding window, in milliseconds, over which failures are counted. parameter-list: type: object additionalProperties: true description: Key-value pairs used when the matching `specify*` field is `keypair`. properties: parameters: type: array items: type: object required: - name - value properties: name: type: string example: Authorization value: description: | Parameter value. Usually a string; numbers, booleans and null are also accepted. example: Bearer destination.webhook: allOf: - $ref: '#/components/schemas/destination.common' - type: object additionalProperties: true required: - type - url properties: type: type: string enum: - webhook description: Sends each event as an HTTP request to a URL. example: webhook url: type: string format: uri description: Target URL that receives the event payload. example: https://example.com/n8n-events method: type: string description: HTTP method used for the request. example: POST sendHeaders: type: boolean description: Whether to attach custom headers to the request. example: false specifyHeaders: type: string description: How custom headers are provided — `keypair` or `json`. example: keypair headerParameters: $ref: '#/components/schemas/parameter-list' jsonHeaders: type: string description: Custom headers as a JSON string when `specifyHeaders` is `json`. sendQuery: type: boolean description: Whether to attach query parameters to the request. example: false specifyQuery: type: string description: How query parameters are provided — `keypair` or `json`. queryParameters: $ref: '#/components/schemas/parameter-list' jsonQuery: type: string description: Query parameters as a JSON string when `specifyQuery` is `json`. options: type: object additionalProperties: true description: Additional HTTP request options. properties: timeout: type: integer description: Request timeout in milliseconds. allowUnauthorizedCerts: type: boolean description: Accept self-signed or otherwise invalid TLS certificates. queryParameterArrays: type: string enum: - indices - brackets - repeat description: How array-valued query parameters are serialized into the query string. redirect: type: object additionalProperties: true description: Redirect-following behaviour. properties: redirect: type: object additionalProperties: true properties: followRedirects: type: boolean description: Whether to follow HTTP redirects. maxRedirects: type: integer description: Maximum number of redirects to follow. proxy: type: object additionalProperties: true description: Outbound proxy configuration. properties: proxy: type: object additionalProperties: true properties: protocol: type: string enum: - https - http description: Proxy protocol. host: type: string description: Proxy host, without protocol or port. port: type: integer description: Proxy port. socket: type: object additionalProperties: true description: Connection socket options. properties: keepAlive: type: boolean description: Whether to keep sockets open for reuse. maxSockets: type: integer description: Maximum sockets per host kept open at once. maxFreeSockets: type: integer description: Maximum idle sockets per host kept open. destination.syslog: allOf: - $ref: '#/components/schemas/destination.common' - type: object additionalProperties: true required: - type - host properties: type: type: string enum: - syslog description: Sends each event to a syslog server. example: syslog host: type: string description: Syslog server host. example: syslog.example.com port: type: integer description: Syslog server port. example: 514 protocol: type: string enum: - udp - tcp - tls description: Transport protocol. example: udp facility: type: integer minimum: 0 maximum: 23 description: | Syslog facility code (0–23, per RFC 5424). Common values: 0 Kernel, 1 User, 3 System, 13 Audit, 14 Alert, 16 Local0, 17 Local1, 18 Local2, 19 Local3, 20 Local4, 21 Local5, 22 Local6, 23 Local7. example: 16 app_name: type: string description: Application name reported in the syslog message. example: n8n tlsCa: type: string description: PEM-encoded CA certificate used when `protocol` is `tls`. destination.sentry: allOf: - $ref: '#/components/schemas/destination.common' - type: object additionalProperties: true required: - type - dsn properties: type: type: string enum: - sentry description: Sends each event to a Sentry project. example: sentry dsn: type: string format: uri description: Sentry DSN the events are sent to. example: https://examplePublicKey@o0.ingest.sentry.io/0 destination: type: object oneOf: - $ref: '#/components/schemas/destination.webhook' - $ref: '#/components/schemas/destination.syslog' - $ref: '#/components/schemas/destination.sentry' description: | A log streaming destination. The `type` field selects the variant and its type-specific fields: `webhook`, `syslog`, or `sentry`. destination.list: type: object additionalProperties: false required: - data properties: data: type: array description: The configured log streaming destinations. items: $ref: '#/components/schemas/destination' test-result: type: object additionalProperties: false required: - success properties: success: type: boolean description: Whether the test message was delivered to the destination successfully. example: true error: required: - message type: object properties: code: type: string message: type: string description: type: string role: readOnly: true type: object properties: id: type: number readOnly: true example: 1 name: type: string example: owner readOnly: true scope: type: string readOnly: true example: global createdAt: type: string description: Time the role was created. format: date-time readOnly: true updatedAt: type: string description: Last time the role was updated. format: date-time readOnly: true tag: type: object additionalProperties: false required: - name properties: id: type: string readOnly: true example: 2tUt1wbLX592XDdX name: type: string example: Production createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true workflowSettings: type: object additionalProperties: false properties: saveExecutionProgress: type: boolean saveManualExecutions: type: boolean saveDataErrorExecution: type: string enum: - all - none saveDataSuccessExecution: type: string enum: - all - none executionTimeout: type: number example: 3600 maxLength: 3600 errorWorkflow: type: string example: VzqKEW0ShTXA5vPj description: The ID of the workflow that contains the error trigger node. timezone: type: string example: America/New_York executionOrder: type: string example: v1 binaryMode: type: string enum: - separate - combined description: | Controls how binary data is resolved from a node's input. This is a derived, internal setting rather than something intended to be set programmatically. It is included in workflow responses for reference, but any value sent when creating or updating a workflow is ignored. callerPolicy: type: string enum: - any - none - workflowsFromAList - workflowsFromSameOwner description: | Controls which workflows are allowed to call this workflow using the Execute Workflow node. Defaults to workflowsFromSameOwner. Available options: - `any`: **Deprecated, removed in version 3.** Any workflow can call this workflow. Switch to `workflowsFromAList` or `workflowsFromSameOwner` before upgrading. - `none`: No other workflows can call this workflow (completely blocked) - `workflowsFromSameOwner` (default): Only workflows owned by the same project can call this workflow * For personal projects: Only workflows created by the same user * For team projects: Only workflows within the same team project - `workflowsFromAList`: Only specific workflows listed in the `callerIds` field can call this workflow * Requires the `callerIds` field to specify which workflow IDs are allowed * See `callerIds` field documentation for usage example: workflowsFromSameOwner callerIds: type: string description: Comma-separated list of workflow IDs allowed to call this workflow (only used with workflowsFromAList policy) example: 14, 18, 23 timeSavedMode: type: string enum: - fixed - dynamic description: | Controls how the time saved per execution is calculated. Available options: - `fixed`: Uses a predetermined time value specified in the `timeSavedPerExecution` field. * Requires the `timeSavedPerExecution` field to be set * Use when the time saved is consistent across all executions - `dynamic`: Automatically calculates time saved based on actual execution metrics * The `timeSavedPerExecution` field is ignored when this mode is active * Use when time saved varies between executions timeSavedPerExecution: type: number description: Estimated time saved per execution in minutes redactionPolicy: type: string enum: - none - non-manual - manual-only - all description: | Controls whether execution data is redacted for this workflow. Available options: - `none` (default): No redaction — all execution data is stored. - `non-manual`: Redact production (non-manually triggered) executions only. - `manual-only`: Redact manually triggered executions only. - `all`: Redact all executions (manual and production). When the instance has a redaction floor configured, the policy must be equal to or stricter than the floor. A policy weaker than the floor is rejected with 422 on create, and on update when it changes the stored policy; an unchanged pre-existing below-floor policy is preserved (the floor is not applied retroactively). Omitting this field when creating a workflow seeds it to the instance floor instead. example: non-manual availableInMCP: type: boolean description: | Controls whether this workflow is accessible via the Model Context Protocol (MCP). Defaults to false. When enabled, this workflow can be called by MCP clients (AI assistants and other tools that support MCP). This allows external AI tools to discover and execute this workflow as part of their capabilities. Requirements for enabling MCP access: - The workflow must be active (not deactivated) - The workflow must contain at least one active Webhook node - Only webhook-triggered workflows can be exposed via MCP Security note: When a workflow is available in MCP, it can be discovered and executed by any MCP client that has the appropriate API credentials for your n8n instance. example: false customTelemetryTags: type: array items: type: object additionalProperties: false required: - key - value properties: key: type: string value: type: string credentialResolverId: type: string description: | ID of the credential resolver used to resolve credentials for this workflow. This is a derived, internal setting managed via the workflow's credential resolver configuration rather than something intended to be set programmatically. It is included in workflow responses for reference, but any value sent when creating or updating a workflow is ignored. sharedWorkflow: type: object additionalProperties: false properties: role: type: string example: workflow:owner workflowId: type: string example: 2tUt1wbLX592XDdX projectId: type: string example: 2tUt1wbLX592XDdX project: type: object properties: id: type: string readOnly: true name: type: string type: type: string readOnly: true createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true activeVersion: type: object readOnly: true nullable: true additionalProperties: false properties: versionId: type: string readOnly: true description: Unique identifier for this workflow version example: 7c6b9e3f-8d4a-4b2c-9f1e-6a5d3b8c7e4f workflowId: type: string readOnly: true description: The workflow this version belongs to example: 2tUt1wbLX592XDdX nodes: type: array readOnly: true items: $ref: '#/components/schemas/node' connections: type: object readOnly: true example: Jira: main: - - node: Jira type: main index: 0 nodeGroups: type: array readOnly: true description: Visual groupings of nodes shown as frames on the canvas items: $ref: '#/components/schemas/workflowNodeGroup' authors: type: string readOnly: true description: Comma-separated list of author IDs who contributed to this version example: 1,2,3 name: type: string nullable: true readOnly: true description: Optional name for this workflow version example: Production release description: type: string nullable: true readOnly: true description: Optional description for this workflow version autosaved: type: boolean readOnly: true description: Whether this version was created by autosave createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true workflow: type: object additionalProperties: false required: - name - nodes - connections - settings properties: id: type: string readOnly: true example: 2tUt1wbLX592XDdX name: type: string example: Workflow 1 description: type: string description: Description of the workflow example: My workflow description parentFolderId: type: string nullable: true writeOnly: true description: ID of the folder to move the workflow into. Pass null to move it to the project root; omit to leave its current folder unchanged. example: X8ovzm8lTQjcXRZQ active: type: boolean readOnly: true createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true isArchived: type: boolean readOnly: true versionId: type: string readOnly: true description: Current version identifier used for optimistic locking triggerCount: type: integer readOnly: true description: Number of active trigger nodes in the workflow nodes: type: array items: $ref: '#/components/schemas/node' connections: type: object example: Jira: main: - - node: Jira type: main index: 0 nodeGroups: type: array description: Visual groupings of nodes shown as frames on the canvas items: $ref: '#/components/schemas/workflowNodeGroup' settings: $ref: '#/components/schemas/workflowSettings' staticData: example: lastId: 1 anyOf: - type: string format: jsonString nullable: true - type: object nullable: true pinData: type: object nullable: true description: Pinned sample data for nodes, keyed by node name meta: type: object nullable: true readOnly: true description: Workflow metadata such as template information properties: onboardingId: type: string templateId: type: string instanceId: type: string templateCredsSetupCompleted: type: boolean tags: type: array items: $ref: '#/components/schemas/tag' readOnly: true shared: type: array items: $ref: '#/components/schemas/sharedWorkflow' activeVersion: $ref: '#/components/schemas/activeVersion' workflowList: type: object properties: data: type: array items: $ref: '#/components/schemas/workflow' nextCursor: type: string description: Paginate through workflows by setting the cursor parameter to a nextCursor attribute returned by a previous request. Default value fetches the first "page" of the collection. nullable: true example: MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA Error: $ref: '#/components/schemas/error' Role: $ref: '#/components/schemas/role' Node: $ref: '#/components/schemas/node' WorkflowNodeGroup: $ref: '#/components/schemas/workflowNodeGroup' Tag: $ref: '#/components/schemas/tag' Workflow: $ref: '#/components/schemas/workflow' WorkflowSettings: $ref: '#/components/schemas/workflowSettings' WorkflowList: $ref: '#/components/schemas/workflowList' Audit: $ref: '#/components/schemas/audit' UserList: $ref: '#/components/schemas/userList' User: $ref: '#/components/schemas/user' credentialPublicDto.generated: type: object properties: id: type: string name: type: string type: type: string isManaged: type: boolean isGlobal: type: boolean isResolvable: type: boolean resolvableAllowFallback: type: boolean resolverId: type: string nullable: true createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - name - type - isManaged - isGlobal - isResolvable - resolvableAllowFallback - resolverId - createdAt - updatedAt executionTagsPublicDto.generated: type: array items: type: object properties: id: type: string readOnly: true example: 2tUt1wbLX592XDdX name: type: string example: Production createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true required: - id - name - createdAt - updatedAt policyEffectivePublicDto.generated: type: object properties: scopeId: type: string nullable: true rules: type: array items: type: object properties: id: type: string minLength: 1 action: type: string enum: - allow - deny - delegate selector: oneOf: - type: object properties: kind: type: string enum: - name value: type: string minLength: 1 required: - kind - value - type: object properties: kind: type: string enum: - package value: type: string minLength: 1 required: - kind - value required: - id - action - selector defaultAction: type: string enum: - allow - deny - delegate version: type: integer minimum: 0 required: - scopeId - rules - defaultAction - version policyEffectiveWriteResultPublicDto.generated: type: object properties: scopeId: type: string nullable: true rules: type: array items: type: object properties: id: type: string minLength: 1 action: type: string enum: - allow - deny - delegate selector: oneOf: - type: object properties: kind: type: string enum: - name value: type: string minLength: 1 required: - kind - value - type: object properties: kind: type: string enum: - package value: type: string minLength: 1 required: - kind - value required: - id - action - selector defaultAction: type: string enum: - allow - deny - delegate version: type: integer minimum: 0 warnings: type: array items: type: object properties: ruleId: type: string shadowedByRuleId: type: string required: - ruleId - shadowedByRuleId required: - scopeId - rules - defaultAction - version - warnings policyDocumentWriteResultPublicDto.generated: type: object properties: policy: type: object properties: id: type: string kind: type: string rules: type: array items: type: object properties: id: type: string minLength: 1 action: type: string enum: - allow - deny - delegate selector: oneOf: - type: object properties: kind: type: string enum: - name value: type: string minLength: 1 required: - kind - value - type: object properties: kind: type: string enum: - package value: type: string minLength: 1 required: - kind - value required: - id - action - selector version: type: integer minimum: 0 exclusiveMinimum: true updatedBy: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - kind - rules - version - updatedBy - createdAt - updatedAt warnings: type: array items: type: object properties: ruleId: type: string shadowedByRuleId: type: string required: - ruleId - shadowedByRuleId required: - policy - warnings promotionProviderPublicDto.generated: type: object properties: id: type: string minLength: 1 maxLength: 36 name: type: string type: type: string enum: - git authType: type: string enum: - ssh-key - token config: anyOf: - type: object properties: schemaVersion: type: number enum: - 1 publicKey: type: string minLength: 1 keyType: type: string enum: - ed25519 - rsa required: - schemaVersion - publicKey - keyType additionalProperties: false - type: object properties: schemaVersion: type: number enum: - 1 required: - schemaVersion additionalProperties: false createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - name - type - authType - config - createdAt - updatedAt promotionConnectionPublicDto.generated: type: object properties: id: type: string minLength: 1 maxLength: 36 name: type: string scope: type: string enum: - instance - projects target: type: object properties: schemaVersion: type: number enum: - 1 remoteUrl: type: string minLength: 1 required: - schemaVersion - remoteUrl additionalProperties: false provider: type: object properties: id: type: string minLength: 1 maxLength: 36 name: type: string type: type: string enum: - git authType: type: string enum: - ssh-key - token createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - name - type - authType - createdAt - updatedAt configs: type: object properties: apply: type: object properties: id: type: string minLength: 1 maxLength: 36 name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time checkout: type: object properties: hasCheckout: type: boolean matchesConfig: type: boolean required: - hasCheckout - matchesConfig settings: type: object properties: schemaVersion: type: number enum: - 1 branchName: type: string minLength: 1 maxLength: 255 required: - schemaVersion - branchName additionalProperties: false required: - id - name - createdAt - updatedAt - checkout - settings promote: type: object properties: id: type: string minLength: 1 maxLength: 36 name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time checkout: type: object properties: hasCheckout: type: boolean matchesConfig: type: boolean required: - hasCheckout - matchesConfig settings: type: object properties: schemaVersion: type: number enum: - 1 baseBranchName: type: string minLength: 1 maxLength: 255 createBranchOnPromotion: type: boolean required: - schemaVersion - baseBranchName - createBranchOnPromotion additionalProperties: false required: - id - name - createdAt - updatedAt - checkout - settings createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - name - scope - target - provider - configs - createdAt - updatedAt promotionCheckoutPublicDto.generated: type: object properties: connectionId: type: string minLength: 1 maxLength: 36 configId: type: string minLength: 1 maxLength: 36 direction: type: string enum: - apply - promote branchName: type: string hasCheckout: type: boolean required: - connectionId - configId - direction - branchName - hasCheckout promotionCredentialExpressionValue.generated: anyOf: - type: string - type: array items: $ref: '#/components/schemas/promotionCredentialExpressionValue.generated' - type: object additionalProperties: $ref: '#/components/schemas/promotionCredentialExpressionValue.generated' description: Values can be strings, arrays, or nested objects. Every leaf is an expression string. applyPackageResultDto.generated: oneOf: - type: object properties: connectionId: type: string minLength: 1 maxLength: 36 configId: type: string minLength: 1 maxLength: 36 git: type: object properties: commitSha: type: string branchName: type: string required: - commitSha - branchName status: type: string enum: - applied counts: type: object properties: projects: type: object properties: created: type: integer minimum: 0 updated: type: integer minimum: 0 skipped: type: integer minimum: 0 deleted: type: integer minimum: 0 required: - created - updated - skipped - deleted folders: type: object properties: created: type: integer minimum: 0 skipped: type: integer minimum: 0 removed: type: integer minimum: 0 required: - created - skipped - removed workflows: type: object properties: created: type: integer minimum: 0 updated: type: integer minimum: 0 skipped: type: integer minimum: 0 archived: type: integer minimum: 0 deleted: type: integer minimum: 0 publishing: type: object properties: published: type: integer minimum: 0 unpublished: type: integer minimum: 0 unchanged: type: integer minimum: 0 blocked: type: integer minimum: 0 failed: type: integer minimum: 0 required: - published - unpublished - unchanged - blocked - failed required: - created - updated - skipped - archived - deleted - publishing credentials: type: object properties: matched: type: integer minimum: 0 stubbed: type: integer minimum: 0 required: - matched - stubbed dataTables: type: object properties: matched: type: integer minimum: 0 created: type: integer minimum: 0 required: - matched - created variables: type: object properties: matched: type: integer minimum: 0 created: type: integer minimum: 0 updated: type: integer minimum: 0 stubbed: type: integer minimum: 0 missing: type: integer minimum: 0 required: - matched - created - updated - stubbed - missing tags: type: object properties: matched: type: integer minimum: 0 created: type: integer minimum: 0 renamed: type: integer minimum: 0 reconciled: type: integer minimum: 0 skipped: type: integer minimum: 0 required: - matched - created - renamed - reconciled - skipped required: - projects - folders - workflows - credentials - dataTables - variables - tags warnings: type: array items: type: object properties: kind: type: string enum: - variable code: type: string enum: - variable-shadowed name: type: string minLength: 1 scope: type: object properties: kind: type: string enum: - global required: - kind consumers: type: array items: type: object properties: project: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name workflows: type: array items: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name minItems: 1 required: - project - workflows minItems: 1 required: - kind - code - name - scope - consumers required: - connectionId - configId - git - status - counts - warnings - type: object properties: connectionId: type: string minLength: 1 maxLength: 36 configId: type: string minLength: 1 maxLength: 36 git: type: object properties: commitSha: type: string branchName: type: string required: - commitSha - branchName status: type: string enum: - blocked preflight: type: object properties: missingBindings: type: array items: oneOf: - type: object properties: kind: type: string enum: - credential sourceId: type: string minLength: 1 name: type: string credentialType: type: string minLength: 1 consumers: type: array items: type: object properties: project: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name workflows: type: array items: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name minItems: 1 required: - project - workflows minItems: 1 ownerProject: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name expressionData: type: object additionalProperties: $ref: '#/components/schemas/promotionCredentialExpressionValue.generated' description: Credential expressions. required: - kind - sourceId - name - credentialType - consumers - ownerProject - type: object properties: kind: type: string enum: - variable name: type: string minLength: 1 variableType: type: string enum: - string default: string scope: oneOf: - type: object properties: kind: type: string enum: - global required: - kind - type: object properties: kind: type: string enum: - project project: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name required: - kind - project sourceValue: type: string maxLength: 1000 consumers: type: array items: type: object properties: project: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name workflows: type: array items: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name minItems: 1 required: - project - workflows minItems: 1 required: - kind - name - scope - consumers accessRequirements: type: array items: type: object properties: kind: type: string enum: - credential sourceId: type: string minLength: 1 name: type: string credentialType: type: string minLength: 1 consumers: type: array items: type: object properties: project: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name workflows: type: array items: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name minItems: 1 required: - project - workflows minItems: 1 code: type: string enum: - access-required required: - kind - sourceId - name - credentialType - consumers - code conflicts: type: array items: oneOf: - type: object properties: kind: type: string enum: - credential sourceId: type: string nullable: true minLength: 1 name: type: string expectedTypes: type: array items: type: string minItems: 1 filePath: type: string referenceFiles: type: array items: type: string minItems: 1 consumers: type: array items: type: object properties: project: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name workflows: type: array items: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name minItems: 1 required: - project - workflows minItems: 1 code: type: string enum: - missing-id required: - kind - sourceId - name - expectedTypes - referenceFiles - consumers - code - type: object properties: kind: type: string enum: - credential sourceId: type: string nullable: true minLength: 1 name: type: string expectedTypes: type: array items: type: string minItems: 1 filePath: type: string referenceFiles: type: array items: type: string minItems: 1 consumers: type: array items: type: object properties: project: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name workflows: type: array items: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name minItems: 1 required: - project - workflows minItems: 1 code: type: string enum: - conflicting-types required: - kind - sourceId - name - expectedTypes - referenceFiles - consumers - code - type: object properties: kind: type: string enum: - credential sourceId: type: string nullable: true minLength: 1 name: type: string expectedTypes: type: array items: type: string minItems: 1 filePath: type: string referenceFiles: type: array items: type: string minItems: 1 consumers: type: array items: type: object properties: project: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name workflows: type: array items: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name minItems: 1 required: - project - workflows minItems: 1 code: type: string enum: - unknown-type required: - kind - sourceId - name - expectedTypes - referenceFiles - consumers - code - type: object properties: kind: type: string enum: - credential sourceId: type: string nullable: true minLength: 1 name: type: string expectedTypes: type: array items: type: string minItems: 1 filePath: type: string referenceFiles: type: array items: type: string minItems: 1 consumers: type: array items: type: object properties: project: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name workflows: type: array items: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name minItems: 1 required: - project - workflows minItems: 1 code: type: string enum: - unknown-owner required: - kind - sourceId - name - expectedTypes - referenceFiles - consumers - code - type: object properties: kind: type: string enum: - credential sourceId: type: string nullable: true minLength: 1 name: type: string expectedTypes: type: array items: type: string minItems: 1 filePath: type: string referenceFiles: type: array items: type: string minItems: 1 consumers: type: array items: type: object properties: project: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name workflows: type: array items: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name minItems: 1 required: - project - workflows minItems: 1 code: type: string enum: - type-mismatch targetType: type: string required: - kind - sourceId - name - expectedTypes - referenceFiles - consumers - code - targetType - type: object properties: kind: type: string enum: - credential sourceId: type: string nullable: true minLength: 1 name: type: string expectedTypes: type: array items: type: string minItems: 1 filePath: type: string referenceFiles: type: array items: type: string minItems: 1 consumers: type: array items: type: object properties: project: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name workflows: type: array items: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name minItems: 1 required: - project - workflows minItems: 1 code: type: string enum: - incompatible-usage-scope usageScope: type: string required: - kind - sourceId - name - expectedTypes - referenceFiles - consumers - code - usageScope - type: object properties: kind: type: string enum: - variable code: type: string enum: - missing-definition name: type: string minLength: 1 referenceFiles: type: array items: type: string minItems: 1 consumers: type: array items: type: object properties: project: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name workflows: type: array items: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name minItems: 1 required: - project - workflows minItems: 1 required: - kind - code - name - referenceFiles - consumers - type: object properties: kind: type: string enum: - project code: type: string enum: - project-not-team project: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name filePath: type: string workflows: type: array items: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name required: - kind - code - project - filePath - workflows warnings: type: array items: type: object properties: kind: type: string enum: - variable code: type: string enum: - variable-shadowed name: type: string minLength: 1 scope: type: object properties: kind: type: string enum: - global required: - kind consumers: type: array items: type: object properties: project: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name workflows: type: array items: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name minItems: 1 required: - project - workflows minItems: 1 required: - kind - code - name - scope - consumers required: - missingBindings - accessRequirements - conflicts - warnings required: - connectionId - configId - git - status - preflight - type: object properties: connectionId: type: string minLength: 1 maxLength: 36 configId: type: string minLength: 1 maxLength: 36 git: type: object properties: commitSha: type: string branchName: type: string required: - commitSha - branchName status: type: string enum: - source-changed required: - connectionId - configId - git - status roleMappingRulePublicDto.generated: type: object properties: id: type: string expression: type: string role: type: string type: type: string enum: - instance - project order: type: integer projectIds: type: array items: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - expression - role - type - order - projectIds - createdAt - updatedAt rolePublicDto.generated: type: object properties: slug: type: string displayName: type: string description: type: string nullable: true systemRole: type: boolean roleType: type: string enum: - project - global scopes: type: array items: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - slug - displayName - description - systemRole - roleType - scopes - createdAt - updatedAt tagPublicDto.generated: type: object properties: id: type: string readOnly: true example: 2tUt1wbLX592XDdX name: type: string example: Production createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true required: - id - name - createdAt - updatedAt workflowPublicDto.generated: type: object properties: id: type: string name: type: string description: type: string nullable: true active: type: boolean activeVersionId: type: string nullable: true createdAt: type: string format: date-time updatedAt: type: string format: date-time isArchived: type: boolean versionId: type: string versionCounter: type: number sourceWorkflowId: type: string nullable: true triggerCount: type: number nodes: type: array description: Nodes that make up the workflow items: type: object properties: id: type: string example: 0f5532f9-36ba-4bef-86c7-30d607400b15 name: type: string example: Jira webhookId: type: string disabled: type: boolean notesInFlow: type: boolean notes: type: string type: type: string example: n8n-nodes-base.jira typeVersion: type: number example: 1 executeOnce: type: boolean example: false alwaysOutputData: type: boolean example: false retryOnFail: type: boolean example: false maxTries: type: number waitBetweenTries: type: number continueOnFail: type: boolean example: false description: use onError instead deprecated: true onError: type: string example: stopWorkflow position: type: array items: type: number example: - -100 - 80 parameters: type: object additionalProperties: true credentials: type: object example: jiraSoftwareCloudApi: name: jiraApi customTelemetryTags: type: object properties: tag: type: array items: type: object properties: key: type: string value: type: string required: - key - value createdAt: type: string format: date-time updatedAt: type: string format: date-time connections: type: object description: Connections between nodes, keyed by source node name example: Jira: main: - - node: Jira type: main index: 0 nodeGroups: type: array description: Visual groupings of nodes shown as frames on the canvas items: type: object properties: id: type: string description: Unique identifier for the node group example: 9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d name: type: string description: Display name of the node group example: Data processing description: type: string maxLength: 155 description: Optional plain-text description of the node group example: Cleans and normalizes incoming records nodeIds: type: array description: IDs of the nodes that belong to this group items: type: string required: - id - name - nodeIds settings: type: object description: Execution and behaviour settings for the workflow properties: saveExecutionProgress: oneOf: - type: boolean - type: string enum: - DEFAULT saveManualExecutions: oneOf: - type: boolean - type: string enum: - DEFAULT saveDataErrorExecution: type: string enum: - DEFAULT - all - none saveDataSuccessExecution: type: string enum: - DEFAULT - all - none executionTimeout: type: number example: 3600 errorWorkflow: type: string example: VzqKEW0ShTXA5vPj description: The ID of the workflow that contains the error trigger node. timezone: type: string example: America/New_York executionOrder: type: string example: v1 binaryMode: type: string enum: - separate - combined description: Controls how binary data is resolved from a node's input. This is a derived, internal setting rather than something intended to be set programmatically. It is included in workflow responses for reference, but any value sent when creating or updating a workflow is ignored. callerPolicy: type: string enum: - any - none - workflowsFromAList - workflowsFromSameOwner example: workflowsFromSameOwner description: |- Controls which workflows are allowed to call this workflow using the Execute Workflow node. Defaults to workflowsFromSameOwner. Available options: - `any`: Any workflow can call this workflow (no restrictions) - `none`: No other workflows can call this workflow (completely blocked) - `workflowsFromSameOwner` (default): Only workflows owned by the same project can call this workflow - `workflowsFromAList`: Only the workflows listed in `callerIds` can call this workflow callerIds: type: string example: 14, 18, 23 description: Comma-separated list of workflow IDs allowed to call this workflow (only used with the workflowsFromAList policy) timeSavedMode: type: string enum: - fixed - dynamic description: |- Controls how the time saved per execution is calculated. Available options: - `fixed`: Uses the value in `timeSavedPerExecution`. Use when the time saved is the same for every execution. - `dynamic`: Calculates the time saved from actual execution metrics. `timeSavedPerExecution` is ignored. timeSavedPerExecution: type: number description: Estimated time saved per execution in minutes redactionPolicy: type: string enum: - none - non-manual - manual-only - all example: non-manual description: |- Controls whether execution data is redacted for this workflow. Available options: - `none` (default): No redaction. All execution data is stored. - `non-manual`: Redact production (non-manually triggered) executions only. - `manual-only`: Redact manually triggered executions only. - `all`: Redact all executions, manual and production. availableInMCP: type: boolean example: false description: Controls whether this workflow is reachable over the Model Context Protocol (MCP). Defaults to false. The workflow must be active and must hold at least one active Webhook node. customTelemetryTags: type: array items: type: object properties: key: type: string value: type: string required: - key - value credentialResolverId: type: string description: ID of the credential resolver that resolves credentials for this workflow. This is a derived, internal setting managed through the credential resolver configuration rather than something intended to be set programmatically. It is included in workflow responses for reference, but any value sent when creating or updating a workflow is ignored. nullable: true staticData: type: object description: Data the workflow keeps between executions example: lastId: 1 nullable: true pinData: type: object description: Pinned sample data for nodes, keyed by node name nullable: true meta: type: object description: Workflow metadata such as template information properties: onboardingId: type: string templateId: type: string instanceId: type: string templateCredsSetupCompleted: type: boolean nullable: true tags: type: array items: type: object properties: id: type: string readOnly: true example: 2tUt1wbLX592XDdX name: type: string example: Production createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true required: - id - name - createdAt - updatedAt shared: type: array items: type: object properties: role: type: string workflowId: type: string projectId: type: string project: type: object properties: id: type: string readOnly: true example: VmwOO9HeTEj20kxM name: type: string example: Marketing type: type: string enum: - personal - team readOnly: true example: team icon: type: object description: Icon of the project, or null when the project has none properties: type: type: string enum: - emoji - icon value: type: string color: type: string required: - type - value nullable: true description: type: string nullable: true example: Workflows the marketing team owns. customTelemetryTags: type: array items: type: object properties: key: type: string value: type: string required: - key - value creatorId: type: string nullable: true example: f9a2cbb8-0b1e-4b64-9c1c-0d5f5f1f2a3b createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true required: - id - name - type - icon - description - customTelemetryTags - creatorId - createdAt - updatedAt createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - role - workflowId - projectId - project - createdAt - updatedAt activeVersion: type: object nullable: true properties: versionId: type: string workflowId: type: string nodes: type: array description: Nodes that make up the workflow items: type: object properties: id: type: string example: 0f5532f9-36ba-4bef-86c7-30d607400b15 name: type: string example: Jira webhookId: type: string disabled: type: boolean notesInFlow: type: boolean notes: type: string type: type: string example: n8n-nodes-base.jira typeVersion: type: number example: 1 executeOnce: type: boolean example: false alwaysOutputData: type: boolean example: false retryOnFail: type: boolean example: false maxTries: type: number waitBetweenTries: type: number continueOnFail: type: boolean example: false description: use onError instead deprecated: true onError: type: string example: stopWorkflow position: type: array items: type: number example: - -100 - 80 parameters: type: object additionalProperties: true credentials: type: object example: jiraSoftwareCloudApi: name: jiraApi customTelemetryTags: type: object properties: tag: type: array items: type: object properties: key: type: string value: type: string required: - key - value createdAt: type: string format: date-time updatedAt: type: string format: date-time connections: type: object description: Connections between nodes, keyed by source node name example: Jira: main: - - node: Jira type: main index: 0 nodeGroups: type: array description: Visual groupings of nodes shown as frames on the canvas items: type: object properties: id: type: string description: Unique identifier for the node group example: 9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d name: type: string description: Display name of the node group example: Data processing description: type: string maxLength: 155 description: Optional plain-text description of the node group example: Cleans and normalizes incoming records nodeIds: type: array description: IDs of the nodes that belong to this group items: type: string required: - id - name - nodeIds authors: type: string name: type: string nullable: true description: type: string nullable: true autosaved: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time workflowPublishHistory: type: array items: type: object properties: id: type: number workflowId: type: string versionId: type: string nullable: true event: type: string enum: - activated - deactivated userId: type: string nullable: true createdAt: type: string format: date-time required: - id - workflowId - versionId - event - userId - createdAt required: - versionId - workflowId - nodes - connections - nodeGroups - authors - name - description - autosaved - createdAt - updatedAt - workflowPublishHistory required: - id - name - description - active - activeVersionId - createdAt - updatedAt - isArchived - versionId - versionCounter - sourceWorkflowId - triggerCount - nodes - connections - nodeGroups - settings - staticData - meta - shared - activeVersion workflowPublishPublicDto.generated: type: object properties: id: type: string name: type: string description: type: string nullable: true active: type: boolean activeVersionId: type: string nullable: true createdAt: type: string format: date-time updatedAt: type: string format: date-time isArchived: type: boolean versionId: type: string versionCounter: type: number sourceWorkflowId: type: string nullable: true triggerCount: type: number nodes: type: array description: Nodes that make up the workflow items: type: object properties: id: type: string example: 0f5532f9-36ba-4bef-86c7-30d607400b15 name: type: string example: Jira webhookId: type: string disabled: type: boolean notesInFlow: type: boolean notes: type: string type: type: string example: n8n-nodes-base.jira typeVersion: type: number example: 1 executeOnce: type: boolean example: false alwaysOutputData: type: boolean example: false retryOnFail: type: boolean example: false maxTries: type: number waitBetweenTries: type: number continueOnFail: type: boolean example: false description: use onError instead deprecated: true onError: type: string example: stopWorkflow position: type: array items: type: number example: - -100 - 80 parameters: type: object additionalProperties: true credentials: type: object example: jiraSoftwareCloudApi: name: jiraApi customTelemetryTags: type: object properties: tag: type: array items: type: object properties: key: type: string value: type: string required: - key - value createdAt: type: string format: date-time updatedAt: type: string format: date-time connections: type: object description: Connections between nodes, keyed by source node name example: Jira: main: - - node: Jira type: main index: 0 nodeGroups: type: array description: Visual groupings of nodes shown as frames on the canvas items: type: object properties: id: type: string description: Unique identifier for the node group example: 9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d name: type: string description: Display name of the node group example: Data processing description: type: string maxLength: 155 description: Optional plain-text description of the node group example: Cleans and normalizes incoming records nodeIds: type: array description: IDs of the nodes that belong to this group items: type: string required: - id - name - nodeIds settings: type: object description: Execution and behaviour settings for the workflow properties: saveExecutionProgress: oneOf: - type: boolean - type: string enum: - DEFAULT saveManualExecutions: oneOf: - type: boolean - type: string enum: - DEFAULT saveDataErrorExecution: type: string enum: - DEFAULT - all - none saveDataSuccessExecution: type: string enum: - DEFAULT - all - none executionTimeout: type: number example: 3600 errorWorkflow: type: string example: VzqKEW0ShTXA5vPj description: The ID of the workflow that contains the error trigger node. timezone: type: string example: America/New_York executionOrder: type: string example: v1 binaryMode: type: string enum: - separate - combined description: Controls how binary data is resolved from a node's input. This is a derived, internal setting rather than something intended to be set programmatically. It is included in workflow responses for reference, but any value sent when creating or updating a workflow is ignored. callerPolicy: type: string enum: - any - none - workflowsFromAList - workflowsFromSameOwner example: workflowsFromSameOwner description: |- Controls which workflows are allowed to call this workflow using the Execute Workflow node. Defaults to workflowsFromSameOwner. Available options: - `any`: Any workflow can call this workflow (no restrictions) - `none`: No other workflows can call this workflow (completely blocked) - `workflowsFromSameOwner` (default): Only workflows owned by the same project can call this workflow - `workflowsFromAList`: Only the workflows listed in `callerIds` can call this workflow callerIds: type: string example: 14, 18, 23 description: Comma-separated list of workflow IDs allowed to call this workflow (only used with the workflowsFromAList policy) timeSavedMode: type: string enum: - fixed - dynamic description: |- Controls how the time saved per execution is calculated. Available options: - `fixed`: Uses the value in `timeSavedPerExecution`. Use when the time saved is the same for every execution. - `dynamic`: Calculates the time saved from actual execution metrics. `timeSavedPerExecution` is ignored. timeSavedPerExecution: type: number description: Estimated time saved per execution in minutes redactionPolicy: type: string enum: - none - non-manual - manual-only - all example: non-manual description: |- Controls whether execution data is redacted for this workflow. Available options: - `none` (default): No redaction. All execution data is stored. - `non-manual`: Redact production (non-manually triggered) executions only. - `manual-only`: Redact manually triggered executions only. - `all`: Redact all executions, manual and production. availableInMCP: type: boolean example: false description: Controls whether this workflow is reachable over the Model Context Protocol (MCP). Defaults to false. The workflow must be active and must hold at least one active Webhook node. customTelemetryTags: type: array items: type: object properties: key: type: string value: type: string required: - key - value credentialResolverId: type: string description: ID of the credential resolver that resolves credentials for this workflow. This is a derived, internal setting managed through the credential resolver configuration rather than something intended to be set programmatically. It is included in workflow responses for reference, but any value sent when creating or updating a workflow is ignored. nullable: true staticData: type: object description: Data the workflow keeps between executions example: lastId: 1 nullable: true pinData: type: object description: Pinned sample data for nodes, keyed by node name nullable: true meta: type: object description: Workflow metadata such as template information properties: onboardingId: type: string templateId: type: string instanceId: type: string templateCredsSetupCompleted: type: boolean nullable: true tags: type: array items: type: object properties: id: type: string readOnly: true example: 2tUt1wbLX592XDdX name: type: string example: Production createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true required: - id - name - createdAt - updatedAt activeVersion: type: object nullable: true properties: versionId: type: string workflowId: type: string nodes: type: array description: Nodes that make up the workflow items: type: object properties: id: type: string example: 0f5532f9-36ba-4bef-86c7-30d607400b15 name: type: string example: Jira webhookId: type: string disabled: type: boolean notesInFlow: type: boolean notes: type: string type: type: string example: n8n-nodes-base.jira typeVersion: type: number example: 1 executeOnce: type: boolean example: false alwaysOutputData: type: boolean example: false retryOnFail: type: boolean example: false maxTries: type: number waitBetweenTries: type: number continueOnFail: type: boolean example: false description: use onError instead deprecated: true onError: type: string example: stopWorkflow position: type: array items: type: number example: - -100 - 80 parameters: type: object additionalProperties: true credentials: type: object example: jiraSoftwareCloudApi: name: jiraApi customTelemetryTags: type: object properties: tag: type: array items: type: object properties: key: type: string value: type: string required: - key - value createdAt: type: string format: date-time updatedAt: type: string format: date-time connections: type: object description: Connections between nodes, keyed by source node name example: Jira: main: - - node: Jira type: main index: 0 nodeGroups: type: array description: Visual groupings of nodes shown as frames on the canvas items: type: object properties: id: type: string description: Unique identifier for the node group example: 9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d name: type: string description: Display name of the node group example: Data processing description: type: string maxLength: 155 description: Optional plain-text description of the node group example: Cleans and normalizes incoming records nodeIds: type: array description: IDs of the nodes that belong to this group items: type: string required: - id - name - nodeIds authors: type: string name: type: string nullable: true description: type: string nullable: true autosaved: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time workflowPublishHistory: type: array items: type: object properties: id: type: number workflowId: type: string versionId: type: string nullable: true event: type: string enum: - activated - deactivated userId: type: string nullable: true createdAt: type: string format: date-time required: - id - workflowId - versionId - event - userId - createdAt required: - versionId - workflowId - nodes - connections - nodeGroups - authors - name - description - autosaved - createdAt - updatedAt - workflowPublishHistory required: - id - name - description - active - activeVersionId - createdAt - updatedAt - isArchived - versionId - versionCounter - sourceWorkflowId - triggerCount - nodes - connections - nodeGroups - settings - staticData - meta - activeVersion workflowTagsPublicDto.generated: type: array items: type: object properties: id: type: string readOnly: true example: 2tUt1wbLX592XDdX name: type: string example: Production createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true required: - id - name - createdAt - updatedAt responses: unauthorized: description: Unauthorized forbidden: description: Forbidden badRequest: description: The request is invalid or provides malformed data. conflict: description: Conflict notFound: description: The specified resource was not found. paymentRequired: description: Payment required unsupportedMediaType: description: Unsupported media type. unprocessableEntity: description: Unprocessable Entity serviceUnavailable: description: The requested service is temporarily unavailable. NotFound: $ref: '#/components/responses/notFound' Unauthorized: $ref: '#/components/responses/unauthorized' BadRequest: $ref: '#/components/responses/badRequest' Conflict: $ref: '#/components/responses/conflict' Forbidden: $ref: '#/components/responses/forbidden' PaymentRequired: $ref: '#/components/responses/paymentRequired' UnsupportedMediaType: $ref: '#/components/responses/unsupportedMediaType' UnprocessableEntity: $ref: '#/components/responses/unprocessableEntity' ServiceUnavailable: $ref: '#/components/responses/serviceUnavailable' parameters: limit: name: limit in: query description: The maximum number of items to return. required: false schema: type: number example: 100 default: 100 maximum: 250 cursor: name: cursor in: query description: Paginate by setting the cursor parameter to the nextCursor attribute returned by the previous request's response. Default value fetches the first "page" of the collection. See pagination for more detail. required: false style: form schema: type: string workflowId: name: id in: path description: The ID of the workflow. required: true schema: type: string testRunWorkflowId: name: id in: path description: The ID of the workflow. required: true schema: type: string testRunId: name: runId in: path description: The ID of the test run. required: true schema: type: string offset: name: offset in: query description: The number of items to skip before starting to collect the result set. required: false schema: type: number example: 0 default: 0 minimum: 0 includeRole: name: includeRole in: query description: Whether to include the user's role or not. required: false schema: type: boolean example: true default: false userIdentifier: name: id in: path description: The ID or email of the user. required: true schema: type: string format: identifier dataTableId: name: dataTableId in: path description: The ID of the data table required: true schema: type: string format: nanoid columnId: name: columnId in: path description: The ID of the column required: true schema: type: string format: nanoid Cursor: $ref: '#/components/parameters/cursor' Limit: $ref: '#/components/parameters/limit' Offset: $ref: '#/components/parameters/offset' WorkflowId: $ref: '#/components/parameters/workflowId' TestRunWorkflowId: $ref: '#/components/parameters/testRunWorkflowId' TestRunId: $ref: '#/components/parameters/testRunId' UserIdentifier: $ref: '#/components/parameters/userIdentifier' IncludeRole: $ref: '#/components/parameters/includeRole' securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-N8N-API-KEY BearerAuth: type: http scheme: bearer bearerFormat: JWT CookieAuth: type: apiKey in: cookie name: n8n-auth x-enable-proxy: false