/topologies/{topologyName}

The /topologies/{topologyName} endpoint allows you to retrieve and delete a single topology.

To create, retrieve and update multiple topologies see /topologies.

Back to Topologies API Endpoint Reference.

GET

Retrieves details of a specified topology.

Path parameters

The GET request takes the following path parameter:

Name

Type

Required

Description

 topologyName

String

Yes

Name of the topology. You can obtain all topology names by executing a GET request to /topologies.

Response

The GET request returns the following response:

Successful requests return an array of JSON objects containing the following:

Name

Type

Description

name

String

Name of the topology.

description

String

Description of the topology.

active

Boolean

Whether the topology is active (true) or inactive (false).

Example

The following example demonstrates making a GET request to the /topologies/{topologyName} endpoint.

Request example

Example cURL request for details of the topology with name "host":

curl -X GET \
https://example.com/api/v1/topologies/host \
-u phil:password123 \

Response example

Example response returning the topology's details:

{  
    "name": "host",  
    "description": "Host-based topology",
    "active": true
}

DELETE

Deletes a specified topology. Note the following:

  • You cannot delete a topology if it's being used to filter a Recipe.

  • Deleting a topology will impact your ability to restore associated Recipes in future. In order to restore a Recipe that filters on a named topology, the topology must still exist in Moogsoft Enterprise.

Request arguments

The DELETE request takes no arguments. It deletes the specified topology and any associated nodes and links.

Response

The DELETE request returns the following response:

Example

The following example demonstrates making a DELETE request to the /topologies/{topologyName} endpoint.

Request example

Example cURL request to delete a topology with name "host":

curl -X DELETE \
https://example.com/api/v1/topologies/host \
-u phil:password123

Response example