Retrieve all users from your instance. Only available for the instance owner. The maximum number of items to return. 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. Whether to include the user's role or not. Create one or more users. Array of users to be created. Retrieve a user from your instance. Only available for the instance owner. The ID or email of the user. Whether to include the user's role or not. Change a user's global role The ID or email of the user. New role for the user Generate a security audit for your n8n instance. Retrieve all executions from your instance. Whether or not to include the execution's detailed data. Status to filter the executions by. Workflow to filter the executions by. The maximum number of items to return. 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. Retrieve an execution from your instance. The ID of the execution. Whether or not to include the execution's detailed data. Deletes an execution from your instance. The ID of the execution. Create a workflow in your instance. Created workflow object. Retrieve all workflows from your instance. The maximum number of items to return. 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. Retrieves a workflow. The ID of the workflow. Deletes a workflow. The ID of the workflow. Update a workflow. The ID of the workflow. Updated workflow object. Active a workflow. The ID of the workflow. Deactivate a workflow. The ID of the workflow. Transfer a workflow to another project. The ID of the workflow. Destination project information for the workflow transfer. The ID of the project to transfer the workflow to. Transfer a credential to another project. The ID of the credential. Destination project for the credential transfer. The ID of the project to transfer the credential to. Creates a credential that can be used by nodes of the specified type. Credential to be created. Deletes a credential from your instance. You must be the owner of the credentials The credential ID that needs to be deleted The credential type name that you want to get the schema for Requires the Source Control feature to be licensed and connected to a repository. Pull options Retrieve variables from your instance. The maximum number of items to return. 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. Retrieve projects from your instance. The maximum number of items to return. 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.Retrieve all users
Authorizations:
query Parameters
limit cursor includeRole projectId Responses
Response samples
{
}
],
}Create multiple users
Authorizations:
Request Body schema: application/json
email role Responses
Request samples
[
]
} Response samples
{
}
},Get user by ID/Email
Authorizations:
path Parameters
id query Parameters
includeRole Responses
Response samples
{
}Change a user's global role
Authorizations:
path Parameters
id Request Body schema: application/json
newRoleName Responses
Request samples
{
}Generate an audit
Authorizations:
Request Body schema: application/json
Responses
Request samples
{
}
}
] Response samples
{
}
},
]
}
]
}
},
]
}
]
}
},
]
}
]
}
},
]
}
]
}
}
]
}
]
}Retrieve all executions
Authorizations:
query Parameters
includeData status workflowId projectId limit cursor Responses
Response samples
{
}
],
}Retrieve an execution
Authorizations:
path Parameters
id query Parameters
includeData Responses
Response samples
{
}Delete an execution
Authorizations:
path Parameters
id Responses
Response samples
{
}Create a workflow
Authorizations:
Request Body schema: application/json
name connections Responses
Request samples
{
}
],
}
],
},
}
}
},
]
}
},
} Response samples
{
}
],
}
],
},
},
}
},
]
}
},
},
]
}Retrieve all workflows
Authorizations:
query Parameters
active tags name projectId limit cursor Responses
Response samples
{
}
],
}
],
}
],
},
},
}
},
]
}
},
},
]
}Retrieves a workflow
Authorizations:
path Parameters
id Responses
Response samples
{
}
],
}
],
},
},
}
},
]
}
},
},
]
}Delete a workflow
Authorizations:
path Parameters
id Responses
Response samples
{
}
],
}
],
},
},
}
},
]
}
},
},
]
}Update a workflow
Authorizations:
path Parameters
id Request Body schema: application/json
name connections Responses
Request samples
{
}
],
}
],
},
}
}
},
]
}
},
} Response samples
{
}
],
}
],
},
},
}
},
]
}
},
},
]
}Activate a workflow
Authorizations:
path Parameters
id Responses
Response samples
{
}
],
}
],
},
},
}
},
]
}
},
},
]
}Deactivate a workflow
Authorizations:
path Parameters
id Responses
Response samples
{
}
],
}
],
},
},
}
},
]
}
},
},
]
}Transfer a workflow to another project.
Authorizations:
path Parameters
id Request Body schema: application/json
destinationProjectId Responses
Request samples
{
}Transfer a credential to another project.
Authorizations:
path Parameters
id Request Body schema: application/json
destinationProjectId Responses
Request samples
{
}Create a credential
Authorizations:
Request Body schema: application/json
name type data Responses
Request samples
{
}
} Response samples
{
}Delete credential by ID
Authorizations:
path Parameters
id Responses
Response samples
{
}Show credential data schema
Authorizations:
path Parameters
credentialTypeName Responses
Response samples
{
}
},
},
}
]Pull changes from the remote repository
Authorizations:
Request Body schema: application/json
force variables Responses
Request samples
{
}
} Response samples
{
}
},
],
]
],
}
],
}
}
],
}
]
}Retrieve variables
Authorizations:
query Parameters
limit cursor Responses
Response samples
{
}
],
}Retrieve projects
Authorizations:
query Parameters
limit cursor Responses
Response samples
{
}
],
}
ApiKeyAuth
number <= 250
Default: 100
Example: limit=100
string
boolean
Default: false
Example: includeRole=true
string
Example: projectId=VmwOO9HeTEj20kxM
Content type
application/json
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"email": "john.doe@company.com",
"firstName": "john",
"lastName": "Doe",
"isPending": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"role": "owner"
"nextCursor": "MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA"
ApiKeyAuth
required
Array
required
string <email>
string
Enum: "global:admin" "global:member"
Content type
application/json
{
"email": "user@example.com",
"role": "global:admin"
Content type
application/json
"user": {
"id": "string",
"email": "string",
"inviteAcceptUrl": "string",
"emailSent": true
"error": "string"
ApiKeyAuth
required
string <identifier>
boolean
Default: false
Example: includeRole=true
Content type
application/json
"id": "123e4567-e89b-12d3-a456-426614174000",
"email": "john.doe@company.com",
"firstName": "john",
"lastName": "Doe",
"isPending": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"role": "owner"
ApiKeyAuth
required
string <identifier>
required
required
string
Enum: "global:admin" "global:member"
Content type
application/json
"newRoleName": "global:admin"
ApiKeyAuth
optional
object
Content type
application/json
"additionalOptions": {
"daysAbandonedWorkflow": 0,
"categories": [
"credentials"
Content type
application/json
"Credentials Risk Report": {
"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": {
"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": {
"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": {
"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",
"Instance Risk Report": {
"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",
ApiKeyAuth
boolean
string
Enum: "error" "success" "waiting"
string
Example: workflowId=1000
string
Example: projectId=VmwOO9HeTEj20kxM
number <= 250
Default: 100
Example: limit=100
string
Content type
application/json
"data": [
{
"id": 1000,
"data": { },
"finished": true,
"mode": "cli",
"retryOf": 0,
"retrySuccessId": "2",
"startedAt": "2019-08-24T14:15:22Z",
"stoppedAt": "2019-08-24T14:15:22Z",
"workflowId": "1000",
"waitTill": "2019-08-24T14:15:22Z",
"customData": { }
"nextCursor": "MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA"
ApiKeyAuth
required
number
boolean
Content type
application/json
"id": 1000,
"data": { },
"finished": true,
"mode": "cli",
"retryOf": 0,
"retrySuccessId": "2",
"startedAt": "2019-08-24T14:15:22Z",
"stoppedAt": "2019-08-24T14:15:22Z",
"workflowId": "1000",
"waitTill": "2019-08-24T14:15:22Z",
"customData": { }
ApiKeyAuth
required
number
Content type
application/json
"id": 1000,
"data": { },
"finished": true,
"mode": "cli",
"retryOf": 0,
"retrySuccessId": "2",
"startedAt": "2019-08-24T14:15:22Z",
"stoppedAt": "2019-08-24T14:15:22Z",
"workflowId": "1000",
"waitTill": "2019-08-24T14:15:22Z",
"customData": { }
ApiKeyAuth
required
required
string
required
Array of objects (node)
required
object
required
object (workflowSettings)
(string or null) or (object or null)
Content type
application/json
"name": "Workflow 1",
"nodes": [
{
"id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
"name": "Jira",
"webhookId": "string",
"disabled": true,
"notesInFlow": true,
"notes": "string",
"type": "n8n-nodes-base.Jira",
"typeVersion": 1,
"executeOnce": false,
"alwaysOutputData": false,
"retryOnFail": false,
"maxTries": 0,
"waitBetweenTries": 0,
"continueOnFail": false,
"onError": "stopWorkflow",
"position": [
-100,
80
"parameters": {
"additionalProperties": { }
"credentials": {
"jiraSoftwareCloudApi": {
"id": "35",
"name": "jiraApi"
"connections": {
"main": [
{
"node": "Jira",
"type": "main",
"index": 0
"settings": {
"saveExecutionProgress": true,
"saveManualExecutions": true,
"saveDataErrorExecution": "all",
"saveDataSuccessExecution": "all",
"executionTimeout": 3600,
"errorWorkflow": "VzqKEW0ShTXA5vPj",
"timezone": "America/New_York",
"executionOrder": "v1"
"staticData": {
"lastId": 1
Content type
application/json
"id": "2tUt1wbLX592XDdX",
"name": "Workflow 1",
"active": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"nodes": [
{
"id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
"name": "Jira",
"webhookId": "string",
"disabled": true,
"notesInFlow": true,
"notes": "string",
"type": "n8n-nodes-base.Jira",
"typeVersion": 1,
"executeOnce": false,
"alwaysOutputData": false,
"retryOnFail": false,
"maxTries": 0,
"waitBetweenTries": 0,
"continueOnFail": false,
"onError": "stopWorkflow",
"position": [
-100,
80
"parameters": {
"additionalProperties": { }
"credentials": {
"jiraSoftwareCloudApi": {
"id": "35",
"name": "jiraApi"
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
"connections": {
"main": [
{
"node": "Jira",
"type": "main",
"index": 0
"settings": {
"saveExecutionProgress": true,
"saveManualExecutions": true,
"saveDataErrorExecution": "all",
"saveDataSuccessExecution": "all",
"executionTimeout": 3600,
"errorWorkflow": "VzqKEW0ShTXA5vPj",
"timezone": "America/New_York",
"executionOrder": "v1"
"staticData": {
"lastId": 1
"tags": [
{
"id": "2tUt1wbLX592XDdX",
"name": "Production",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
ApiKeyAuth
boolean
Example: active=true
string
Example: tags=test,production
string
Example: name=My Workflow
string
Example: projectId=VmwOO9HeTEj20kxM
number <= 250
Default: 100
Example: limit=100
string
Content type
application/json
"data": [
{
"id": "2tUt1wbLX592XDdX",
"name": "Workflow 1",
"active": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"nodes": [
{
"id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
"name": "Jira",
"webhookId": "string",
"disabled": true,
"notesInFlow": true,
"notes": "string",
"type": "n8n-nodes-base.Jira",
"typeVersion": 1,
"executeOnce": false,
"alwaysOutputData": false,
"retryOnFail": false,
"maxTries": 0,
"waitBetweenTries": 0,
"continueOnFail": false,
"onError": "stopWorkflow",
"position": [
-100,
80
"parameters": {
"additionalProperties": { }
"credentials": {
"jiraSoftwareCloudApi": {
"id": "35",
"name": "jiraApi"
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
"connections": {
"main": [
{
"node": "Jira",
"type": "main",
"index": 0
"settings": {
"saveExecutionProgress": true,
"saveManualExecutions": true,
"saveDataErrorExecution": "all",
"saveDataSuccessExecution": "all",
"executionTimeout": 3600,
"errorWorkflow": "VzqKEW0ShTXA5vPj",
"timezone": "America/New_York",
"executionOrder": "v1"
"staticData": {
"lastId": 1
"tags": [
{
"id": "2tUt1wbLX592XDdX",
"name": "Production",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
"nextCursor": "MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA"
ApiKeyAuth
required
string
Content type
application/json
"id": "2tUt1wbLX592XDdX",
"name": "Workflow 1",
"active": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"nodes": [
{
"id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
"name": "Jira",
"webhookId": "string",
"disabled": true,
"notesInFlow": true,
"notes": "string",
"type": "n8n-nodes-base.Jira",
"typeVersion": 1,
"executeOnce": false,
"alwaysOutputData": false,
"retryOnFail": false,
"maxTries": 0,
"waitBetweenTries": 0,
"continueOnFail": false,
"onError": "stopWorkflow",
"position": [
-100,
80
"parameters": {
"additionalProperties": { }
"credentials": {
"jiraSoftwareCloudApi": {
"id": "35",
"name": "jiraApi"
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
"connections": {
"main": [
{
"node": "Jira",
"type": "main",
"index": 0
"settings": {
"saveExecutionProgress": true,
"saveManualExecutions": true,
"saveDataErrorExecution": "all",
"saveDataSuccessExecution": "all",
"executionTimeout": 3600,
"errorWorkflow": "VzqKEW0ShTXA5vPj",
"timezone": "America/New_York",
"executionOrder": "v1"
"staticData": {
"lastId": 1
"tags": [
{
"id": "2tUt1wbLX592XDdX",
"name": "Production",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
ApiKeyAuth
required
string
Content type
application/json
"id": "2tUt1wbLX592XDdX",
"name": "Workflow 1",
"active": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"nodes": [
{
"id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
"name": "Jira",
"webhookId": "string",
"disabled": true,
"notesInFlow": true,
"notes": "string",
"type": "n8n-nodes-base.Jira",
"typeVersion": 1,
"executeOnce": false,
"alwaysOutputData": false,
"retryOnFail": false,
"maxTries": 0,
"waitBetweenTries": 0,
"continueOnFail": false,
"onError": "stopWorkflow",
"position": [
-100,
80
"parameters": {
"additionalProperties": { }
"credentials": {
"jiraSoftwareCloudApi": {
"id": "35",
"name": "jiraApi"
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
"connections": {
"main": [
{
"node": "Jira",
"type": "main",
"index": 0
"settings": {
"saveExecutionProgress": true,
"saveManualExecutions": true,
"saveDataErrorExecution": "all",
"saveDataSuccessExecution": "all",
"executionTimeout": 3600,
"errorWorkflow": "VzqKEW0ShTXA5vPj",
"timezone": "America/New_York",
"executionOrder": "v1"
"staticData": {
"lastId": 1
"tags": [
{
"id": "2tUt1wbLX592XDdX",
"name": "Production",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
ApiKeyAuth
required
string
required
required
string
required
Array of objects (node)
required
object
required
object (workflowSettings)
(string or null) or (object or null)
Content type
application/json
"name": "Workflow 1",
"nodes": [
{
"id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
"name": "Jira",
"webhookId": "string",
"disabled": true,
"notesInFlow": true,
"notes": "string",
"type": "n8n-nodes-base.Jira",
"typeVersion": 1,
"executeOnce": false,
"alwaysOutputData": false,
"retryOnFail": false,
"maxTries": 0,
"waitBetweenTries": 0,
"continueOnFail": false,
"onError": "stopWorkflow",
"position": [
-100,
80
"parameters": {
"additionalProperties": { }
"credentials": {
"jiraSoftwareCloudApi": {
"id": "35",
"name": "jiraApi"
"connections": {
"main": [
{
"node": "Jira",
"type": "main",
"index": 0
"settings": {
"saveExecutionProgress": true,
"saveManualExecutions": true,
"saveDataErrorExecution": "all",
"saveDataSuccessExecution": "all",
"executionTimeout": 3600,
"errorWorkflow": "VzqKEW0ShTXA5vPj",
"timezone": "America/New_York",
"executionOrder": "v1"
"staticData": {
"lastId": 1
Content type
application/json
"id": "2tUt1wbLX592XDdX",
"name": "Workflow 1",
"active": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"nodes": [
{
"id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
"name": "Jira",
"webhookId": "string",
"disabled": true,
"notesInFlow": true,
"notes": "string",
"type": "n8n-nodes-base.Jira",
"typeVersion": 1,
"executeOnce": false,
"alwaysOutputData": false,
"retryOnFail": false,
"maxTries": 0,
"waitBetweenTries": 0,
"continueOnFail": false,
"onError": "stopWorkflow",
"position": [
-100,
80
"parameters": {
"additionalProperties": { }
"credentials": {
"jiraSoftwareCloudApi": {
"id": "35",
"name": "jiraApi"
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
"connections": {
"main": [
{
"node": "Jira",
"type": "main",
"index": 0
"settings": {
"saveExecutionProgress": true,
"saveManualExecutions": true,
"saveDataErrorExecution": "all",
"saveDataSuccessExecution": "all",
"executionTimeout": 3600,
"errorWorkflow": "VzqKEW0ShTXA5vPj",
"timezone": "America/New_York",
"executionOrder": "v1"
"staticData": {
"lastId": 1
"tags": [
{
"id": "2tUt1wbLX592XDdX",
"name": "Production",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
ApiKeyAuth
required
string
Content type
application/json
"id": "2tUt1wbLX592XDdX",
"name": "Workflow 1",
"active": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"nodes": [
{
"id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
"name": "Jira",
"webhookId": "string",
"disabled": true,
"notesInFlow": true,
"notes": "string",
"type": "n8n-nodes-base.Jira",
"typeVersion": 1,
"executeOnce": false,
"alwaysOutputData": false,
"retryOnFail": false,
"maxTries": 0,
"waitBetweenTries": 0,
"continueOnFail": false,
"onError": "stopWorkflow",
"position": [
-100,
80
"parameters": {
"additionalProperties": { }
"credentials": {
"jiraSoftwareCloudApi": {
"id": "35",
"name": "jiraApi"
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
"connections": {
"main": [
{
"node": "Jira",
"type": "main",
"index": 0
"settings": {
"saveExecutionProgress": true,
"saveManualExecutions": true,
"saveDataErrorExecution": "all",
"saveDataSuccessExecution": "all",
"executionTimeout": 3600,
"errorWorkflow": "VzqKEW0ShTXA5vPj",
"timezone": "America/New_York",
"executionOrder": "v1"
"staticData": {
"lastId": 1
"tags": [
{
"id": "2tUt1wbLX592XDdX",
"name": "Production",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
ApiKeyAuth
required
string
Content type
application/json
"id": "2tUt1wbLX592XDdX",
"name": "Workflow 1",
"active": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"nodes": [
{
"id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
"name": "Jira",
"webhookId": "string",
"disabled": true,
"notesInFlow": true,
"notes": "string",
"type": "n8n-nodes-base.Jira",
"typeVersion": 1,
"executeOnce": false,
"alwaysOutputData": false,
"retryOnFail": false,
"maxTries": 0,
"waitBetweenTries": 0,
"continueOnFail": false,
"onError": "stopWorkflow",
"position": [
-100,
80
"parameters": {
"additionalProperties": { }
"credentials": {
"jiraSoftwareCloudApi": {
"id": "35",
"name": "jiraApi"
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
"connections": {
"main": [
{
"node": "Jira",
"type": "main",
"index": 0
"settings": {
"saveExecutionProgress": true,
"saveManualExecutions": true,
"saveDataErrorExecution": "all",
"saveDataSuccessExecution": "all",
"executionTimeout": 3600,
"errorWorkflow": "VzqKEW0ShTXA5vPj",
"timezone": "America/New_York",
"executionOrder": "v1"
"staticData": {
"lastId": 1
"tags": [
{
"id": "2tUt1wbLX592XDdX",
"name": "Production",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
ApiKeyAuth
required
string
required
required
string
Content type
application/json
"destinationProjectId": "string"
ApiKeyAuth
required
string
required
required
string
Content type
application/json
"destinationProjectId": "string"
ApiKeyAuth
required
required
string
required
string
required
object
Content type
application/json
"name": "Joe's Github Credentials",
"type": "github",
"data": {
"token": "ada612vad6fa5df4adf5a5dsf4389adsf76da7s"
Content type
application/json
"id": "R2DjclaysHbqn778",
"name": "Joe's Github Credentials",
"type": "github",
"createdAt": "2022-04-29T11:02:29.842Z",
"updatedAt": "2022-04-29T11:02:29.842Z"
ApiKeyAuth
required
string
Content type
application/json
"id": "R2DjclaysHbqn778",
"name": "Joe's Github Credentials",
"type": "github",
"createdAt": "2022-04-29T11:02:29.842Z",
"updatedAt": "2022-04-29T11:02:29.842Z"
ApiKeyAuth
required
string
Content type
application/json
Example
"additionalProperties": false,
"type": "object",
"properties": {
"apiKey": {
"type": "string"
"domain": {
"type": "string"
"required": [
"apiKey",
"domain"
ApiKeyAuth
required
boolean
object
Content type
application/json
"force": true,
"variables": {
"foo": "bar"
Content type
application/json
"variables": {
"added": [
"string"
"changed": [
"string"
"credentials": [
{
"id": "string",
"name": "string",
"type": "string"
"workflows": [
{
"id": "string",
"name": "string"
"tags": {
"tags": [
{
"id": "string",
"name": "string"
"mappings": [
{
"workflowId": "string",
"tagId": "string"
ApiKeyAuth
number <= 250
Default: 100
Example: limit=100
string
Content type
application/json
"data": [
{
"id": "string",
"key": "string",
"value": "test",
"type": "string"
"nextCursor": "MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA"
ApiKeyAuth
number <= 250
Default: 100
Example: limit=100
string
Content type
application/json
"data": [
{
"id": "string",
"name": "string",
"type": "string"
"nextCursor": "MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA"