Icon

Splunk Cloud Services (version v1.*.*)

Splunk Cloud Services REST API

activate_pipeline

Activates an existing pipeline.

Parameters

id (required)

id of the pipeline to activate

Type: string

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"skipRestoreState" : "Set to true to start reading from the latest input rather than from where the pipeline's previous run left off, which can cause data loss. Defaults to false.",
"activateLatestVersion" : "Set to true to activate the latest version of the pipeline. Set to false to use the previously activated version of the pipeline. Defaults to true.",
"allowNonRestoredState" : "Set to true to allow the pipeline to ignore any unused progress states. In some cases, when a data pipeline is changed, the progress state will be stored for functions that no longer exist, so this must be set to activate a pipeline in this state. Defaults to false."
}

add_certificate

Each tenant can have up to five certificates.

Parameters

tenant (required)

Type: string

$body

Type: object

{
"pem" : "string"
}

add_group_member

Adds a member to a given group.

Parameters

group (required)

The group name.

Type: string

tenant (required)

The tenant name.

Type: string

$body

The member to add to a group.

Type: object

{
"name" : "Required string"
}

add_group_role

Adds a role to a given group.

Parameters

group (required)

The group name.

Type: string

tenant (required)

The tenant name.

Type: string

$body

The role to add to a group.

Type: object

{
"name" : "Required string"
}

add_member

Adds a member to a given tenant.

Parameters

tenant (required)

The tenant name.

Type: string

$body

The member to associate with a tenant.

Type: object

{
"name" : "Required string"
}

add_role_permission

Adds permissions to a role in a given tenant.

Parameters

role (required)

The role name.

Type: string

tenant (required)

The tenant name.

Type: string

$body

The permission to add to a role.

Type: string

compile_dsl

Compiles the Streams DSL and returns Streams JSON.

Parameters

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"dsl" : "The Streams DSL representation of a pipeline."
}

compile_spl

Compiles SPL2 and returns Streams JSON.

Parameters

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"syntax" : "The parse parameters as arguments to this SPL2 command",
"spl" : "The SPL2 representation of a pipeline or function parameters."
}

create_action

Parameters

tenant (required)

The tenant name.

Type: string

$body

The action template to create.

Type: object

{
"createdAt" : "The date and time this action template was created (ISO-8601 date/time with zone).",
"updatedBy" : "The principal that updated this action template.",
"createdBy" : "The principal that created this action template.",
"kind" : "<type>",
"name" : "The name of the action, as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit.",
"updatedAt" : "The date and time this action template was updated (ISO-8601 date/time with zone).",
"addresses" : [ "email" ],
"subject" : "The subject of the email. You can use a template in this field.",
"members" : [ "string" ],
"fromName" : "Optional text providing a human-friendly name for the sender. Must be less than or equal to 81 characters. You can use a template in this field.",
"bodyPlainText" : "Optional text to send as the text/plain part of the email. If this field is not set for an email action, the Action service converts the value from the body field to text and sends that as the text/plain part when invoking the action. You can use a template in this field.",
"body" : "HTML content to send as the body of the email. You can use a template in this field.",
"title" : "A human-readable title for the action. Must be less than or equal to 128 characters."
}

create_action_for_rule

Create a new action for a rule associated with a specific resource name.

Parameters

ruleresourcename (required)

The resource name of a rule. For the default module, the resource name format is ruleName. Otherwise, the resource name format is module.ruleName.

Type: string

tenant (required)

The tenant name.

Type: string

$body

The JSON representation of the action to be persisted.

Type: object

{
"id" : "A unique action ID.",
"ruleid" : "The rule that this action is part of.",
"version" : "The catalog version.",
"field" : "The name of the field to be aliased.",
"kind" : "<type>",
"alias" : "The alias name."
}

create_action_for_rule_by_id

Create a new action for a specific rule.

Parameters

ruleid (required)

ID of a Field.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

$body

The JSON representation of the action to be persisted.

Type: object

{
"id" : "A unique action ID.",
"ruleid" : "The rule that this action is part of.",
"version" : "The catalog version.",
"field" : "The name of the field to be aliased.",
"kind" : "<type>",
"alias" : "The alias name."
}

create_annotation_for_dashboard_by_id

Create a new annotation for a specific dashboard.

Parameters

dashboardid (required)

ID of a dashboard.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

$body

The JSON representation of the annotation to be persisted.

Type: object

{
"dashboardid" : "The dashboard ID.",
"datasetid" : "The dataset ID. Null if not annotating a dataset.",
"annotationtypeid" : "The annotation type ID.",
"relationshipid" : "The relationship ID. Null if not annotating a relationship.",
"fieldid" : "The field ID. Null if not annotating a field.",
"annotationtyperesourcename" : "Resource name of the annotation type",
"id" : "A unique annotation ID. If not specified, an auto generated ID is created."
}

create_annotation_for_dashboards_by_resource_name

Create a new annotation for a specific dataset.

Parameters

dashboardresourcename (required)

The resource name of a dashvboard. The resource name format is module.dashboardname.

Type: string

tenant (required)

The tenant name.

Type: string

$body

The JSON representation of the annotation to be persisted.

Type: object

{
"dashboardid" : "The dashboard ID.",
"datasetid" : "The dataset ID. Null if not annotating a dataset.",
"annotationtypeid" : "The annotation type ID.",
"relationshipid" : "The relationship ID. Null if not annotating a relationship.",
"fieldid" : "The field ID. Null if not annotating a field.",
"annotationtyperesourcename" : "Resource name of the annotation type",
"id" : "A unique annotation ID. If not specified, an auto generated ID is created."
}

create_annotation_for_dataset_by_id

Create a new annotation for a specific dataset.

Parameters

datasetid (required)

ID of a Dataset.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

$body

The JSON representation of the annotation to be persisted.

Type: object

{
"dashboardid" : "The dashboard ID.",
"datasetid" : "The dataset ID. Null if not annotating a dataset.",
"annotationtypeid" : "The annotation type ID.",
"relationshipid" : "The relationship ID. Null if not annotating a relationship.",
"fieldid" : "The field ID. Null if not annotating a field.",
"annotationtyperesourcename" : "Resource name of the annotation type",
"id" : "A unique annotation ID. If not specified, an auto generated ID is created."
}

create_annotation_for_dataset_by_resource_name

Create a new annotation for a specific dataset.

Parameters

datasetresourcename (required)

The resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.

Type: string

tenant (required)

The tenant name.

Type: string

$body

The JSON representation of the annotation to be persisted.

Type: object

{
"dashboardid" : "The dashboard ID.",
"datasetid" : "The dataset ID. Null if not annotating a dataset.",
"annotationtypeid" : "The annotation type ID.",
"relationshipid" : "The relationship ID. Null if not annotating a relationship.",
"fieldid" : "The field ID. Null if not annotating a field.",
"annotationtyperesourcename" : "Resource name of the annotation type",
"id" : "A unique annotation ID. If not specified, an auto generated ID is created."
}

create_app

Creates an app.

Parameters

tenant (required)

The tenant name.

Type: string

$body

Creates a new app.

Type: object

{
"kind" : "Required string. Possible values: web | native | service",
"name" : "App name that is unique within Splunk Cloud Platform.",
"appPrincipalPermissions" : [ "string" ],
"loginUrl" : "The URL used to log in to the app.",
"description" : "Short paragraph describing the app.",
"title" : "Human-readable title for the app.",
"logoUrl" : "The URL used to display the app's logo.",
"userPermissionsFilter" : [ "string" ],
"setupUrl" : "URL to redirect to after a subscription is created.",
"redirectUrls" : [ "uri" ],
"webhookUrl" : "URL that webhook events are sent to."
}

create_connection

Create a new DSP connection.

Parameters

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"data" : { },
"connectorId" : "The ID of the parent connector.",
"name" : "The name of the connection.",
"description" : "The description of the connection."
}

create_dashboard

Create a new dashboard.

Parameters

tenant (required)

The tenant name.

Type: string

$body

The JSON representation of the Dashboard to be persisted.

Type: object

{
"id" : "A unique dashboard ID. Random ID used if not provided.",
"isactive" : "Whether the dashboard is active or not.",
"module" : "The module that contains the dashboard.",
"name" : "The dashboard name. Dashboard names must be unique within each tenant.",
"definition" : "The JSON dashboard definition.",
"version" : "The version of the dashboard."
}

create_dataset

Create a new dataset.

Parameters

tenant (required)

The tenant name.

Type: string

$body

JSON representation of the DatasetInfo to be persisted

Type: object

{
"filter" : "A query that filters results out of the lookup before those results are returned.",
"caseSensitiveMatch" : "Match case-sensitively against the lookup.",
"kind" : "<type>",
"externalName" : "The name of the external lookup.",
"externalKind" : "The type of the external lookup.",
"module" : "The name of the module to create the new dataset in.",
"name" : "The dataset name. Dataset names must be unique within each module.",
"id" : "A unique dataset ID. Random ID used if not provided.",
"fields" : [ {
"summary" : "The field summary.",
"prevalence" : "How frequent the field appears in the dataset. Must be one of the valid values.",
"datatype" : "The type of data in the field. Must be one of the valid values.",
"indexed" : "Whether or not the field has been indexed.",
"name" : "The field name.",
"description" : "The field description.",
"fieldtype" : "The type of field. Must be one of the valid values.",
"title" : "The field title."
} ]
}

create_dataset_import

Create a new dataset import.

Parameters

datasetresourcename (required)

The resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.

Type: string

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"owner" : "The dataset owner.",
"module" : "The module that is importing the dataset.",
"name" : "The dataset name."
}

create_dataset_import_by_id

Create a new dataset import.

Parameters

datasetid (required)

ID of a Dataset.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"owner" : "The dataset owner.",
"module" : "The module that is importing the dataset.",
"name" : "The dataset name."
}

create_dataset_import_by_idv1

Create a new dataset import.

Parameters

datasetid (required)

ID of a Dataset.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"owner" : "The dataset owner.",
"module" : "The module that is importing the dataset.",
"name" : "The dataset name."
}

create_dataset_importv1

Create a new dataset import.

Parameters

datasetresourcename (required)

The resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.

Type: string

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"owner" : "The dataset owner.",
"module" : "The module that is importing the dataset.",
"name" : "The dataset name."
}

create_field_for_dataset

Create a new field on a specific dataset.

Parameters

datasetresourcename (required)

The resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.

Type: string

tenant (required)

The tenant name.

Type: string

$body

The JSON representation of the field to be persisted.

Type: object

{
"summary" : "The field summary.",
"prevalence" : "How frequent the field appears in the dataset. Must be one of the valid values.",
"datatype" : "The type of data in the field. Must be one of the valid values.",
"indexed" : "Whether or not the field has been indexed.",
"name" : "The field name.",
"description" : "The field description.",
"fieldtype" : "The type of field. Must be one of the valid values.",
"title" : "The field title."
}

create_field_for_dataset_by_id

Add a new field to a dataset.

Parameters

datasetid (required)

ID of a Dataset.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

$body

The JSON representation of the field to be persisted.

Type: object

{
"summary" : "The field summary.",
"prevalence" : "How frequent the field appears in the dataset. Must be one of the valid values.",
"datatype" : "The type of data in the field. Must be one of the valid values.",
"indexed" : "Whether or not the field has been indexed.",
"name" : "The field name.",
"description" : "The field description.",
"fieldtype" : "The type of field. Must be one of the valid values.",
"title" : "The field title."
}

