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

Get details of a service instance

GET
http://localhost:3000/service_management/getInstance/:model/:value
GET
/service_management/getInstance/:model/:value
$curl http://localhost:3000/service_management/getInstance/model/value \
> -u "<username>:<password>"
1{
2 "servicePath": [
3 {}
4 ]
5}
Returns all properties for a service model instance.
Was this page helpful?
Previous

Get details of a service model

Next
Built with

Authentication

AuthorizationBasic

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

Path parameters

modelstringRequired

A service model’s XPATH. The XPATH is obtained from API ServiceManagement.getServiceModelMap(). When using this API over HTTP, this will be a part of the path itself. Therefore (since service models always include ’/’ character), the path will first need to be URL encoded. A good site for URL encoding text is URL Encoder.

valuestringRequired

A service model instance’s keys learned from ServiceManager.getInstancesOfService(). Keys are expressed as a space delimited list of key values.

Response

An object with a single field with the service model's XPATH as its key. The field's value is an array of objects. Each element of the array is an object representing the properties of a service model instance.
servicePathlist of objects
The servicePath key is a service model's XPATH. The value is an array of objects. Each array element represents an instance of a service model.

Errors

500
Internal Server Error