deactivateTopology

A Workflow Engine function that updates a named topology from an active to an inactive state. Returns false if the topology can not be dedactivated.

This function is available for alert workflows.

Back to Workflow Engine Functions Reference.Workflow Engine Functions Reference

Arguments

Workflow Engine function deactivateTopology takes the following arguments:

Name

Required

Type

Description

topologyName

yes

string

The name or substited value for the topology. To substitute a value, use $(<attribute_name>). For example $(custom_info.myTopology).

Example

The following example demonstrates typical use of Workflow Engine function deactivateToplogy.

If you want to deactivate an active topology named "my network", set the following:

  • topologyName: my network

The UI translates your settings to the following JSON:

{"topologyName":"my network"}

If you run the topologies API, you can see your inactive topology:

curl -X GET 'https://example.com/api/v1/topologies/inactive'

Returns the following:

 {  
    "name": "my nework",
    "active": false,
    "description": "My network nodes"
 }