create_group

Creates a new group in a given tenant.

Parameters

tenant (required)

The tenant name.

Type: string

$body

The group definition.

Type: object

{
"name" : "Required string"
}

create_group_function

Create a new group function by combining the Streams JSON of two or more functions.

Parameters

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"mappings" : [ {
"functionId" : "The function id to map to a group function argument.",
"arguments" : [ {
"functionArg" : "Function argument name.",
"groupArg" : "The argument name for your group function."
} ]
} ],
"scalar" : "boolean",
"ast" : {
"nodes" : [ {
"op" : "The function's ID or its API name",
"attributes" : { },
"id" : "The function's (node's) UUID",
"resolvedId" : "string"
} ],
"edges" : [ {
"sourcePort" : "The source function's (node's) port",
"sourceNode" : "The source function's (node's) id",
"attributes" : { },
"targetNode" : "The target function's (node's) id",
"targetPort" : "The target function's (node's) port"
} ],
"rootNode" : [ "string" ]
},
"name" : "The group function name.",
"outputType" : "The data type of the function's output.",
"arguments" : [ {
"groupArg" : "The argument name for your group function.",
"position" : "Group function argument position number.",
"type" : "The group function's data type."
} ],
"attributes" : { },
"categories" : [ "integer" ],
"variadic" : "boolean"
}

create_index

Parameters

collection (required)

The name of the collection.

Type: string

tenant (required)

The tenant id.

Type: string

$body

Type: object

{
"name" : "The name of the index.",
"fields" : [ {
"field" : "The name of the field to index.",
"direction" : "The sort direction for the indexed field."
} ]
}

create_invite

Creates an invitation for a person to join the tenant using their email address.

Parameters

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"groups" : [ "string" ],
"comment" : "string",
"email" : "Required email"
}

create_job

Creates a search job.

Parameters

tenant (required)

The tenant name.

Type: string

$body

A fully-constructed search job, including read-only fields.

Type: object

{
"maxTime" : "The number of seconds to run the search before finalizing the search. The maximum value is 21600 seconds (6 hours).\n",
"enablePreview" : "Specified whether a search is allowed to collect preview results during the run time.\n",
"module" : "The module to run the search in. The default module is used if a module is not specified.",
"query" : "The SPL search string.",
"extractAllFields" : "Specifies whether the Search service should extract all of the available fields in the data, including fields not mentioned in the SPL for the search job. Set to 'false' for better search peformance.\n",
"allowSideEffects" : { },
"resolvedLatest" : "The latest time specified as an absolute value in GMT. The time is computed based on the values you specify for the 'timezone' and 'earliest' queryParameters.\n",
"resolvedEarliest" : "The earliest time speciifed as an absolute value in GMT. The time is computed based on the values you specify for the 'timezone' and 'earliest' queryParameters.\n",
"percentComplete" : "An estimate of the percent of time remaining before the job completes.",
"collectFieldSummary" : "Specified whether a search is allowed to collect Fields summary during the run time.\n",
"requiredFreshness" : "Specifies a maximum time interval, in seconds, between identical existing searches. The 'requiredFreshness' parameter is used to determine if an existing search with the same query and the same time boundaries can be reused, instead of running the same search again. Freshness is applied to the resolvedEarliest and resolvedLatest parameters. If an existing search has the same exact criteria as this search and the resolvedEarliest and resolvedLatest values are within the freshness interval, the existing search metadata is returned instead of initiating a new search job. By default, the requiredFreshness parameter is set to 0 which means that the platform does not attempt to use an existing search.\n",
"sid" : "The ID assigned to the search job.",
"collectTimeBuckets" : "Specified whether a search is allowed to collect Timeline Buckets summary during the run time.\n",
"completionTime" : "The time, in GMT, that the search job is finished. Empty if the search job has not completed.\n",
"dispatchTime" : "The time, in GMT, that the search job is dispatched.\n",
"queryParameters" : {
"timezone" : { },
"relativeTimeAnchor" : "Relative values for the 'earliest' and 'latest' parameters snap to the unit that you specify. For example, if 'earliest' is set to -d@d, the unit is day. If the 'relativeTimeAnchor' is is set to '1994-11-05T13:15:30Z' then 'resolvedEarliest' is snapped to '1994-11-05T00:00:00Z', which is the day. Hours, minutes, and seconds are dropped. If no 'relativeTimeAnchor' is specified, the default value is set to the time the search job was created.\n",
"earliest" : "The earliest time, in absolute or relative format, to retrieve events. When specifying an absolute time specify either UNIX time, or UTC in seconds using the ISO-8601 (%FT%T.%Q) format. For example 2019-01-25T13:15:30Z. GMT is the default timezone. You must specify GMT when you specify UTC. Any offset specified is ignored.\n",
"latest" : "The latest time, in absolute or relative format, to retrieve events. When specifying an absolute time specify either UNIX time, or UTC in seconds using the ISO-8601 (%FT%T.%Q) format. For example 2019-01-25T13:15:30Z. GMT is the default timezone. You must specify GMT when you specify UTC. Any offset specified is ignored.\n"
},
"collectEventSummary" : "Specified whether a search is allowed to collect events summary during the run time.\n",
"name" : "The name of the created search job.",
"resultsPreviewAvailable" : "The number of the preview search results for the job with the specified search ID (SID)",
"messages" : [ {
"text" : "string",
"type" : "string. Possible values: INFO | DEBUG | FATAL | ERROR"
} ],
"previewAvailable" : "Specifies if preview results for the search job are available. The valid status values are 'unknown', 'true', and 'false'.",
"resultsAvailable" : "The number of results produced so far for the search job.",
"status" : "The current status of the search job. The valid status values are 'running', 'done', 'canceled', and 'failed'.\n"
}

create_m_l_workflow_run

Parameters

buildId (required)

The workflow build ID.

Type: string

id (required)

The workflow ID.

Type: string

tenant (required)

The tenant name.

Type: string

$body

Input data used to build the workflow.

Type: object

{
"owner" : "The name of the workflow run's owner.",
"created" : "The date and time the workflow run was created.",
"description" : "The description of the workflow run.",
"started" : "The date and time the workflow build started.",
"workflowbuildversion" : "The version of the workflow build that is associated with the workflow run.",
"timeoutsecs" : "The timeout in seconds of the workflow.",
"inputdata" : [ "string" ],
"outputdata" : [ "string" ],
"workflowbuildid" : "A unique workflow build ID that is associated with the workflow run.",
"createdby" : "The name of the user who created the workflow run. This value is obtained from the bearer token and may not be changed.",
"ended" : "The date and time the workflow build ended.",
"name" : "The workflow run name.",
"failuremessage" : "The failure message of the workflow run.",
"id" : "A unique workflow Run ID.",
"status" : "The status of the workflow run."
}

create_ml_workflow

Parameters

tenant (required)

The tenant name.

Type: string

$body

Workflow configuration to be created.

Type: object

{
"created" : "The date and time object was created.",
"modified" : "The date and time object was modified.",
"owner" : "The name of the object's owner.",
"createdby" : "The name of the user who created the object. This value is obtained from the bearer token and may not be changed.",
"modifiedby" : "The name of the user who most recently modified the object.",
"name" : "The workflow name. Workflow names must be unique within each tenant.",
"description" : "The workflow description.",
"experimentid" : "A unique experiment ID that is associated with the workflow.",
"id" : "A unique workflow ID.",
"version" : "The version of the workflow.",
"tasks" : [ {
"created" : "The date and time object was created.",
"modified" : "The date and time object was modified.",
"owner" : "The name of the object's owner.",
"createdby" : "The name of the user who created the object. This value is obtained from the bearer token and may not be changed.",
"modifiedby" : "The name of the user who most recently modified the object.",
"outputtransformer" : "The output transformer of the task.",
"tasktype" : "The task type.",
"timeoutsecs" : "The timeout secs of the task.",
"evaluation" : [ "string" ],
"workflowversion" : "The version of the workflow that is associated with the task.",
"features" : [ "string" ],
"children" : [ "A unique task ID." ],
"name" : "The task name.",
"targetfeature" : "The target feature of the task.",
"id" : "A unique task ID.",
"parameters" : "The task parameters.",
"workflowid" : "A unique workflow ID that is associatd with the task.",
"algorithm" : "The task algorithm name.",
"parents" : [ "A unique task ID." ]
} ]
}

create_ml_workflow_build

Parameters

id (required)

The workflow ID.

Type: string

tenant (required)

The tenant name.

Type: string

$body

Input data used to build the workflow.

Type: object

{
"created" : "The date and time object was created.",
"modified" : "The date and time object was modified.",
"owner" : "The name of the object's owner.",
"createdby" : "The name of the user who created the object. This value is obtained from the bearer token and may not be changed.",
"modifiedby" : "The name of the user who most recently modified the object.",
"traintestsplit" : "The train test split of the workflow build.",
"evaluationresults" : [ "string" ],
"description" : "The description of the workflow build.",
"randomstate" : "The random state of the workflow build.",
"started" : "The date and time the workflow build started.",
"stratified" : "Whether data is stratified.",
"version" : "The version of the workflow.",
"timeoutsecs" : "The timeout in seconds of the workflow.",
"workflowversion" : "The version of the workflow that is associated with the workflow build.",
"inputdata" : [ "string" ],
"outputdata" : [ "string" ],
"validationkind" : "The type of validation.",
"ended" : "The date and time the workflow build ended.",
"name" : "The workflow build name.",
"failuremessage" : "The failure message of the workflow build.",
"id" : "A unique workflow build ID.",
"workflowid" : "A unique workflow ID that is associated with the workflow build.",
"kfold" : "The number of kfold when the validation type if CrossValidation.",
"status" : "The status of the workflow build."
}

create_pipeline

Creates a pipeline.

Parameters

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"data" : {
"nodes" : [ {
"op" : "The function's ID or its API name",
"attributes" : { },
"id" : "The function's (node's) UUID",
"resolvedId" : "string"
} ],
"edges" : [ {
"sourcePort" : "The source function's (node's) port",
"sourceNode" : "The source function's (node's) id",
"attributes" : { },
"targetNode" : "The target function's (node's) id",
"targetPort" : "The target function's (node's) port"
} ],
"rootNode" : [ "string" ]
},
"name" : "The name of the pipeline.",
"description" : "The description of the pipeline. Defaults to null.",
"bypassValidation" : "Set to true to bypass initial pipeline validation upon creation. The pipeline still needs to be validated before activation. Defaults to false."
}

create_provision_job

Creates a new job that provisions a new tenant and subscribes apps to the tenant.

Parameters

$body

Type: object

{
"tenant" : "string",
"apps" : [ "string" ]
}

create_relationship

Create a new relationship.

Parameters

tenant (required)

The tenant name.

Type: string

$body

The JSON representation of the relationship to persist.

Type: object

{
"sourceid" : "A unique source dataset ID. Either the sourceid or sourceresourcename property must be specified.",
"targetid" : "A unique target dataset ID. Either the targetid or targetresourcename property must be specified.",
"kind" : "The relationship type. Must be one of the valid values.",
"module" : "The module that contains the relationship.",
"name" : "The relationship name.",
"sourceresourcename" : "The source dataset name qualified by module name. Either the sourceid or sourceresourcename property must be specified.",
"targetresourcename" : "The target dataset name qualified by module name. Either the targetid or targetresourcename property must be specified.",
"version" : "The Catalog version.",
"id" : "A unique relationship ID. If not specified, an auto generated ID is created.",
"fields" : [ {
"sourceid" : "A unique source dataset ID.",
"targetid" : "A unique target dataset ID.",
"kind" : "The type of match between the fields. Must be one of the valid values. The LATEST_BEFORE match type specifies that the datetime field in one dataset binds to the latest time before the datetime field in another dataset.",
"relationshipid" : "A unique relationship ID."
} ]
}

