@kestra-io/kestra-sdk

v1.0.10

Published

7 days ago

All API operations, except for Superadmin-only endpoints, require a tenant identifier in the HTTP path.<br/> Endpoints designated as Superadmin-only are not tenant-scoped.

Downloads

162

0High
0Medium
0Low

tchiotludo

yannc.kestra

@kestra-io/kestra-sdk

KestraIoKestraSdk - JavaScript client for @kestra-io/kestra-sdk All API operations, except for Superadmin-only endpoints, require a tenant identifier in the HTTP path. Endpoints designated as Superadmin-only are not tenant-scoped. This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.2.0
Package version: 1.0.10
Generator version: 7.16.0
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install @kestra-io/kestra-sdk --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your @kestra-io/kestra-sdk from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var KestraIoKestraSdk = require('@kestra-io/kestra-sdk');

var defaultClient = KestraIoKestraSdk.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'
// Configure Bearer (Bearer) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

var api = new KestraIoKestraSdk.ExecutionsApi()
var namespace = "namespace_example"; // {String} The flow namespace
var id = "id_example"; // {String} The flow id
var wait = false; // {Boolean} If the server will wait the end of the execution
var tenant = "tenant_example"; // {String} 
var opts = {
  'labels': ["null"], // {[String]} The labels as a list of 'key:value'
  'revision': 56, // {Number} The flow revision or latest if null
  'scheduleDate': new Date("2013-10-20T19:20:30+01:00"), // {Date} Schedule the flow on a specific date
  'breakpoints': "breakpoints_example", // {String} Set a list of breakpoints at specific tasks 'id.value', separated by a coma.
  'kind': new KestraIoKestraSdk.ExecutionKind() // {ExecutionKind} Specific execution kind
};
api.createExecution(namespace, id, wait, tenant, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- KestraIoKestraSdk.ExecutionsApi | createExecution | POST /api/v1/{tenant}/executions/{namespace}/{id} | Create a new execution for a flow KestraIoKestraSdk.ExecutionsApi | deleteExecution | DELETE /api/v1/{tenant}/executions/{executionId} | Delete an execution KestraIoKestraSdk.ExecutionsApi | deleteExecutionsByIds | DELETE /api/v1/{tenant}/executions/by-ids | Delete a list of executions KestraIoKestraSdk.ExecutionsApi | deleteExecutionsByQuery | DELETE /api/v1/{tenant}/executions/by-query | Delete executions filter by query parameters KestraIoKestraSdk.ExecutionsApi | downloadFileFromExecution | GET /api/v1/{tenant}/executions/{executionId}/file | Download file for an execution KestraIoKestraSdk.ExecutionsApi | execution | GET /api/v1/{tenant}/executions/{executionId} | Get an execution KestraIoKestraSdk.ExecutionsApi | executionFlowGraph | GET /api/v1/{tenant}/executions/{executionId}/graph | Generate a graph for an execution KestraIoKestraSdk.ExecutionsApi | exportExecutions | GET /api/v1/{tenant}/executions/export/by-query/csv | Export all executions as a streamed CSV file KestraIoKestraSdk.ExecutionsApi | fileMetadatasFromExecution | GET /api/v1/{tenant}/executions/{executionId}/file/metas | Get file meta information for an execution KestraIoKestraSdk.ExecutionsApi | flowFromExecution | GET /api/v1/{tenant}/executions/flows/{namespace}/{flowId} | Get flow information's for an execution KestraIoKestraSdk.ExecutionsApi | flowFromExecutionById | GET /api/v1/{tenant}/executions/{executionId}/flow | Get flow information's for an execution KestraIoKestraSdk.ExecutionsApi | followDependenciesExecutions | GET /api/v1/{tenant}/executions/{executionId}/follow-dependencies | Follow all execution dependencies executions KestraIoKestraSdk.ExecutionsApi | followExecution | GET /api/v1/{tenant}/executions/{executionId}/follow | Follow an execution KestraIoKestraSdk.ExecutionsApi | forceRunByIds | POST /api/v1/{tenant}/executions/force-run/by-ids | Force run a list of executions KestraIoKestraSdk.ExecutionsApi | forceRunExecution | POST /api/v1/{tenant}/executions/{executionId}/force-run | Force run an execution KestraIoKestraSdk.ExecutionsApi | forceRunExecutionsByQuery | POST /api/v1/{tenant}/executions/force-run/by-query | Force run executions filter by query parameters KestraIoKestraSdk.ExecutionsApi | killExecution | DELETE /api/v1/{tenant}/executions/{executionId}/kill | Kill an execution KestraIoKestraSdk.ExecutionsApi | killExecutionsByIds | DELETE /api/v1/{tenant}/executions/kill/by-ids | Kill a list of executions KestraIoKestraSdk.ExecutionsApi | killExecutionsByQuery | DELETE /api/v1/{tenant}/executions/kill/by-query | Kill executions filter by query parameters KestraIoKestraSdk.ExecutionsApi | latestExecutions | POST /api/v1/{tenant}/executions/latest | Get the latest execution for given flows KestraIoKestraSdk.ExecutionsApi | pauseExecution | POST /api/v1/{tenant}/executions/{executionId}/pause | Pause a running execution. KestraIoKestraSdk.ExecutionsApi | pauseExecutionsByIds | POST /api/v1/{tenant}/executions/pause/by-ids | Pause a list of running executions KestraIoKestraSdk.ExecutionsApi | pauseExecutionsByQuery | POST /api/v1/{tenant}/executions/pause/by-query | Pause executions filter by query parameters KestraIoKestraSdk.ExecutionsApi | replayExecution | POST /api/v1/{tenant}/executions/{executionId}/replay | Create a new execution from an old one and start it from a specified task run id KestraIoKestraSdk.ExecutionsApi | replayExecutionWithinputs | POST /api/v1/{tenant}/executions/{executionId}/replay-with-inputs | Create a new execution from an old one and start it from a specified task run id KestraIoKestraSdk.ExecutionsApi | replayExecutionsByIds | POST /api/v1/{tenant}/executions/replay/by-ids | Create new executions from old ones. Keep the flow revision KestraIoKestraSdk.ExecutionsApi | replayExecutionsByQuery | POST /api/v1/{tenant}/executions/replay/by-query | Create new executions from old ones filter by query parameters. Keep the flow revision KestraIoKestraSdk.ExecutionsApi | restartExecution | POST /api/v1/{tenant}/executions/{executionId}/restart | Restart a new execution from an old one KestraIoKestraSdk.ExecutionsApi | restartExecutionsByIds | POST /api/v1/{tenant}/executions/restart/by-ids | Restart a list of executions KestraIoKestraSdk.ExecutionsApi | restartExecutionsByQuery | POST /api/v1/{tenant}/executions/restart/by-query | Restart executions filter by query parameters KestraIoKestraSdk.ExecutionsApi | resumeExecution | POST /api/v1/{tenant}/executions/{executionId}/resume | Resume a paused execution. KestraIoKestraSdk.ExecutionsApi | resumeExecutionsByIds | POST /api/v1/{tenant}/executions/resume/by-ids | Resume a list of paused executions KestraIoKestraSdk.ExecutionsApi | resumeExecutionsByQuery | POST /api/v1/{tenant}/executions/resume/by-query | Resume executions filter by query parameters KestraIoKestraSdk.ExecutionsApi | searchExecutions | GET /api/v1/{tenant}/executions/search | Search for executions KestraIoKestraSdk.ExecutionsApi | searchExecutionsByFlowId | GET /api/v1/{tenant}/executions | Search for executions for a flow KestraIoKestraSdk.ExecutionsApi | setLabelsOnTerminatedExecution | POST /api/v1/{tenant}/executions/{executionId}/labels | Add or update labels of a terminated execution KestraIoKestraSdk.ExecutionsApi | setLabelsOnTerminatedExecutionsByIds | POST /api/v1/{tenant}/executions/labels/by-ids | Set labels on a list of executions KestraIoKestraSdk.ExecutionsApi | setLabelsOnTerminatedExecutionsByQuery | POST /api/v1/{tenant}/executions/labels/by-query | Set label on executions filter by query parameters KestraIoKestraSdk.ExecutionsApi | triggerExecutionByGetWebhook | GET /api/v1/{tenant}/executions/webhook/{namespace}/{id}/{key} | Trigger a new execution by GET webhook trigger KestraIoKestraSdk.ExecutionsApi | unqueueExecution | POST /api/v1/{tenant}/executions/{executionId}/unqueue | Unqueue an execution KestraIoKestraSdk.ExecutionsApi | unqueueExecutionsByIds | POST /api/v1/{tenant}/executions/unqueue/by-ids | Unqueue a list of executions KestraIoKestraSdk.ExecutionsApi | unqueueExecutionsByQuery | POST /api/v1/{tenant}/executions/unqueue/by-query | Unqueue executions filter by query parameters KestraIoKestraSdk.ExecutionsApi | updateExecutionStatus | POST /api/v1/{tenant}/executions/{executionId}/change-status | Change the state of an execution KestraIoKestraSdk.ExecutionsApi | updateExecutionsStatusByIds | POST /api/v1/{tenant}/executions/change-status/by-ids | Change executions state by id KestraIoKestraSdk.ExecutionsApi | updateExecutionsStatusByQuery | POST /api/v1/{tenant}/executions/change-status/by-query | Change executions state by query parameters KestraIoKestraSdk.ExecutionsApi | updateTaskRunState | POST /api/v1/{tenant}/executions/{executionId}/state | Change state for a taskrun in an execution KestraIoKestraSdk.FlowsApi | bulkUpdateFlows | POST /api/v1/{tenant}/flows/bulk | Update from multiples yaml sources KestraIoKestraSdk.FlowsApi | createFlow | POST /api/v1/{tenant}/flows | Create a flow from yaml source KestraIoKestraSdk.FlowsApi | deleteFlow | DELETE /api/v1/{tenant}/flows/{namespace}/{id} | Delete a flow KestraIoKestraSdk.FlowsApi | deleteFlowsByIds | DELETE /api/v1/{tenant}/flows/delete/by-ids | Delete flows by their IDs. KestraIoKestraSdk.FlowsApi | deleteFlowsByQuery | DELETE /api/v1/{tenant}/flows/delete/by-query | Delete flows returned by the query parameters. KestraIoKestraSdk.FlowsApi | deleteRevisions | DELETE /api/v1/{tenant}/flows/{namespace}/{id}/revisions | Delete revisions for a flow KestraIoKestraSdk.FlowsApi | disableFlowsByIds | POST /api/v1/{tenant}/flows/disable/by-ids | Disable flows by their IDs. KestraIoKestraSdk.FlowsApi | disableFlowsByQuery | POST /api/v1/{tenant}/flows/disable/by-query | Disable flows returned by the query parameters. KestraIoKestraSdk.FlowsApi | enableFlowsByIds | POST /api/v1/{tenant}/flows/enable/by-ids | Enable flows by their IDs. KestraIoKestraSdk.FlowsApi | enableFlowsByQuery | POST /api/v1/{tenant}/flows/enable/by-query | Enable flows returned by the query parameters. KestraIoKestraSdk.FlowsApi | exportFlows | GET /api/v1/{tenant}/flows/export/by-query/csv | Export all flows as a streamed CSV file KestraIoKestraSdk.FlowsApi | exportFlowsByIds | POST /api/v1/{tenant}/flows/export/by-ids | Export flows as a ZIP archive of yaml sources. KestraIoKestraSdk.FlowsApi | exportFlowsByQuery | GET /api/v1/{tenant}/flows/export/by-query | Export flows as a ZIP archive of yaml sources. KestraIoKestraSdk.FlowsApi | flow | GET /api/v1/{tenant}/flows/{namespace}/{id} | Get a flow KestraIoKestraSdk.FlowsApi | flowDependencies | GET /api/v1/{tenant}/flows/{namespace}/{id}/dependencies | Get flow dependencies KestraIoKestraSdk.FlowsApi | flowDependenciesFromNamespace | GET /api/v1/{tenant}/namespaces/{namespace}/dependencies | Retrieve flow dependencies KestraIoKestraSdk.FlowsApi | generateFlowGraph | GET /api/v1/{tenant}/flows/{namespace}/{id}/graph | Generate a graph for a flow KestraIoKestraSdk.FlowsApi | generateFlowGraphFromSource | POST /api/v1/{tenant}/flows/graph | Generate a graph for a flow source KestraIoKestraSdk.FlowsApi | importFlows | POST /api/v1/{tenant}/flows/import | Import flows as a ZIP archive of yaml sources or a multi-objects YAML file. When sending a Yaml that contains one or more flows, a list of index is returned. When sending a ZIP archive, a list of files that couldn't be imported is returned. KestraIoKestraSdk.FlowsApi | listDistinctNamespaces | GET /api/v1/{tenant}/flows/distinct-namespaces | List all distinct namespaces KestraIoKestraSdk.FlowsApi | listFlowRevisions | GET /api/v1/{tenant}/flows/{namespace}/{id}/revisions | Get revisions for a flow KestraIoKestraSdk.FlowsApi | listFlowsByNamespace | GET /api/v1/{tenant}/flows/{namespace} | Retrieve all flows from a given namespace KestraIoKestraSdk.FlowsApi | searchConcurrencyLimits | GET /api/v1/{tenant}/concurrency-limit/search | Search for flow concurrency limits KestraIoKestraSdk.FlowsApi | searchFlows | GET /api/v1/{tenant}/flows/search | Search for flows KestraIoKestraSdk.FlowsApi | searchFlowsBySourceCode | GET /api/v1/{tenant}/flows/source | Search for flows source code KestraIoKestraSdk.FlowsApi | taskFromFlow | GET /api/v1/{tenant}/flows/{namespace}/{id}/tasks/{taskId} | Get a flow task KestraIoKestraSdk.FlowsApi | updateConcurrencyLimit | PUT /api/v1/{tenant}/concurrency-limit/{namespace}/{flowId} | Update a flow concurrency limit KestraIoKestraSdk.FlowsApi | updateFlow | PUT /api/v1/{tenant}/flows/{namespace}/{id} | Update a flow KestraIoKestraSdk.FlowsApi | updateFlowsInNamespace | POST /api/v1/{tenant}/flows/{namespace} | Update a complete namespace from yaml source KestraIoKestraSdk.FlowsApi | updateTask | PATCH /api/v1/{tenant}/flows/{namespace}/{id}/{taskId} | Update a single task on a flow KestraIoKestraSdk.FlowsApi | validateFlows | POST /api/v1/{tenant}/flows/validate | Validate a list of flows KestraIoKestraSdk.FlowsApi | validateTask | POST /api/v1/{tenant}/flows/validate/task | Validate a task KestraIoKestraSdk.FlowsApi | validateTrigger | POST /api/v1/{tenant}/flows/validate/trigger | Validate trigger KestraIoKestraSdk.GroupsApi | addUserToGroup | PUT /api/v1/{tenant}/groups/{id}/members/{userId} | Add a user to a group KestraIoKestraSdk.GroupsApi | autocompleteGroups | POST /api/v1/{tenant}/groups/autocomplete | List groups for autocomplete KestraIoKestraSdk.GroupsApi | createGroup | POST /api/v1/{tenant}/groups | Create a group KestraIoKestraSdk.GroupsApi | deleteGroup | DELETE /api/v1/{tenant}/groups/{id} | Delete a group KestraIoKestraSdk.GroupsApi | deleteUserFromGroup | DELETE /api/v1/{tenant}/groups/{id}/members/{userId} | Remove a user from a group KestraIoKestraSdk.GroupsApi | group | GET /api/v1/{tenant}/groups/{id} | Retrieve a group KestraIoKestraSdk.GroupsApi | listGroupIds | POST /api/v1/{tenant}/groups/ids | List groups by ids KestraIoKestraSdk.GroupsApi | searchGroupMembers | GET /api/v1/{tenant}/groups/{id}/members | Search for users in a group KestraIoKestraSdk.GroupsApi | searchGroups | GET /api/v1/{tenant}/groups/search | Search for groups KestraIoKestraSdk.GroupsApi | setUserMembershipForGroup | PUT /api/v1/{tenant}/groups/{id}/members/membership/{userId} | Update a user's membership type in a group KestraIoKestraSdk.GroupsApi | updateGroup | PUT /api/v1/{tenant}/groups/{id} | Update a group KestraIoKestraSdk.KVApi | deleteKeyValue | DELETE /api/v1/{tenant}/namespaces/{namespace}/kv/{key} | Delete a key-value pair KestraIoKestraSdk.KVApi | deleteKeyValues | DELETE /api/v1/{tenant}/namespaces/{namespace}/kv | Bulk-delete multiple key/value pairs from the given namespace. KestraIoKestraSdk.KVApi | keyValue | GET /api/v1/{tenant}/namespaces/{namespace}/kv/{key} | Get value for a key KestraIoKestraSdk.KVApi | listAllKeys | GET /api/v1/{tenant}/kv | List all keys KestraIoKestraSdk.KVApi | listKeys | GET /api/v1/{tenant}/namespaces/{namespace}/kv | List all keys for a namespace KestraIoKestraSdk.KVApi | listKeysWithInheritence | GET /api/v1/{tenant}/namespaces/{namespace}/kv/inheritance | List all keys for inherited namespaces KestraIoKestraSdk.KVApi | setKeyValue | PUT /api/v1/{tenant}/namespaces/{namespace}/kv/{key} | Puts a key-value pair in store KestraIoKestraSdk.NamespacesApi | autocompleteNamespaces | POST /api/v1/{tenant}/namespaces/autocomplete | List namespaces for autocomplete KestraIoKestraSdk.NamespacesApi | createNamespace | POST /api/v1/{tenant}/namespaces | Create a namespace KestraIoKestraSdk.NamespacesApi | deleteNamespace | DELETE /api/v1/{tenant}/namespaces/{id} | Delete a namespace KestraIoKestraSdk.NamespacesApi | deleteSecret | DELETE /api/v1/{tenant}/namespaces/{namespace}/secrets/{key} | Delete a secret for a namespace KestraIoKestraSdk.NamespacesApi | inheritedPluginDefaults | GET /api/v1/{tenant}/namespaces/{id}/inherited-plugindefaults | List inherited plugin defaults KestraIoKestraSdk.NamespacesApi | inheritedSecrets | GET /api/v1/{tenant}/namespaces/{namespace}/inherited-secrets | List inherited secrets KestraIoKestraSdk.NamespacesApi | inheritedVariables | GET /api/v1/{tenant}/namespaces/{id}/inherited-variables | List inherited variables KestraIoKestraSdk.NamespacesApi | listNamespaceSecrets | GET /api/v1/{tenant}/namespaces/{namespace}/secrets | Get secrets for a namespace KestraIoKestraSdk.NamespacesApi | namespace | GET /api/v1/{tenant}/namespaces/{id} | Get a namespace KestraIoKestraSdk.NamespacesApi | patchSecret | PATCH /api/v1/{tenant}/namespaces/{namespace}/secrets/{key} | Patch a secret metadata for a namespace KestraIoKestraSdk.NamespacesApi | putSecrets | PUT /api/v1/{tenant}/namespaces/{namespace}/secrets | Update secrets for a namespace KestraIoKestraSdk.NamespacesApi | searchNamespaces | GET /api/v1/{tenant}/namespaces/search | Search for namespaces KestraIoKestraSdk.NamespacesApi | updateNamespace | PUT /api/v1/{tenant}/namespaces/{id} | Update a namespace KestraIoKestraSdk.RolesApi | autocompleteRoles | POST /api/v1/{tenant}/roles/autocomplete | List roles for autocomplete KestraIoKestraSdk.RolesApi | createRole | POST /api/v1/{tenant}/roles | Create a role KestraIoKestraSdk.RolesApi | deleteRole | DELETE /api/v1/{tenant}/roles/{id} | Delete a role KestraIoKestraSdk.RolesApi | listRolesFromGivenIds | POST /api/v1/{tenant}/roles/ids | List roles by ids KestraIoKestraSdk.RolesApi | role | GET /api/v1/{tenant}/roles/{id} | Retrieve a role KestraIoKestraSdk.RolesApi | searchRoles | GET /api/v1/{tenant}/roles/search | Search for roles KestraIoKestraSdk.RolesApi | updateRole | PUT /api/v1/{tenant}/roles/{id} | Update a role KestraIoKestraSdk.ServiceAccountApi | createApiTokensForServiceAccount | POST /api/v1/service-accounts/{id}/api-tokens | Create new API Token for a specific service account KestraIoKestraSdk.ServiceAccountApi | createApiTokensForServiceAccountWithTenant | POST /api/v1/{tenant}/service-accounts/{id}/api-tokens | Create new API Token for a specific service account KestraIoKestraSdk.ServiceAccountApi | createServiceAccount | POST /api/v1/service-accounts | Create a service account KestraIoKestraSdk.ServiceAccountApi | createServiceAccountForTenant | POST /api/v1/{tenant}/service-accounts | Create a service account for the given tenant KestraIoKestraSdk.ServiceAccountApi | deleteApiTokenForServiceAccount | DELETE /api/v1/service-accounts/{id}/api-tokens/{tokenId} | Delete an API Token for specific service account and token id KestraIoKestraSdk.ServiceAccountApi | deleteApiTokenForServiceAccountWithTenant | DELETE /api/v1/{tenant}/service-accounts/{id}/api-tokens/{tokenId} | Delete an API Token for specific service account and token id KestraIoKestraSdk.ServiceAccountApi | deleteServiceAccount | DELETE /api/v1/service-accounts/{id} | Delete a service account KestraIoKestraSdk.ServiceAccountApi | deleteServiceAccountForTenant | DELETE /api/v1/{tenant}/service-accounts/{id} | Delete a service account KestraIoKestraSdk.ServiceAccountApi | listApiTokensForServiceAccount | GET /api/v1/service-accounts/{id}/api-tokens | List API tokens for a specific service account KestraIoKestraSdk.ServiceAccountApi | listApiTokensForServiceAccountWithTenant | GET /api/v1/{tenant}/service-accounts/{id}/api-tokens | List API tokens for a specific service account KestraIoKestraSdk.ServiceAccountApi | listServiceAccounts | GET /api/v1/service-accounts | List service accounts. Superadmin-only. KestraIoKestraSdk.ServiceAccountApi | patchServiceAccountDetails | PATCH /api/v1/service-accounts/{id} | Update service account details KestraIoKestraSdk.ServiceAccountApi | patchServiceAccountSuperAdmin | PATCH /api/v1/service-accounts/{id}/superadmin | Update service account superadmin privileges KestraIoKestraSdk.ServiceAccountApi | serviceAccount | GET /api/v1/service-accounts/{id} | Get a service account KestraIoKestraSdk.ServiceAccountApi | serviceAccountForTenant | GET /api/v1/{tenant}/service-accounts/{id} | Retrieve a service account KestraIoKestraSdk.ServiceAccountApi | updateServiceAccount | PUT /api/v1/{tenant}/service-accounts/{id} | Update a user service account KestraIoKestraSdk.TestSuitesApi | createTestSuite | POST /api/v1/{tenant}/tests | Create a test from YAML source KestraIoKestraSdk.TestSuitesApi | deleteTestSuite | DELETE /api/v1/{tenant}/tests/{namespace}/{id} | Delete a test KestraIoKestraSdk.TestSuitesApi | deleteTestSuitesByIds | DELETE /api/v1/{tenant}/tests/by-ids | Delete multiple tests by id KestraIoKestraSdk.TestSuitesApi | disableTestSuitesByIds | POST /api/v1/{tenant}/tests/disable/by-ids | Disable multiple tests by id KestraIoKestraSdk.TestSuitesApi | enableTestSuitesByIds | POST /api/v1/{tenant}/tests/enable/by-ids | Enable multiple tests by id KestraIoKestraSdk.TestSuitesApi | runTestSuite | POST /api/v1/{tenant}/tests/{namespace}/{id}/run | Run a full test KestraIoKestraSdk.TestSuitesApi | runTestSuitesByQuery | POST /api/v1/{tenant}/tests/run | Run multiple TestSuites by query KestraIoKestraSdk.TestSuitesApi | searchTestSuites | GET /api/v1/{tenant}/tests/search | Search for tests KestraIoKestraSdk.TestSuitesApi | searchTestSuitesResults | GET /api/v1/{tenant}/tests/results/search | Search for tests results KestraIoKestraSdk.TestSuitesApi | testResult | GET /api/v1/{tenant}/tests/results/{id} | Get a test result KestraIoKestraSdk.TestSuitesApi | testSuite | GET /api/v1/{tenant}/tests/{namespace}/{id} | Retrieve a test KestraIoKestraSdk.TestSuitesApi | testsLastResult | POST /api/v1/{tenant}/tests/results/search/last | Get tests last result KestraIoKestraSdk.TestSuitesApi | updateTestSuite | PUT /api/v1/{tenant}/tests/{namespace}/{id} | Update a test from YAML source KestraIoKestraSdk.TestSuitesApi | validateTestSuite | POST /api/v1/{tenant}/tests/validate | Validate a test KestraIoKestraSdk.TriggersApi | deleteBackfill | POST /api/v1/{tenant}/triggers/backfill/delete | Delete a backfill KestraIoKestraSdk.TriggersApi | deleteBackfillByIds | POST /api/v1/{tenant}/triggers/backfill/delete/by-triggers | Delete backfill for given triggers KestraIoKestraSdk.TriggersApi | deleteBackfillByQuery | POST /api/v1/{tenant}/triggers/backfill/delete/by-query | Delete backfill for given triggers KestraIoKestraSdk.TriggersApi | deleteTrigger | DELETE /api/v1/{tenant}/triggers/{namespace}/{flowId}/{triggerId} | Delete a trigger KestraIoKestraSdk.TriggersApi | deleteTriggersByIds | DELETE /api/v1/{tenant}/triggers/delete/by-triggers | Delete given triggers KestraIoKestraSdk.TriggersApi | deleteTriggersByQuery | DELETE /api/v1/{tenant}/triggers/delete/by-query | Delete triggers by query parameters KestraIoKestraSdk.TriggersApi | disabledTriggersByIds | POST /api/v1/{tenant}/triggers/set-disabled/by-triggers | Disable/enable given triggers KestraIoKestraSdk.TriggersApi | disabledTriggersByQuery | POST /api/v1/{tenant}/triggers/set-disabled/by-query | Disable/enable triggers by query parameters KestraIoKestraSdk.TriggersApi | exportTriggers | GET /api/v1/{tenant}/triggers/export/by-query/csv | Export all triggers as a streamed CSV file KestraIoKestraSdk.TriggersApi | pauseBackfill | PUT /api/v1/{tenant}/triggers/backfill/pause | Pause a backfill KestraIoKestraSdk.TriggersApi | pauseBackfillByIds | POST /api/v1/{tenant}/triggers/backfill/pause/by-triggers | Pause backfill for given triggers KestraIoKestraSdk.TriggersApi | pauseBackfillByQuery | POST /api/v1/{tenant}/triggers/backfill/pause/by-query | Pause backfill for given triggers KestraIoKestraSdk.TriggersApi | restartTrigger | POST /api/v1/{tenant}/triggers/{namespace}/{flowId}/{triggerId}/restart | Restart a trigger KestraIoKestraSdk.TriggersApi | searchTriggers | GET /api/v1/{tenant}/triggers/search | Search for triggers KestraIoKestraSdk.TriggersApi | searchTriggersForFlow | GET /api/v1/{tenant}/triggers/{namespace}/{flowId} | Get all triggers for a flow KestraIoKestraSdk.TriggersApi | unlockTrigger | POST /api/v1/{tenant}/triggers/{namespace}/{flowId}/{triggerId}/unlock | Unlock a trigger KestraIoKestraSdk.TriggersApi | unlockTriggersByIds | POST /api/v1/{tenant}/triggers/unlock/by-triggers | Unlock given triggers KestraIoKestraSdk.TriggersApi | unlockTriggersByQuery | POST /api/v1/{tenant}/triggers/unlock/by-query | Unlock triggers by query parameters KestraIoKestraSdk.TriggersApi | unpauseBackfill | PUT /api/v1/{tenant}/triggers/backfill/unpause | Unpause a backfill KestraIoKestraSdk.TriggersApi | unpauseBackfillByIds | POST /api/v1/{tenant}/triggers/backfill/unpause/by-triggers | Unpause backfill for given triggers KestraIoKestraSdk.TriggersApi | unpauseBackfillByQuery | POST /api/v1/{tenant}/triggers/backfill/unpause/by-query | Unpause backfill for given triggers KestraIoKestraSdk.TriggersApi | updateTrigger | PUT /api/v1/{tenant}/triggers | Update a trigger KestraIoKestraSdk.UsersApi | autocompleteUsers | POST /api/v1/{tenant}/tenant-access/autocomplete | List users for autocomplete KestraIoKestraSdk.UsersApi | createApiTokensForUser | POST /api/v1/users/{id}/api-tokens | Create new API Token for a specific user KestraIoKestraSdk.UsersApi | createUser | POST /api/v1/users | Create a new user account KestraIoKestraSdk.UsersApi | deleteApiTokenForUser | DELETE /api/v1/users/{id}/api-tokens/{tokenId} | Delete an API Token for specific user and token id KestraIoKestraSdk.UsersApi | deleteRefreshToken | DELETE /api/v1/users/{id}/refresh-token | Delete a user refresh token KestraIoKestraSdk.UsersApi | deleteUser | DELETE /api/v1/users/{id} | Delete a user KestraIoKestraSdk.UsersApi | deleteUserAuthMethod | DELETE /api/v1/users/{id}/auths/{auth} | Update user password KestraIoKestraSdk.UsersApi | impersonate | POST /api/v1/users/{id}/impersonate | Impersonate a user KestraIoKestraSdk.UsersApi | listApiTokensForUser | GET /api/v1/users/{id}/api-tokens | List API tokens for a specific user KestraIoKestraSdk.UsersApi | listUsers | GET /api/v1/users | Retrieve users KestraIoKestraSdk.UsersApi | patchUser | PATCH /api/v1/users/{id} | Update user details KestraIoKestraSdk.UsersApi | patchUserDemo | PATCH /api/v1/users/{id}/restricted | Update user demo KestraIoKestraSdk.UsersApi | patchUserPassword | PATCH /api/v1/users/{id}/password | Update user password KestraIoKestraSdk.UsersApi | patchUserSuperAdmin | PATCH /api/v1/users/{id}/superadmin | Update user superadmin privileges KestraIoKestraSdk.UsersApi | updateCurrentUserPassword | PUT /api/v1/me/password | Update authenticated user password KestraIoKestraSdk.UsersApi | updateUser | PUT /api/v1/users/{id} | Update a user account KestraIoKestraSdk.UsersApi | updateUserGroups | PUT /api/v1/{tenant}/users/{id}/groups | Update the list of groups a user belongs to for the given tenant KestraIoKestraSdk.UsersApi | user | GET /api/v1/users/{id} | Get a user

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@kestra-io/kestra-sdk

Installation

For Node.js

npm

Local development

git

For browser

Webpack Configuration

Getting Started

Documentation for API Endpoints

Documentation for Models