/topologies/inactive
The /topologies/inactive endpoint allows you to retrieve all inactive topologies.
To retrieve all active topologies see /topologies.
Back to Topologies API Endpoint Reference.
GET
Retrieves details of all inactive topologies.
Path parameters
The GET request takes no parameters. It returns data for all inactive topologies in the system.
Response
The GET request returns the following response:
Successful requests return an array of JSON objects containing the following:
Name | Type | Description |
|---|---|---|
| String | Name of the topology. |
| String | Description of the topology. |
| Boolean | Whether the topology is active ( |
Examples
The following examples demonstrate making a GET request to the /topologies/inactive endpoint.
Request example
Example cURL GET request to return details for all inactive topologies:
curl -X GET 'https://example.com/api/v1/topologies/inactive' -u phil:password123
Response example
Example response returning the inactive topology details:
[
{
"name": "host",
"description": "Host-based topology",
"active": false
},
{
"name": "location",
"description": "Location-based topology",
"active": false
}
]