create_role

Creates a new authorization role in a given tenant.

Parameters

tenant (required)

The tenant name.

Type: string

$body

Role definition

Type: object

{
"name" : "Required string"
}

create_rule

Create a new rule.

Parameters

tenant (required)

The tenant name.

Type: string

$body

The JSON representation of the rule to be persisted.

Type: object

{
"module" : "The module containing the rule.",
"match" : "The rule match type.",
"name" : "The rule name.",
"version" : "The catalog version.",
"id" : "A unique rule ID. The newly created rule object will use this ID value if provided.",
"actions" : [ {
"id" : "A unique action ID.",
"ruleid" : "The rule that this action is part of.",
"version" : "The catalog version.",
"field" : "The name of the field to be aliased.",
"kind" : "<type>",
"alias" : "The alias name."
} ]
}

create_subscription

Creates a subscription.

Parameters

tenant (required)

The tenant name.

Type: string

$body

Creates a subscription between a tenant and an app.

Type: object

{
"appName" : "Required string"
}

create_template

Creates a template for a tenant.

Parameters

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"data" : {
"nodes" : [ {
"op" : "The function's ID or its API name",
"attributes" : { },
"id" : "The function's (node's) UUID",
"resolvedId" : "string"
} ],
"edges" : [ {
"sourcePort" : "The source function's (node's) port",
"sourceNode" : "The source function's (node's) id",
"attributes" : { },
"targetNode" : "The target function's (node's) id",
"targetPort" : "The target function's (node's) port"
} ],
"rootNode" : [ "string" ]
},
"name" : "Template name",
"description" : "Template description"
}

create_workflow

Create a new workflow configuration.

Parameters

tenant (required)

The tenant name.

Type: string

$body

The JSON representation of the workflow to be persisted.

Type: object

{
"name" : "The dataset name. Dataset names must be unique within each module.",
"description" : "The workflow description.",
"experimentid" : "A unique experiment ID that is associate with the workflow.",
"id" : "A unique workflow ID. Random ID used if not provided.",
"version" : "The version of the workflow.",
"tasks" : [ {
"created" : "The date and time object was created.",
"modified" : "The date and time object was modified.",
"owner" : "The name of the object's owner.",
"createdby" : "The name of the user who created the object. This value is obtained from the bearer token and may not be changed.",
"modifiedby" : "The name of the user who most recently modified the object.",
"outputtransformer" : "The output transformer of the task.",
"tasktype" : "The task type.",
"timeoutsecs" : "The timeout secs of the task.",
"evaluation" : [ "string" ],
"workflowversion" : "The version of the workflow that is associated with the task.",
"features" : [ "string" ],
"children" : [ "A unique task ID." ],
"name" : "The task name.",
"targetfeature" : "The target feature of the task.",
"id" : "A unique task ID.",
"parameters" : "The task parameters.",
"workflowid" : "A unique workflow ID that is associated with the task.",
"algorithm" : "The task algorithm name.",
"parents" : [ "A unique task ID." ]
} ]
}

create_workflow_build

Create a new workflow build.

Parameters

tenant (required)

The tenant name.

Type: string

workflowid (required)

ID of a workflow.

Type: mongo-object-id

$body

The JSON representation of the workflow build to be persisted.

Type: object

{
"traintestsplit" : "The train test split of the workflow build.",
"evaluationresults" : [ "string" ],
"description" : "The description of the workflow build.",
"randomstate" : "The random state of the workflow build.",
"started" : "The date and time the workflow build started.",
"version" : "The version of the workflow.",
"timeoutsecs" : "The timeout in seconds of the workflow.",
"workflowversion" : "The version of the workflow that is associated with the workflow build.",
"inputdata" : [ "string" ],
"outputdata" : [ "string" ],
"ended" : "The date and time the workflow build ended.",
"name" : "The workflow build name.",
"failuremessage" : "The failure message of the workflow build.",
"id" : "A unique workflow build ID.",
"workflowid" : "A unique workflow ID that is associated with the workflow build.",
"status" : "The status of the workflow build."
}

create_workflow_deployment

Parameters

buildId (required)

The workflow build ID.

Type: string

id (required)

The workflow ID.

Type: string

tenant (required)

The tenant name.

Type: string

$body

Input data used to build the workflow deployment.

Type: object

{
"creationTime" : "date-time",
"workflowBuild" : {
"created" : "The date and time object was created.",
"modified" : "The date and time object was modified.",
"owner" : "The name of the object's owner.",
"createdby" : "The name of the user who created the object. This value is obtained from the bearer token and may not be changed.",
"modifiedby" : "The name of the user who most recently modified the object.",
"traintestsplit" : "The train test split of the workflow build.",
"evaluationresults" : [ "string" ],
"description" : "The description of the workflow build.",
"randomstate" : "The random state of the workflow build.",
"started" : "The date and time the workflow build started.",
"stratified" : "Whether data is stratified.",
"version" : "The version of the workflow.",
"timeoutsecs" : "The timeout in seconds of the workflow.",
"workflowversion" : "The version of the workflow that is associated with the workflow build.",
"inputdata" : [ "string" ],
"outputdata" : [ "string" ],
"validationkind" : "The type of validation.",
"ended" : "The date and time the workflow build ended.",
"name" : "The workflow build name.",
"failuremessage" : "The failure message of the workflow build.",
"id" : "A unique workflow build ID.",
"workflowid" : "A unique workflow ID that is associated with the workflow build.",
"kfold" : "The number of kfold when the validation type if CrossValidation.",
"status" : "The status of the workflow build."
},
"name" : "string",
"startTime" : "date-time",
"endTime" : "date-time",
"id" : "string",
"spec" : {
"cpuLimit" : "CPU Resource limit for each container in a deployment.",
"replicas" : "Create replicated pods in a deployment.",
"memoryRequest" : "Memory Resource limit for serving requests.",
"memoryLimit" : "Memory Resource limit for each container in a deployment.",
"cpuRequest" : "CPU Resource limit for serving requests."
},
"status" : { }
}

create_workflow_inference

Parameters

buildId (required)

The workflow build ID.

Type: string

deploymentId (required)

The workflow deployment ID.

Type: string

id (required)

The workflow ID.

Type: string

tenant (required)

The tenant name.

Type: string

$body

Input data to the inference request.

Type: object

{
"output" : "string",
"input" : "Required string"
}

create_workflow_run

Create a new workflow run for the specified workflow build ID.

Parameters

tenant (required)

The tenant name.

Type: string

workflowbuildid (required)

ID of a workflow build.

Type: mongo-object-id

workflowid (required)

ID of a workflow.

Type: mongo-object-id

$body

The JSON representation of the workflow run to be persisted.

Type: object

{
"inputdata" : [ "string" ],
"outputdata" : [ "string" ],
"workflowbuildid" : "A unique workflow build ID that is associated with the workflow run.",
"ended" : "The date and time the workflow run ended for specified workflow build ID.",
"name" : "The workflow run name.",
"description" : "The description of the workflow run.",
"failuremessage" : "The failure message of the workflow run for specified workflow build ID.",
"started" : "The date and time the workflow run started for specified workflow build ID.",
"workflowbuildversion" : "The version of the workflow build that is assocaited with the workflow run.",
"id" : "A unique workflow Run ID.",
"timeoutsecs" : "The timeout in seconds of the workflow run for specified workflow build ID.",
"status" : "The status of the workflow run for specified workflow build ID."
}

create_workflow_stream_deployment

Parameters

buildId (required)

The workflow build ID.

Type: string

id (required)

The workflow ID.

Type: string

tenant (required)

The tenant name.

Type: string

$body

Configuration for the workflow streaming deployment.

Type: object

{
"output" : {
"kind" : { },
"destination" : {
"topic" : "Required string"
}
},
"input" : {
"kind" : { },
"source" : {
"topic" : "Required string",
"offsetReset" : "string. Possible values: earliest | latest"
}
},
"creationTime" : "date-time",
"workflowBuild" : {
"created" : "The date and time object was created.",
"modified" : "The date and time object was modified.",
"owner" : "The name of the object's owner.",
"createdby" : "The name of the user who created the object. This value is obtained from the bearer token and may not be changed.",
"modifiedby" : "The name of the user who most recently modified the object.",
"traintestsplit" : "The train test split of the workflow build.",
"evaluationresults" : [ "string" ],
"description" : "The description of the workflow build.",
"randomstate" : "The random state of the workflow build.",
"started" : "The date and time the workflow build started.",
"stratified" : "Whether data is stratified.",
"version" : "The version of the workflow.",
"timeoutsecs" : "The timeout in seconds of the workflow.",
"workflowversion" : "The version of the workflow that is associated with the workflow build.",
"inputdata" : [ "string" ],
"outputdata" : [ "string" ],
"validationkind" : "The type of validation.",
"ended" : "The date and time the workflow build ended.",
"name" : "The workflow build name.",
"failuremessage" : "The failure message of the workflow build.",
"id" : "A unique workflow build ID.",
"workflowid" : "A unique workflow ID that is associated with the workflow build.",
"kfold" : "The number of kfold when the validation type if CrossValidation.",
"status" : "The status of the workflow build."
},
"name" : "string",
"startTime" : "date-time",
"endTime" : "date-time",
"id" : "string",
"spec" : {
"cpuLimit" : "CPU Resource limit for each container in a deployment.",
"replicas" : "Create replicated pods in a deployment.",
"memoryRequest" : "Memory Resource limit for serving requests.",
"memoryLimit" : "Memory Resource limit for each container in a deployment.",
"cpuRequest" : "CPU Resource limit for serving requests."
},
"status" : { }
}

deactivate_pipeline

Deactivates an existing pipeline.

Parameters

id (required)

id of the pipeline to deactivate

Type: string

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"skipSavepoint" : "Set to true to skip saving the state of a deactivated pipeline. When the pipeline is later activated, it will start with the newest data and skip any data that arrived after this deactivation, which can cause data loss. Defaults to false."
}

delete_action

Parameters

action_name (required)

The name of the action as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit.

Type: string

tenant (required)

The tenant name.

Type: string

delete_action_by_id_for_rule

Delete an action on a rule.

Parameters

actionid (required)

ID of an Action.

Type: mongo-object-id

ruleresourcename (required)

The resource name of a rule. For the default module, the resource name format is ruleName. Otherwise, the resource name format is module.ruleName.

Type: string

tenant (required)

The tenant name.

Type: string

delete_action_by_id_for_rule_by_id

Delete an action that is part of a specific rule.

Parameters

actionid (required)

ID of an Action.

Type: mongo-object-id

ruleid (required)

ID of a Field.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

delete_annotation_of_dashboard_by_id

Delete a specific annotation of a dashboard.

Parameters

annotationid (required)

ID of a annotation.

Type: mongo-object-id

dashboardid (required)

ID of a dashboard.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

delete_annotation_of_dashboard_by_resource_name

Delete a specific annotation of a dashboard.

Parameters

annotationid (required)

ID of a annotation.

Type: mongo-object-id

dashboardresourcename (required)

