Splunk Cloud Services (version v1.*.*)

$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#

$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#

{
  "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."
  } ]
}

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#

{
  "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"
}

$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#

Creates a workflow run.

Parameters

buildId (required)#

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#

Creates a 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" : { }
}

{
  "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#

Creates a workflow streaming 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."
}

Type: string

delete_certificates#

Removes all certificates on a tenant.

Parameters

The tenant id.

Type: string

delete_invite#

Removes an invitation in the given tenant.

Parameters

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_invite#

Returns an invitation in the given tenant.

Parameters

Type: string

get_provision_job#

Returns details of a specific provision job.

Parameters

Inserts a record into a collection.

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#

Inserts multiple records in a single request.

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

[ { } ]

[ "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" ]

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" ]

tenant (required)#

Type: string

list_connections#

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

Parameters

tenant (required)#

The tenant name.

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" ]

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" ]

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#

Type: string

The tenant name.

Type: string

count#

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

Type: number

status#

[ "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" ]

[ "string" ]

list_subscriptions#

Returns the tenant subscriptions.

Parameters

tenant (required)#

The tenant name.

Type: string

kind#

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" ]

[ "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" ]

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#

Sends metric 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" : {
    "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."
} ]

$body#

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

Type: object

{ }

[ "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" ]

{
  "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#

Modifies an action template.

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#

{
  "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."
}

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."
}

{
  "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."
}

{
  "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" ]