app-service_management

On this page:

deleteServicePathsDryRun

Summary

Dry Run Delete Service Instances

Description

Calculates the minimum device configuration commands required to delete one or more service instances hosted on a single south-bound system. Alternative API to [API ServiceManager.testInstances]{@link cogs.ServiceManager#testInstances}.

Route

POST /service_management/deleteServicePathsDryRun/:host

Roles

admin engineering support apiread

Parameters

DetailsExampleSchema
Name Type Required Description
service_paths array yes Service paths to dry run delete.
host string yes The adapter for a south-bound system hosting service instances of interest. Get hosts using [API ServiceManager.getServiceModelMap]{@link cogs.ServiceManager#getServiceModelMap}. When calling method's web API, [URL encode]{@link https://www.urlencoder.org} host value before passing.

Return

DetailsExampleSchema
Name Type Description
dry_run_results object An object containing dry-run configuration for deleting a service instance.