The resource name of a dashvboard. The resource name format is module.dashboardname.

Type: string

tenant (required)

The tenant name.

Type: string

delete_annotation_of_dataset_by_id

Delete a specific annotation of a dataset.

Parameters

annotationid (required)

ID of a annotation.

Type: mongo-object-id

datasetid (required)

ID of a Dataset.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

delete_annotation_of_dataset_by_resource_name

Delete a specific annotation of a dataset.

Parameters

annotationid (required)

ID of a annotation.

Type: mongo-object-id

datasetresourcename (required)

The resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.

Type: string

tenant (required)

The tenant name.

Type: string

delete_app

Removes an app.

Parameters

appName (required)

App name.

Type: string

tenant (required)

The tenant name.

Type: string

delete_certificate

Parameters

slot (required)

Type: string

tenant (required)

Type: string

delete_certificates

Parameters

tenant (required)

Type: string

delete_connection

Delete all versions of a connection by its id.

Parameters

connectionId (required)

ID of the connection

Type: string

tenant (required)

The tenant name.

Type: string

delete_dashboard_by_id

Delete the dashboard with the specified ID.

Parameters

dashboardid (required)

ID of a dashboard.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

delete_dashboard_by_resource_name

Delete the dashboard with the specified resource name.

Parameters

dashboardresourcename (required)

The resource name of a dashvboard. The resource name format is module.dashboardname.

Type: string

tenant (required)

The tenant name.

Type: string

delete_dataset

Delete the dataset with the specified resource name, along with its dependencies. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.

Parameters

datasetresourcename (required)

The resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.

Type: string

tenant (required)

The tenant name.

Type: string

delete_dataset_by_id

Delete a specific dataset. Deleting a dataset also deletes its dependent objects, such as fields.

Parameters

datasetid (required)

ID of a Dataset.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

delete_field_by_id_for_dataset

Delete a field that is part of a specific dataset.

Parameters

datasetresourcename (required)

The resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.

Type: string

fieldid (required)

ID of a Field.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

delete_field_by_id_for_dataset_by_id

Delete a field that is part of a specific dataset.

Parameters

datasetid (required)

ID of a Dataset.

Type: mongo-object-id

fieldid (required)

ID of a Field.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

delete_group

Deletes a group in a given tenant.

Parameters

group (required)

The group name.

Type: string

tenant (required)

The tenant name.

Type: string

delete_group_function

Removes an existing group.

Parameters

groupId (required)

The group function's ID from the function registry

Type: string

tenant (required)

The tenant name.

Type: string

delete_index

Parameters

collection (required)

The name of the collection.

Type: string

index (required)

The name of the index.

Type: string

tenant (required)

The tenant id.

Type: string

delete_invite

Removes an invitation in the given tenant.

Parameters

inviteId (required)

Type: string

tenant (required)

The tenant name.

Type: string

delete_pipeline

Removes a pipeline.

Parameters

id (required)

id of the pipeline to delete

Type: string

tenant (required)

The tenant name.

Type: string

delete_record_by_key

Parameters

collection (required)

The name of the collection.

Type: string

key (required)

The key of the record.

Type: string

tenant (required)

The tenant id.

Type: string

delete_records

Parameters

collection (required)

The name of the collection.

Type: string

tenant (required)

The tenant id.

Type: string

query

Query JSON expression.

Type: string

delete_relationship_by_id

Delete a specific relationship. Deleting a relationship also deleletes any objects that are dependents of that relationship, such as relationship fields.

Parameters

relationshipid (required)

ID of a relationship.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

delete_role

Deletes a defined role for a given tenant.

Parameters

role (required)

The role name.

Type: string

tenant (required)

The tenant name.

Type: string

delete_rule

Delete the rule with the specified resource name and its dependencies.

Parameters

ruleresourcename (required)

The resource name of a rule. For the default module, the resource name format is ruleName. Otherwise, the resource name format is module.ruleName.

Type: string

tenant (required)

The tenant name.

Type: string

delete_rule_by_id

Delete a specific rule. Deleting a rule also deleletes any objects that are dependents of that rule, such as rule actions.

Parameters

ruleid (required)

ID of a Field.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

delete_subscription

Removes a subscription.

Parameters

appName (required)

App name.

Type: string

tenant (required)

The tenant name.

Type: string

delete_template

Removes a template with a specific ID.

Parameters

templateId (required)

ID of the template to delete

Type: string

tenant (required)

The tenant name.

Type: string

delete_workflow

Parameters

id (required)

The workflow ID.

Type: string

tenant (required)

The tenant name.

Type: string

delete_workflow_build

Parameters

buildId (required)

The workflow build ID.

Type: string

id (required)

The workflow ID.

Type: string

tenant (required)

The tenant name.

Type: string

delete_workflow_build_by_id

Delete the workflow build with the specified workflow build ID.

Parameters

tenant (required)

The tenant name.

Type: string

workflowbuildid (required)

ID of a workflow build.

Type: mongo-object-id

workflowid (required)

ID of a workflow.

Type: mongo-object-id

delete_workflow_by_id

Delete the workflow with the specified workflow ID.

Parameters

tenant (required)

The tenant name.

Type: string

workflowid (required)

ID of a workflow.

Type: mongo-object-id

delete_workflow_deployment

Parameters

buildId (required)

The workflow build ID.

Type: string

deploymentId (required)

The workflow deployment ID.

Type: string

id (required)

The workflow ID.

Type: string

tenant (required)

The tenant name.

Type: string

delete_workflow_run

Parameters

buildId (required)

The workflow build ID.

Type: string

id (required)

The workflow ID.

Type: string

runId (required)

The workflow run ID.

Type: string

tenant (required)

The tenant name.

Type: string

delete_workflow_run_by_id

Delete the workflow run with the specified workflow run ID.

Parameters

tenant (required)

The tenant name.

Type: string

workflowbuildid (required)

ID of a workflow build.

Type: mongo-object-id

workflowid (required)

ID of a workflow.

Type: mongo-object-id

workflowrunid (required)

ID of a workflow run.

Type: mongo-object-id

delete_workflow_stream_deployment

Parameters

buildId (required)

The workflow build ID.

Type: string

id (required)

The workflow ID.

Type: string

streamDeploymentId (required)

The workflow streaming deployment ID.

Type: string

tenant (required)

The tenant name.

Type: string

expand_group

Creates and returns the expanded version of a group.

Parameters

groupId (required)

The group function's ID from the function registry

Type: string

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"arguments" : { },
"id" : "The ID associated with your group function in the pipeline Streams JSON"
}

expand_pipeline

Returns the entire Streams JSON, including the expanded Streams JSON of any group functions in the pipeline.

Parameters

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"nodes" : [ {
"op" : "The function's ID or its API name",
"attributes" : { },
"id" : "The function's (node's) UUID",
"resolvedId" : "string"
} ],
"edges" : [ {
"sourcePort" : "The source function's (node's) port",
"sourceNode" : "The source function's (node's) id",
"attributes" : { },
"targetNode" : "The target function's (node's) id",
"targetPort" : "The target function's (node's) port"
} ],
"rootNode" : [ "string" ]
}

get_action

Parameters

action_name (required)

The name of the action as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit.

Type: string

tenant (required)

The tenant name.

Type: string

get_action_by_id_for_rule

Return an action that is part of a specified rule.

Parameters

actionid (required)

ID of an Action.

Type: mongo-object-id

ruleresourcename (required)

The resource name of a rule. For the default module, the resource name format is ruleName. Otherwise, the resource name format is module.ruleName.

Type: string

tenant (required)

The tenant name.

Type: string

get_action_by_id_for_rule_by_id

Return information about an action that is part of a specific rule.

Parameters

actionid (required)

ID of an Action.

Type: mongo-object-id

ruleid (required)

ID of a Field.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

get_action_status

Parameters

action_name (required)

The name of the action as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit.

Type: string

status_id (required)

The ID of the action status.

Type: string

tenant (required)

The tenant name.

Type: string

get_action_status_details

Parameters

action_name (required)

The name of the action as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit.

Type: string

status_id (required)

The ID of the action status.

Type: string

tenant (required)

The tenant name.

Type: string

get_app

Returns the metadata of an app.

Parameters

appName (required)

App name.

Type: string

tenant (required)

The tenant name.

Type: string

get_dashboard_by_id

Return information about a dashboard with the specified ID.

Parameters

dashboardid (required)

ID of a dashboard.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

get_dashboard_by_resource_name

Return information about a dashboard with the specified resource name.

Parameters

dashboardresourcename (required)

The resource name of a dashvboard. The resource name format is module.dashboardname.

Type: string

tenant (required)

The tenant name.

Type: string

get_dataset

Return the dataset with the specified resource name. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.

Parameters

datasetresourcename (required)

The resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.

Type: string

tenant (required)

The tenant name.

Type: string

maxstale

The number of seconds beyond which we will refresh index metadata.

Type: integer

get_dataset_by_id

Return information about the dataset with the specified ID.

Parameters

datasetid (required)

ID of a Dataset.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

maxstale

The number of seconds beyond which we will refresh index metadata.

Type: integer

get_field_by_id

Get a field that corresponds to a specific field ID.

Parameters

fieldid (required)

ID of a Field.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

get_field_by_id_for_dataset

Return a field that is part of a specific dataset.

Parameters

datasetresourcename (required)

The resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.

Type: string

fieldid (required)

ID of a Field.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

get_field_by_id_for_dataset_by_id

Return a field that is part of a specific dataset.

Parameters

datasetid (required)

ID of a Dataset.

Type: mongo-object-id

fieldid (required)

ID of a Field.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

get_group

Returns information about a given group within a tenant.

Parameters

group (required)

The group name.

Type: string

tenant (required)

The tenant name.

Type: string

get_group_function

Returns the full Streams JSON of a group.

Parameters

groupId (required)

The group function's ID from the function registry

Type: string

tenant (required)

The tenant name.

Type: string

get_group_member

Returns information about a given member within a given group.

Parameters

group (required)

The group name.

Type: string

member (required)

The member name.

Type: string

tenant (required)

The tenant name.

Type: string

get_group_role

Returns information about a given role within a given group.

Parameters

group (required)

The group name.

Type: string

role (required)

The role name.

Type: string

tenant (required)

The tenant name.

Type: string

get_input_schema

Returns the input schema for a function in a pipeline.

Parameters

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"uplJson" : {
"nodes" : [ {
"op" : "The function's ID or its API name",
"attributes" : { },
"id" : "The function's (node's) UUID",
"resolvedId" : "string"
} ],
"edges" : [ {
"sourcePort" : "The source function's (node's) port",
"sourceNode" : "The source function's (node's) id",
"attributes" : { },
"targetNode" : "The target function's (node's) id",
"targetPort" : "The target function's (node's) port"
} ],
"rootNode" : [ "string" ]
},
"nodeUuid" : "The function ID.",
"targetPortName" : "The name of the input port."
}

get_invite

Returns an invitation in the given tenant.

Parameters

inviteId (required)

Type: string

tenant (required)

The tenant name.

Type: string

get_job

Return the search job with the specified search ID (SID).

Parameters

sid (required)

The search ID.

Type: string

tenant (required)

The tenant name.

Type: string

get_keys

Returns a list of the public keys used for verifying signed webhook requests.

This operation has no parameters

get_member

Returns a member of a given tenant.

Parameters

member (required)

The member name.

Type: string

tenant (required)

The tenant name.

Type: string

