For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI referenceRelease notes
DocumentationAPI referenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • POSTAdd or save a service instance
        • POSTAdd or save multiple service instances
        • POSTConfig dry run
        • GETCreate a service model form
        • DELDelete service instance
        • DELDelete service instance from a path
        • POSTDelete service instances
        • POSTDelete service instances using paths
        • DELDelete service model
        • POSTDry-run a service instance
        • POSTDry-run a service instance
        • DELDry-run: delete service instance from a path
        • POSTDry-run: delete service instances
        • GETGet all instances of a service
        • GETGet all service model details
        • GETGet all service model information
        • GETGet details of a service instance
        • GETGet details of a service model
        • GETGet devices in a service instance
        • POSTGet list of merged service models
        • POSTGet service instance check-Sync status
        • POSTGet service instance configuration
        • POSTGet service instance device modifications
        • GETGet service instance list
        • GETGet service model fields
        • POSTIssue a reactive redeploy on a service instance
        • GETList all service models
        • POSTMap instance data to a service model
        • POSTSave an instance
        • POSTSave instances
        • POSTSet tenant for a service instance
        • POSTSet/Update service model fields
        • POSTTest an instance
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceService Management

Dry-run: delete service instances

POST
http://localhost:3000/service_management/deleteServicePathsDryRun/:host
POST
/service_management/deleteServicePathsDryRun/:host
$curl -X POST http://localhost:3000/service_management/deleteServicePathsDryRun/host \
> -H "Content-Type: application/json" \
> -u "<username>:<password>" \
> -d '{}'
1{}

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

Was this page helpful?
Previous

Get all instances of a service

Next
Built with

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

hoststringRequired

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.

Request

request body
service_pathslist of anyOptional

Response

An object containing dry-run configuration for deleting a service instance.

Errors

500
Internal Server Error