get_output_schema

Returns the output schema for a specified function in a pipeline. If no function ID is specified, the request returns the output schema for all functions in a pipeline.

Parameters

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"uplJson" : {
"nodes" : [ {
"op" : "The function's ID or its API name",
"attributes" : { },
"id" : "The function's (node's) UUID",
"resolvedId" : "string"
} ],
"edges" : [ {
"sourcePort" : "The source function's (node's) port",
"sourceNode" : "The source function's (node's) id",
"attributes" : { },
"targetNode" : "The target function's (node's) id",
"targetPort" : "The target function's (node's) port"
} ],
"rootNode" : [ "string" ]
},
"sourcePortName" : "The name of the output port. Deprecated.",
"nodeUuid" : "The function ID. If omitted, returns the output schema for all functions."
}

get_pipeline

Returns an individual pipeline by version.

Parameters

id (required)

id of the pipeline to get

Type: string

tenant (required)

The tenant name.

Type: string

version

version

Type: string

get_pipeline_latest_metrics

Returns the latest metrics for a single pipeline.

Parameters

id (required)

ID of the pipeline to get metrics for

Type: string

tenant (required)

The tenant name.

Type: string

get_pipelines_status

Returns the status of pipelines from the underlying streaming system.

Parameters

tenant (required)

The tenant name.

Type: string

activated

activated

Type: boolean

createUserId

createUserId

Type: string

name

name

Type: string

sortDir

sortDir

Type: string

sortField

sortField

Type: string

get_preview_data

Returns the preview data for a session.

Parameters

previewSessionId (required)

ID of the preview session

Type: string

tenant (required)

The tenant name.

Type: string

get_preview_session

Returns information from a preview session.

Parameters

previewSessionId (required)

ID of the preview session

Type: string

tenant (required)

The tenant name.

Type: string

get_preview_session_latest_metrics

Returns the latest metrics for a preview session.

Parameters

previewSessionId (required)

ID of the preview session

Type: string

tenant (required)

The tenant name.

Type: string

get_principal

Returns the details of a principal, including its tenant membership.

Parameters

principal (required)

The principal name.

Type: string

get_provision_job

Returns details of a specific provision job.

Parameters

jobId (required)

Type: string

get_public_webhook_keys

This operation has no parameters

get_record_by_key

Parameters

collection (required)

The name of the collection.

Type: string

key (required)

The key of the record.

Type: string

tenant (required)

The tenant id.

Type: string

get_registry

Returns all functions in JSON format.

Parameters

tenant (required)

The tenant name.

Type: string

local

local

Type: boolean

get_relationship_by_id

Get a specific relationship.

Parameters

relationshipid (required)

ID of a relationship.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

get_role

Returns a role for a given tenant.

Parameters

role (required)

The role name.

Type: string

tenant (required)

The tenant name.

Type: string

get_role_permission

Gets a permission for the specified role.

Parameters

permission (required)

The permission string.

Type: string

role (required)

The role name.

Type: string

tenant (required)

The tenant name.

Type: string

get_rule

Get a rule with a specified resource name.

Parameters

ruleresourcename (required)

The resource name of a rule. For the default module, the resource name format is ruleName. Otherwise, the resource name format is module.ruleName.

Type: string

tenant (required)

The tenant name.

Type: string

get_rule_by_id

Get information about a specific rule.

Parameters

ruleid (required)

ID of a Field.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

get_subscription

Returns or validates a subscription.

Parameters

appName (required)

App name.

Type: string

tenant (required)

The tenant name.

Type: string

get_template

Returns an individual template by version.

Parameters

templateId (required)

ID of the template

Type: string

tenant (required)

The tenant name.

Type: string

version

version of the template

Type: integer

get_tenant

Returns a specific tenant.

Parameters

tenant (required)

The tenant name.

Type: string

get_workflow

Parameters

id (required)

The workflow ID.

Type: string

tenant (required)

The tenant name.

Type: string

get_workflow_build

Parameters

buildId (required)

The workflow build ID.

Type: string

id (required)

The workflow ID.

Type: string

tenant (required)

The tenant name.

Type: string

get_workflow_build_by_id

Return information about the workflow build with the specified workflow build ID.

Parameters

tenant (required)

The tenant name.

Type: string

workflowbuildid (required)

ID of a workflow build.

Type: mongo-object-id

workflowid (required)

ID of a workflow.

Type: mongo-object-id

get_workflow_build_error

Parameters

buildId (required)

The workflow build ID.

Type: string

id (required)

The workflow ID.

Type: string

tenant (required)

The tenant name.

Type: string

get_workflow_build_log

Parameters

buildId (required)

The workflow build ID.

Type: string

id (required)

The workflow ID.

Type: string

tenant (required)

The tenant name.

Type: string

get_workflow_by_id

Return information about a workflow with the specified workflow ID.

Parameters

tenant (required)

The tenant name.

Type: string

workflowid (required)

ID of a workflow.

Type: mongo-object-id

get_workflow_deployment

Parameters

buildId (required)

The workflow build ID.

Type: string

deploymentId (required)

The workflow deployment ID.

Type: string

id (required)

The workflow ID.

Type: string

tenant (required)

The tenant name.

Type: string

get_workflow_deployment_error

Parameters

buildId (required)

The workflow build ID.

Type: string

deploymentId (required)

The workflow deployment ID.

Type: string

id (required)

The workflow ID.

Type: string

tenant (required)

The tenant name.

Type: string

get_workflow_deployment_log

Parameters

buildId (required)

The workflow build ID.

Type: string

deploymentId (required)

The workflow deployment ID.

Type: string

id (required)

The workflow ID.

Type: string

tenant (required)

The tenant name.

Type: string

get_workflow_run

Parameters

buildId (required)

The workflow build ID.

Type: string

id (required)

The workflow ID.

Type: string

runId (required)

The workflow run ID.

Type: string

tenant (required)

The tenant name.

Type: string

get_workflow_run_by_id

Return information about the workflow run with the specified workflow build ID.

Parameters

tenant (required)

The tenant name.

Type: string

workflowbuildid (required)

ID of a workflow build.

Type: mongo-object-id

workflowid (required)

ID of a workflow.

Type: mongo-object-id

workflowrunid (required)

ID of a workflow run.

Type: mongo-object-id

get_workflow_run_error

Parameters

buildId (required)

The workflow build ID.

Type: string

id (required)

The workflow ID.

Type: string

runId (required)

The workflow run ID.

Type: string

tenant (required)

The tenant name.

Type: string

get_workflow_run_log

Parameters

buildId (required)

The workflow build ID.

Type: string

id (required)

The workflow ID.

Type: string

runId (required)

The workflow run ID.

Type: string

tenant (required)

The tenant name.

Type: string

get_workflow_stream_deployment

Parameters

buildId (required)

The workflow build ID.

Type: string

id (required)

The workflow ID.

Type: string

streamDeploymentId (required)

The workflow streaming deployment ID.

Type: string

tenant (required)

The tenant name.

Type: string

insert_record

Parameters

collection (required)

The name of the collection.

Type: string

tenant (required)

The tenant id.

Type: string

$body

Record to add to the collection, formatted as a JSON object.

Type: object

{ }

insert_records

Parameters

collection (required)

The name of the collection.

Type: string

tenant (required)

The tenant id.

Type: string

$body

Array of records to insert.

Type: array

[ { } ]

list_actions

Parameters

tenant (required)

The tenant name.

Type: string

list_actions_for_rule

Return the list of actions that are part of a specified rule.

Parameters

ruleresourcename (required)

The resource name of a rule. For the default module, the resource name format is ruleName. Otherwise, the resource name format is module.ruleName.

Type: string

tenant (required)

The tenant name.

Type: string

count

The maximum number of results to return.

Type: integer

filter

A filter to apply to the results list. The filter must be a SPL predicate expression.

Type: spl-predicate-expression

offset

The number of results to skip before the first one returned.

Type: integer

orderby

A list of fields to order the results by. You can specify either ascending or descending order using " asc" or " desc. Ascending order is the default.

Type: array

[ "string" ]

list_actions_for_rule_by_id

Return the set of actions that are part of a rule.

Parameters

ruleid (required)

ID of a Field.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

count

The maximum number of results to return.

Type: integer

filter

A filter to apply to the results list. The filter must be a SPL predicate expression.

Type: spl-predicate-expression

offset

The number of results to skip before the first one returned.

Type: integer

orderby

A list of fields to order the results by. You can specify either ascending or descending order using " asc" or " desc. Ascending order is the default.

Type: array

[ "string" ]

list_annotations

Return the set of annotations across all objects.

Parameters

tenant (required)

The tenant name.

Type: string

count

The maximum number of results to return.

Type: integer

filter

A filter to apply to the results list. The filter must be a SPL predicate expression.

Type: spl-predicate-expression

offset

The number of results to skip before the first one returned.

Type: integer

orderby

A list of fields to order the results by. You can specify either ascending or descending order using " asc" or " desc. Ascending order is the default.

Type: array

[ "string" ]

list_annotations_for_dashboard_by_id

Return the set of annotations that are part of a dashboard.

Parameters

dashboardid (required)

ID of a dashboard.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

filter

A filter query to apply to the annotations.

Type: spl-predicate-expression

list_annotations_for_dashboard_by_resource_name

Return the set of annotations that are part of a dashboard.

Parameters

dashboardresourcename (required)

The resource name of a dashvboard. The resource name format is module.dashboardname.

Type: string

tenant (required)

The tenant name.

Type: string

filter

A filter query to apply to the annotations.

Type: spl-predicate-expression

list_annotations_for_dataset_by_id

Return the set of annotations that are part of a dataset.

Parameters

datasetid (required)

ID of a Dataset.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

count

The maximum number of results to return.

Type: integer

filter

A filter to apply to the results list. The filter must be a SPL predicate expression.

Type: spl-predicate-expression

offset

The number of results to skip before the first one returned.

Type: integer

orderby

A list of fields to order the results by. You can specify either ascending or descending order using " asc" or " desc. Ascending order is the default.

Type: array

[ "string" ]

list_annotations_for_dataset_by_resource_name

Return the set of annotations that are part of a dataset.

Parameters

datasetresourcename (required)

The resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.

Type: string

tenant (required)

The tenant name.

Type: string

count

The maximum number of results to return.

Type: integer

filter

A filter to apply to the results list. The filter must be a SPL predicate expression.

Type: spl-predicate-expression

offset

The number of results to skip before the first one returned.

Type: integer

orderby

A list of fields to order the results by. You can specify either ascending or descending order using " asc" or " desc. Ascending order is the default.

Type: array

[ "string" ]

list_app_subscriptions

Returns the collection of subscriptions to an app.

Parameters

appName (required)

App name.

Type: string

tenant (required)

The tenant name.

Type: string

list_apps

Returns a list of apps.

Parameters

tenant (required)

The tenant name.

Type: string

list_certificates

Parameters

tenant (required)

Type: string

list_connections

Returns a list of connections (latest versions only) by tenant ID.

Parameters

tenant (required)

The tenant name.

Type: string

connectorId

Type: string

createUserId

Type: string

functionId

Type: string

name

Type: string

showSecretNames

Type: string

sortDir

Specify either ascending ('asc') or descending ('desc') sort order for a given field (sortField), which must be set for sortDir to apply. Defaults to 'asc'.

Type: string

sortField

Type: string

list_connectors

Returns a list of the available connectors.

Parameters

tenant (required)

The tenant name.

Type: string

list_dashboards

Return a list of Dashboards.

Parameters

tenant (required)

The tenant name.

Type: string

count

The maximum number of results to return.

Type: integer

filter

A filter to apply to the results list. The filter must be a SPL predicate expression.

Type: spl-predicate-expression

offset

The number of results to skip before the first one returned.

Type: integer

orderby

A list of fields to order the results by. You can specify either ascending or descending order using " asc" or " desc. Ascending order is the default.

Type: array

[ "string" ]

list_datasets

Returns a list of all datasets, unless you specify a filter. Use a filter to return a specific list of datasets.

Parameters

tenant (required)

The tenant name.

Type: string

count

The maximum number of results to return.

Type: integer

filter

A filter to apply to the results list. The filter must be a SPL predicate expression.

Type: spl-predicate-expression

maxstale

The number of seconds beyond which we will refresh index metadata.

Type: integer

offset

The number of results to skip before the first one returned.

Type: integer

orderby

A list of fields to order the results by. You can specify either ascending or descending order using " asc" or " desc. Ascending order is the default.

Type: array

[ "string" ]

list_events_summary

Return events summary, for search ID (SID) search.

Parameters

sid (required)

The search ID.

Type: string

tenant (required)

The tenant name.

Type: string

count

The maximum number of entries to return. Set to 0 to return all available entries.

Type: number

earliest

The earliest time filter, in absolute time. When specifying an absolute time specify either UNIX time, or UTC in seconds using the ISO-8601 (%FT%T.%Q) format. For example 2019-01-25T13:15:30Z. GMT is the default timezone. You must specify GMT when you specify UTC. Any offset specified is ignored.

Type: string

field

A field to return for the result set. You can specify multiple fields of comma-separated values if multiple fields are required.

Type: string

latest

The latest time filter in absolute time. When specifying an absolute time specify either UNIX time, or UTC in seconds using the ISO-8601 (%FT%T.%Q) format. For example 2019-01-25T13:15:30Z. GMT is the default timezone. You must specify GMT when you specify UTC. Any offset specified is ignored.

Type: string

offset

Index of first item to return.

Type: number

list_fields

Get a list of all fields in the Catalog.

Parameters

tenant (required)

The tenant name.

Type: string

count

The maximum number of results to return.

Type: integer

filter

A filter to apply to the results list. The filter must be a SPL predicate expression.

Type: spl-predicate-expression

offset

The number of results to skip before the first one returned.

Type: integer

orderby

A list of fields to order the results by. You can specify either ascending or descending order using " asc" or " desc. Ascending order is the default.

Type: array

[ "string" ]

list_fields_for_dataset

Return the list of fields that are part of a specified dataset.

Parameters

datasetresourcename (required)

The resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.

Type: string

tenant (required)

The tenant name.

Type: string

count

The maximum number of results to return.

Type: integer

filter

A filter to apply to the results list. The filter must be a SPL predicate expression.

Type: spl-predicate-expression

offset

The number of results to skip before the first one returned.

Type: integer

orderby

A list of fields to order the results by. You can specify either ascending or descending order using " asc" or " desc. Ascending order is the default.

Type: array

[ "string" ]

list_fields_for_dataset_by_id

Return the set of fields for the specified dataset.

Parameters

datasetid (required)

ID of a Dataset.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

count

The maximum number of results to return.

Type: integer

filter

A filter to apply to the results list. The filter must be a SPL predicate expression.

Type: spl-predicate-expression

offset

The number of results to skip before the first one returned.

Type: integer

orderby

A list of fields to order the results by. You can specify either ascending or descending order using " asc" or " desc. Ascending order is the default.

Type: array

[ "string" ]

list_fields_summary

Return fields stats summary of the events to-date, for search ID (SID) search.

Parameters

sid (required)

The search ID.

Type: string

tenant (required)

The tenant name.

Type: string

earliest

The earliest time filter, in absolute time. When specifying an absolute time specify either UNIX time, or UTC in seconds using the ISO-8601 (%FT%T.%Q) format. For example 2019-01-25T13:15:30Z. GMT is the default timezone. You must specify GMT when you specify UTC. Any offset specified is ignored.

Type: string

latest

The latest time filter in absolute time. When specifying an absolute time specify either UNIX time, or UTC in seconds using the ISO-8601 (%FT%T.%Q) format. For example 2019-01-25T13:15:30Z. GMT is the default timezone. You must specify GMT when you specify UTC. Any offset specified is ignored.

Type: string

list_group_members

Returns a list of the members within a given group.

Parameters

group (required)

The group name.

Type: string

tenant (required)

The tenant name.

Type: string

list_group_roles

Returns a list of the roles that are attached to a group within a given tenant.

Parameters

group (required)

The group name.

Type: string

tenant (required)

The tenant name.

Type: string

list_groups

List the groups that exist in a given tenant.

Parameters

tenant (required)

The tenant name.

Type: string

list_indexes

Parameters

collection (required)

The name of the collection.

Type: string

tenant (required)

The tenant id.

Type: string

list_invites

Returns a list of invitations in a given tenant.

Parameters

tenant (required)

The tenant name.

Type: string

list_jobs

Return the matching list of search jobs.

Parameters

tenant (required)

The tenant name.

Type: string

count

The maximum number of jobs that you want to return the status entries for.

Type: number

status

The current status of the search job. The valid status values are 'running', 'done', 'canceled', and 'failed'.

Type: string

Potential values: running, done, canceled, failed

list_m_l_workflow_runs

Parameters

buildId (required)

The workflow build ID.

Type: string

id (required)

The workflow ID.

Type: string

tenant (required)

The tenant name.

Type: string

list_member_groups

Returns a list of groups that a member belongs to within a tenant.

Parameters

member (required)

The member name.

Type: string

tenant (required)

The tenant name.

Type: string

list_member_permissions

Returns a set of permissions granted to the member within the tenant.

Parameters

member (required)

The member name.

Type: string

tenant (required)

The tenant name.

Type: string

list_member_roles

Returns a set of roles that a given member holds within the tenant.

Parameters

member (required)

The member name.

Type: string

tenant (required)

The tenant name.

Type: string

list_members

Returns a list of members in a given tenant.

Parameters

tenant (required)

The tenant name.

Type: string

list_ml_workflow_builds

Parameters

id (required)

The workflow ID.

Type: string

tenant (required)

The tenant name.

Type: string

list_ml_workflows

Parameters

tenant (required)

The tenant name.

Type: string

list_modules

Return a list of all modules, unless you specify a filter. Use a filter to return a specific list of modules.

Parameters

tenant (required)

The tenant name.

Type: string

filter

A filter to apply to the modules.

Type: spl-predicate-expression

list_pipelines

Returns all pipelines.

Parameters

tenant (required)

The tenant name.

Type: string

activated

activated

Type: boolean

createUserId

createUserId

Type: string

includeData

includeData

Type: boolean

name

name

Type: string

sortDir

sortDir

Type: string

sortField

sortField

Type: string

list_preview_results

Return the preview search results for the job with the specified search ID (SID). Can be used when a job is running to return interim results.

Parameters

sid (required)

The search ID.

Type: string

tenant (required)

The tenant name.

Type: string

count

The maximum number of entries to return. Set to 0 to return all available entries.

Type: number

offset

Index of first item to return.

Type: number

list_principals

Returns the list of principals that the Identity service knows about.

This operation has no parameters

list_provision_jobs

Returns a list of all provision jobs created by the user.

This operation has no parameters

list_records

Use key-value query parameters to filter fields. Fields are implicitly ANDed and values for the same field are implicitly ORed.

Parameters

collection (required)

The name of the collection.

Type: string

tenant (required)

The tenant id.

Type: string

count

Maximum number of records to return.

Type: integer

fields

Comma-separated list of fields to include or exclude.

Type: array

[ "string" ]

filters

Type: object

{ }

offset

Number of records to skip from the start.

Type: integer

orderby

Sort order. Format is :. Valid sort orders are 1 for ascending, -1 for descending.

Type: array

[ "string" ]

list_relationships

Returns a list of all relationships, unless you specify a filter. Use a filter to return a specific list of relationships.

Parameters

tenant (required)

The tenant name.

Type: string

count

The maximum number of results to return.

Type: integer

filter

A filter to apply to the results list. The filter must be a SPL predicate expression.

Type: spl-predicate-expression

offset

The number of results to skip before the first one returned.

Type: integer

orderby

A list of fields to order the results by. You can specify either ascending or descending order using " asc" or " desc. Ascending order is the default.

Type: array

[ "string" ]

list_results

Return the search results for the job with the specified search ID (SID).

Parameters

sid (required)

The search ID.

Type: string

tenant (required)

The tenant name.

Type: string

count

The maximum number of entries to return. Set to 0 to return all available entries.

Type: number

field

A field to return for the result set. You can specify multiple fields of comma-separated values if multiple fields are required.

Type: string

offset

Index of first item to return.

Type: number

list_role_groups

Gets a list of groups for a role in a given tenant.

Parameters

role (required)

The role name.

Type: string

tenant (required)

The tenant name.

Type: string

list_role_permissions

Gets the permissions for a role in a given tenant.

Parameters

role (required)

The role name.

Type: string

tenant (required)

The tenant name.

Type: string

list_roles

Returns all roles for a given tenant.

Parameters

tenant (required)

The tenant name.

Type: string

list_rules

Return a list of rules that match a filter query if it is given, otherwise return all rules.

Parameters

tenant (required)

The tenant name.

Type: string

count

The maximum number of results to return.

Type: integer

filter

A filter to apply to the results list. The filter must be a SPL predicate expression.

Type: spl-predicate-expression

offset

The number of results to skip before the first one returned.

Type: integer

orderby

A list of fields to order the results by. You can specify either ascending or descending order using " asc" or " desc. Ascending order is the default.

Type: array

[ "string" ]

list_subscriptions

Returns the tenant subscriptions.

Parameters

tenant (required)

The tenant name.

Type: string

kind

The kind of application.

Type: string

Potential values: web, native, service

list_templates

Returns a list of all templates.

Parameters

tenant (required)

The tenant name.

Type: string

sortDir

sortDir

Type: string

sortField

sortField

Type: string

list_tenants

Returns all tenants that the user can read.

This operation has no parameters

list_time_buckets

Return event distribution over time of the untransformed events read to-date, for search ID(SID) search.

Parameters

sid (required)

The search ID.

Type: string

tenant (required)

The tenant name.

Type: string

list_workflow_builds

Return a list of Machine Learning workflow builds.

Parameters

tenant (required)

The tenant name.

Type: string

workflowid (required)

ID of a workflow.

Type: mongo-object-id

count

The maximum number of results to return.

Type: integer

filter

A filter to apply to the results list. The filter must be a SPL predicate expression.

Type: spl-predicate-expression

offset

The number of results to skip before the first one returned.

Type: integer

orderby

A list of fields to order the results by. You can specify either ascending or descending order using " asc" or " desc. Ascending order is the default.

Type: array

[ "string" ]

list_workflow_deployments

Parameters

buildId (required)

The workflow build ID.

Type: string

id (required)

The workflow ID.

Type: string

tenant (required)

The tenant name.

Type: string

list_workflow_runs

Return a list of Machine Learning workflow runs for specified workflow build ID.

Parameters

tenant (required)

The tenant name.

Type: string

workflowbuildid (required)

ID of a workflow build.

Type: mongo-object-id

workflowid (required)

ID of a workflow.

Type: mongo-object-id

count

The maximum number of results to return.

Type: integer

filter

A filter to apply to the results list. The filter must be a SPL predicate expression.

Type: spl-predicate-expression

offset

The number of results to skip before the first one returned.

Type: integer

orderby

A list of fields to order the results by. You can specify either ascending or descending order using " asc" or " desc. Ascending order is the default.

Type: array

[ "string" ]

list_workflows

Return a list of Machine Learning workflow configurations.

Parameters

tenant (required)

The tenant name.

Type: string

count

The maximum number of results to return.

Type: integer

filter

A filter to apply to the results list. The filter must be a SPL predicate expression.

Type: spl-predicate-expression

offset

The number of results to skip before the first one returned.

Type: integer

orderby

A list of fields to order the results by. You can specify either ascending or descending order using " asc" or " desc. Ascending order is the default.

Type: array

[ "string" ]

merge_pipelines

Combines two Streams JSON programs.

Parameters

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"inputTree" : {
"nodes" : [ {
"op" : "The function's ID or its API name",
"attributes" : { },
"id" : "The function's (node's) UUID",
"resolvedId" : "string"
} ],
"edges" : [ {
"sourcePort" : "The source function's (node's) port",
"sourceNode" : "The source function's (node's) id",
"attributes" : { },
"targetNode" : "The target function's (node's) id",
"targetPort" : "The target function's (node's) port"
} ],
"rootNode" : [ "string" ]
},
"mainTree" : {
"nodes" : [ {
"op" : "The function's ID or its API name",
"attributes" : { },
"id" : "The function's (node's) UUID",
"resolvedId" : "string"
} ],
"edges" : [ {
"sourcePort" : "The source function's (node's) port",
"sourceNode" : "The source function's (node's) id",
"attributes" : { },
"targetNode" : "The target function's (node's) id",
"targetPort" : "The target function's (node's) port"
} ],
"rootNode" : [ "string" ]
},
"targetNode" : "The function ID of the merge target in the main pipeline.",
"targetPort" : "The input port of the merge target in the main pipeline."
}

ping

Parameters

tenant (required)

The tenant id.

Type: string

post_events

Parameters

tenant (required)

Type: string

$body

Type: array

[ {
"nanos" : "Optional nanoseconds part of the timestamp.",
"host" : "The host value assigned to the event data. Typically, this is the hostname of the client from which you are sending data.",
"attributes" : { },
"sourcetype" : "The sourcetype value assigned to the event data.",
"id" : "An optional ID that uniquely identifies the event data. It is used to deduplicate the data if same data is set multiple times.\nIf ID is not specified, it will be assigned by the system.",
"source" : "The source value to assign to the event data. For example, if you are sending data from an app that you are developing,\nset this key to the name of the app.",
"body" : { },
"timestamp" : "Epoch time in milliseconds."
} ]

post_metrics

Parameters

tenant (required)

Type: string

$body

Type: array

[ {
"nanos" : "Optional nanoseconds part of the timestamp.",
"host" : "The host value assigned to the event data. Typically, this is the hostname of the client from which you are sending data.",
"attributes" : {
"defaultUnit" : "Optional. If set, individual metrics inherit this unit and can optionally override.",
"defaultDimensions" : "Optional. If set, individual metrics inherit these dimensions and can override any and/or all of them.",
"defaultType" : "Optional. If set, individual metrics inherit this type and can optionally override."
},
"sourcetype" : "The sourcetype value assigned to the event data.",
"id" : "An optional ID that uniquely identifies the metric data. It is used to deduplicate the data if same data is set multiple times.\nIf ID is not specified, it will be assigned by the system.",
"source" : "The source value to assign to the event data. For example, if you are sending data from an app that you are developing,\nset this key to the name of the app.",
"body" : [ {
"unit" : "Unit of the metric e.g. percent, megabytes, seconds etc.",
"name" : "Name of the metric e.g. CPU, Memory etc.",
"type" : "Type of metric. Default is g for gauge.",
"value" : "Value of the metric. If not specified, it will be defaulted to 0.",
"dimensions" : "Dimensions allow metrics to be classified e.g. {\"Server\":\"nginx\", \"Region\":\"us-west-1\", ...}"
} ],
"timestamp" : "Epoch time in milliseconds."
} ]

put_connection

Modifies an existing DSP connection.

Parameters

connectionId (required)

ID of the connection

Type: string

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"data" : { },
"name" : "The name of the connection.",
"description" : "The description of the connection."
}

put_group

Update a group function combining the Streams JSON of two or more functions.

Parameters

groupId (required)

The group function's ID from the function registry

Type: string

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"mappings" : [ {
"functionId" : "The function id to map to a group function argument.",
"arguments" : [ {
"functionArg" : "Function argument name.",
"groupArg" : "The argument name for your group function."
} ]
} ],
"scalar" : "boolean",
"ast" : {
"nodes" : [ {
"op" : "The function's ID or its API name",
"attributes" : { },
"id" : "The function's (node's) UUID",
"resolvedId" : "string"
} ],
"edges" : [ {
"sourcePort" : "The source function's (node's) port",
"sourceNode" : "The source function's (node's) id",
"attributes" : { },
"targetNode" : "The target function's (node's) id",
"targetPort" : "The target function's (node's) port"
} ],
"rootNode" : [ "string" ]
},
"name" : "The group function name.",
"outputType" : "The data type of the function's output.",
"arguments" : [ {
"groupArg" : "The argument name for your group function.",
"position" : "Group function argument position number.",
"type" : "The group function's data type."
} ],
"attributes" : { },
"categories" : [ "integer" ],
"variadic" : "boolean"
}

put_record

Parameters

collection (required)

The name of the collection.

Type: string

key (required)

The key of the record.

Type: string

tenant (required)

The tenant id.

Type: string

$body

Record to add to the collection, formatted as a JSON object.

Type: object

{ }

If-Match

Record version identifier.

Type: string

put_template

Updates an existing template.

Parameters

templateId (required)

ID of the template

Type: string

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"data" : {
"nodes" : [ {
"op" : "The function's ID or its API name",
"attributes" : { },
"id" : "The function's (node's) UUID",
"resolvedId" : "string"
} ],
"edges" : [ {
"sourcePort" : "The source function's (node's) port",
"sourceNode" : "The source function's (node's) id",
"attributes" : { },
"targetNode" : "The target function's (node's) id",
"targetPort" : "The target function's (node's) port"
} ],
"rootNode" : [ "string" ]
},
"name" : "Template name",
"description" : "Template description"
}

query_records

Parameters

collection (required)

The name of the collection.

Type: string

tenant (required)

The tenant id.

Type: string

count

Maximum number of records to return.

Type: integer

fields

Comma-separated list of fields to include or exclude.

Type: array

[ "string" ]

offset

Number of records to skip from the start.

Type: integer

orderby

Sort order. Format is :. Valid sort orders are 1 for ascending, -1 for descending.

Type: array

[ "string" ]

query

Query JSON expression.

Type: string

reactivate_pipeline

Reactivate a pipeline

Parameters

id (required)

Pipeline UUID to reactivate

Type: string

tenant (required)

The tenant name.

Type: string

remove_group_member

Removes the member from a given group.

Parameters

group (required)

The group name.

Type: string

member (required)

The member name.

Type: string

tenant (required)

The tenant name.

Type: string

remove_group_role

Removes a role from a given group.

Parameters

group (required)

The group name.

Type: string

role (required)

The role name.

Type: string

tenant (required)

The tenant name.

Type: string

remove_member

Removes a member from a given tenant

Parameters

member (required)

The member name.

Type: string

tenant (required)

The tenant name.

Type: string

remove_role_permission

Removes a permission from the role.

Parameters

permission (required)

The permission string.

Type: string

role (required)

The role name.

Type: string

tenant (required)

The tenant name.

Type: string

rotate_secret

Rotates the client secret for an app.

Parameters

appName (required)

App name.

Type: string

tenant (required)

The tenant name.

Type: string

start_preview

Creates a preview session for a pipeline.

Parameters

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"upl" : {
"nodes" : [ {
"op" : "The function's ID or its API name",
"attributes" : { },
"id" : "The function's (node's) UUID",
"resolvedId" : "string"
} ],
"edges" : [ {
"sourcePort" : "The source function's (node's) port",
"sourceNode" : "The source function's (node's) id",
"attributes" : { },
"targetNode" : "The target function's (node's) id",
"targetPort" : "The target function's (node's) port"
} ],
"rootNode" : [ "string" ]
},
"useNewData" : "Deprecated. Must be true if set.",
"recordsLimit" : "The maximum number of events per function. Defaults to 100.",
"recordsPerPipeline" : "The maximum number of events per pipeline. Defaults to 10000.",
"sessionLifetimeMs" : "The maximum lifetime of a session, in milliseconds. Defaults to 300,000.",
"streamingConfigurationId" : "Deprecated. Must be null if set."
}

stop_preview

Stops a preview session.

Parameters

previewSessionId (required)

ID of the preview session

Type: string

tenant (required)

The tenant name.

Type: string

trigger_action

Parameters

action_name (required)

The name of the action as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit.

Type: string

tenant (required)

The tenant name.

Type: string

$body

The action payload, which should include values for any templated fields.

Type: object

{
"createdAt" : "string-ified ISO-8601 date/time with zone.",
"triggerCondition" : "A description of the condition that caused the trigger event.",
"createdBy" : "The principal that generated the trigger event.",
"payload" : { },
"triggerName" : "The name of the trigger for which this event was created.",
"kind" : "string. Possible values: trigger",
"id" : "A unique identifier for this trigger event. Generated from a hash of all recursively-sorted event field values.",
"actionMetadata" : {
"addresses" : [ "email" ],
"members" : [ "string" ]
},
"ttlSeconds" : "A time to live (TTL), expressed as seconds after createdAt, after which the trigger event will no longer be acted upon.",
"tenant" : "The tenant within which the trigger event was generated."
}

update_action

Parameters

action_name (required)

The name of the action as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit.

Type: string

tenant (required)

The tenant name.

Type: string

$body

Updates to the action template.

Type: object

{
"addresses" : [ "email" ],
"subject" : "The subject of the email. You can use a template in this field.",
"members" : [ "string" ],
"fromName" : "Optional text providing a human-friendly name for the sender. Must be less than or equal to 81 characters. You can use a template in this field.",
"bodyPlainText" : "Optional text to send as the text/plain part of the email. If this field is not set for an email action, the Action service converts the value from the body field to text and sends that as the text/plain part when invoking the action. You can use a template in this field.",
"body" : "HTML content to send as the body of the email. You can use a template in this field.",
"title" : "A human-readable title for the action. Must be less than or equal to 128 characters."
}

update_action_by_id_for_rule

Update the Action with the specified id for the specified Rule

Parameters

actionid (required)

ID of an Action.

Type: mongo-object-id

ruleresourcename (required)

The resource name of a rule. For the default module, the resource name format is ruleName. Otherwise, the resource name format is module.ruleName.

Type: string

tenant (required)

The tenant name.

Type: string

$body

The fields to update in the specified action.

Type: object

{
"owner" : "The name of the user who owns this action. This value is obtained from the bearer token if not present.",
"version" : "The catalog version.",
"field" : "The name of the field to be aliased.",
"kind" : "The alias action kind.",
"alias" : "The alias name."
}

update_action_by_id_for_rule_by_id

Update an action for a specific rule.

Parameters

actionid (required)

ID of an Action.

Type: mongo-object-id

ruleid (required)

ID of a Field.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

$body

The properties to update in the specified action.

Type: object

{
"owner" : "The name of the user who owns this action. This value is obtained from the bearer token if not present.",
"version" : "The catalog version.",
"field" : "The name of the field to be aliased.",
"kind" : "The alias action kind.",
"alias" : "The alias name."
}

update_app

Updates an app.

Parameters

appName (required)

App name.

Type: string

tenant (required)

The tenant name.

Type: string

$body

Updates app contents.

Type: object

{
"appPrincipalPermissions" : [ "string" ],
"loginUrl" : "The URL used to log in to the app.",
"description" : "Short paragraph describing the app.",
"title" : "Human-readable title for the app.",
"logoUrl" : "The URL used to display the app's logo.",
"userPermissionsFilter" : [ "string" ],
"setupUrl" : "URL to redirect to after a subscription is created.",
"redirectUrls" : [ "uri" ],
"webhookUrl" : "URL that webhook events are sent to."
}

update_connection

Partially modifies an existing DSP connection.

Parameters

connectionId (required)

ID of the connection

Type: string

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"data" : { },
"name" : "The name of the connection.",
"description" : "The description of the connection."
}

update_dashboard_by_id

Update the dashboard with the specified ID.

Parameters

dashboardid (required)

ID of a dashboard.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

$body

An updated representation of the dashboard to be persisted.

Type: object

{
"isactive" : "Whether the dashboard is active or not.",
"module" : "The module that contains the dashboard.",
"name" : "The dashboard name. Dashboard names must be unique within each tenant.",
"definition" : "The JSON dashboard definition.",
"version" : "The version of the dashboard."
}

update_dashboard_by_resource_name

Update the dashboard with the specified resource name.

Parameters

dashboardresourcename (required)

The resource name of a dashvboard. The resource name format is module.dashboardname.

Type: string

tenant (required)

The tenant name.

Type: string

$body

An updated representation of the dashboard to be persisted.

Type: object

{
"isactive" : "Whether the dashboard is active or not.",
"module" : "The module that contains the dashboard.",
"name" : "The dashboard name. Dashboard names must be unique within each tenant.",
"definition" : "The JSON dashboard definition.",
"version" : "The version of the dashboard."
}

update_dataset

Update the dataset with the specified resource name. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.

Parameters

datasetresourcename (required)

The resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.

Type: string

tenant (required)

The tenant name.

Type: string

$body

An updated representation of the dataset to be persisted.

Type: object

{
"filter" : "A query that filters results out of the lookup before those results are returned.",
"caseSensitiveMatch" : "Match case-sensitively against the lookup.",
"kind" : "The dataset kind.",
"externalName" : "The name of the external lookup.",
"externalKind" : "The type of the external lookup.",
"owner" : "The name of the dataset owner. This value is obtained from the bearer token.",
"module" : "The name of module to reassign dataset into.",
"name" : "The dataset name. Dataset names must be unique within each module."
}

update_dataset_by_id

Update a specific dataset.

Parameters

datasetid (required)

ID of a Dataset.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

$body

An updated representation of the dataset to be persisted.

Type: object

{
"filter" : "A query that filters results out of the lookup before those results are returned.",
"caseSensitiveMatch" : "Match case-sensitively against the lookup.",
"kind" : "The dataset kind.",
"externalName" : "The name of the external lookup.",
"externalKind" : "The type of the external lookup.",
"owner" : "The name of the dataset owner. This value is obtained from the bearer token.",
"module" : "The name of module to reassign dataset into.",
"name" : "The dataset name. Dataset names must be unique within each module."
}

update_field_by_id_for_dataset

Update a field with a specified ID for a specified dataset.

Parameters

datasetresourcename (required)

The resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.

Type: string

fieldid (required)

ID of a Field.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

$body

The properties to update in the specified field.

Type: object

{
"summary" : "The field summary.",
"prevalence" : "How frequent the field appears in the dataset. Must be one of the valid values.",
"datatype" : "The type of data in the field. Must be one of the valid values.",
"indexed" : "Whether or not the field has been indexed.",
"name" : "The field name.",
"description" : "The field description.",
"fieldtype" : "The type of field. Must be one of the valid values.",
"title" : "The field title."
}

update_field_by_id_for_dataset_by_id

Update a field for a specific dataset.

Parameters

datasetid (required)

ID of a Dataset.

Type: mongo-object-id

fieldid (required)

ID of a Field.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

$body

The properties to update in the specified field.

Type: object

{
"summary" : "The field summary.",
"prevalence" : "How frequent the field appears in the dataset. Must be one of the valid values.",
"datatype" : "The type of data in the field. Must be one of the valid values.",
"indexed" : "Whether or not the field has been indexed.",
"name" : "The field name.",
"description" : "The field description.",
"fieldtype" : "The type of field. Must be one of the valid values.",
"title" : "The field title."
}

update_group

Modify a group function by combining the Streams JSON of two or more functions.

Parameters

groupId (required)

The group function's ID from the function registry

Type: string

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"mappings" : [ {
"functionId" : "The function id to map to a group function argument.",
"arguments" : [ {
"functionArg" : "Function argument name.",
"groupArg" : "The argument name for your group function."
} ]
} ],
"scalar" : "boolean",
"ast" : {
"nodes" : [ {
"op" : "The function's ID or its API name",
"attributes" : { },
"id" : "The function's (node's) UUID",
"resolvedId" : "string"
} ],
"edges" : [ {
"sourcePort" : "The source function's (node's) port",
"sourceNode" : "The source function's (node's) id",
"attributes" : { },
"targetNode" : "The target function's (node's) id",
"targetPort" : "The target function's (node's) port"
} ],
"rootNode" : [ "string" ]
},
"name" : "The name for the group function.",
"outputType" : "The data type of the output of your function.",
"arguments" : [ {
"groupArg" : "The argument name for your group function.",
"position" : "Group function argument position number.",
"type" : "The group function's data type."
} ],
"attributes" : { },
"categories" : [ "integer" ],
"variadic" : "boolean"
}

update_invite

Modifies an invitation in the given tenant.

Parameters

inviteId (required)

Type: string

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"action" : "Required string. Possible values: accept | reject | resend"
}

update_job

Update the search job with the specified search ID (SID) with an action.

Parameters

sid (required)

The search ID.

Type: string

tenant (required)

The tenant name.

Type: string

$body

Update a search job with a status.

Type: object

{
"status" : "The status to PATCH to an existing search job. The only status values you can PATCH are 'canceled' and 'finalized'. You can PATCH the 'canceled' status only to a search job that is running."
}

update_pipeline

Partially modifies an existing pipeline.

Parameters

id (required)

id of the pipeline to update

Type: string

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"createUserId" : "The user that created the pipeline. Deprecated.",
"data" : {
"nodes" : [ {
"op" : "The function's ID or its API name",
"attributes" : { },
"id" : "The function's (node's) UUID",
"resolvedId" : "string"
} ],
"edges" : [ {
"sourcePort" : "The source function's (node's) port",
"sourceNode" : "The source function's (node's) id",
"attributes" : { },
"targetNode" : "The target function's (node's) id",
"targetPort" : "The target function's (node's) port"
} ],
"rootNode" : [ "string" ]
},
"name" : "The name of the pipeline.",
"description" : "The description of the pipeline. Defaults to null.",
"bypassValidation" : "Set to true to bypass initial pipeline validation upon creation. The pipeline still needs to be validated before activation. Defaults to false."
}

update_relationship_by_id

Update a specific relationship.

Parameters

relationshipid (required)

ID of a relationship.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

$body

The properties to update in the specified relationship.

Type: object

{
"owner" : "The user who is the owner of the relationship.",
"name" : "The name of the relationship."
}

update_rule

Update the Rule with the specified resourcename

Parameters

ruleresourcename (required)

The resource name of a rule. For the default module, the resource name format is ruleName. Otherwise, the resource name format is module.ruleName.

Type: string

tenant (required)

The tenant name.

Type: string

$body

The properties to update in the specified rule.

Type: object

{
"module" : "The module containing the rule.",
"match" : "The rule match type.",
"name" : "The rule name.",
"version" : "The catalog version."
}

update_rule_by_id

Update a specific rule.

Parameters

ruleid (required)

ID of a Field.

Type: mongo-object-id

tenant (required)

The tenant name.

Type: string

$body

The properties to update in the specified rule.

Type: object

{
"module" : "The module containing the rule.",
"match" : "The rule match type.",
"name" : "The rule name.",
"version" : "The catalog version."
}

update_template

Partially modifies an existing template.

Parameters

templateId (required)

ID of the template

Type: string

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"data" : {
"nodes" : [ {
"op" : "The function's ID or its API name",
"attributes" : { },
"id" : "The function's (node's) UUID",
"resolvedId" : "string"
} ],
"edges" : [ {
"sourcePort" : "The source function's (node's) port",
"sourceNode" : "The source function's (node's) id",
"attributes" : { },
"targetNode" : "The target function's (node's) id",
"targetPort" : "The target function's (node's) port"
} ],
"rootNode" : [ "string" ]
},
"name" : "Template name",
"description" : "Template description"
}

update_workflow_build_by_id

Update the workflow build with the specified workflow build ID.

Parameters

tenant (required)

The tenant name.

Type: string

workflowbuildid (required)

ID of a workflow build.

Type: mongo-object-id

workflowid (required)

ID of a workflow.

Type: mongo-object-id

$body

An updated representation of the workflow build to be persisted.

Type: object

{
"name" : "The workflow build name.",
"description" : "The workflow build description.",
"status" : "The status of the workflow build."
}

update_workflow_by_id

Update the workflow with the specified workflow ID.

Parameters

tenant (required)

The tenant name.

Type: string

workflowid (required)

ID of a workflow.

Type: mongo-object-id

$body

An updated representation of the workflow to be persisted.

Type: object

{
"name" : "The workflow name.",
"description" : "The workflow description."
}

update_workflow_run_by_id

Update the workflow run with the specified workflow run ID.

Parameters

tenant (required)

The tenant name.

Type: string

workflowbuildid (required)

ID of a workflow build.

Type: mongo-object-id

workflowid (required)

ID of a workflow.

Type: mongo-object-id

workflowrunid (required)

ID of a workflow run.

Type: mongo-object-id

$body

An updated representation of the workflow run to be persisted.

Type: object

{
"name" : "The workflow run name.",
"description" : "The workflow run description.",
"status" : "The status of the workflow run."
}

validate_pipeline

Verifies whether the Streams JSON is valid.

Parameters

tenant (required)

The tenant name.

Type: string

$body

Type: object

{
"upl" : {
"nodes" : [ {
"op" : "The function's ID or its API name",
"attributes" : { },
"id" : "The function's (node's) UUID",
"resolvedId" : "string"
} ],
"edges" : [ {
"sourcePort" : "The source function's (node's) port",
"sourceNode" : "The source function's (node's) id",
"attributes" : { },
"targetNode" : "The target function's (node's) id",
"targetPort" : "The target function's (node's) port"
} ],
"rootNode" : [ "string" ]
}
}

validate_token

Validates the access token obtained from the authorization header and returns the principal name and tenant memberships.

Parameters

tenant (required)

The tenant name.

Type: string

include

Include additional information to return when validating tenant membership. Valid parameters [tenant, principal]

Type: array

[ "string. Possible values: tenant | principal" ]