API REFERENCE
USER
- Automation Gateway
- Automation Platform
ADMIN
DEVELOPER
- Automation Platform
PRODUCT NOTICES

API Reference

app-service_management

Show Deprecated Endpoints

addServiceInstance

Add/Save Service Instance

POST /service_management/service/instance/:host

This API call will Add/Save a Service Instance on a specific host.
addServiceInstances

Add/Save Multiple Service Instances

POST /service_management/service/instances/:host

This API call will Add/Save multiple Service Instances on a specific host.
checkSync

Get Service Instance Check-Sync Status

POST /service_management/instance/:path/operations/check-sync

Get check-sync status of a service instance in a given format.
config

Get Service Instance Configuration

POST /service_management/instance/:path/operations/config

Get the configuration of a service instance.
createServiceModelForm

Create a Service Model Form

GET /service_management/model/:service_model_path/form

Creates service model form by service model path.
deleteInstance

Delete Service Instance

DELETE /service_management/service/instance/delete/:name/:key

This API call will delete one or more service instances from a specified host.
deleteInstances

Delete Service Instances

POST /service_management/service/instances/delete/:name

Delete service instances.
deleteServiceModelFromDatabase

Delete Service Model

DELETE /service_management/service/model/database/remove/:service

This API call will delete a service model from database.
deleteServicePath

Delete Service Instance from a Path

DELETE /service_management/deleteServicePath/:service_path/:host

Utilize a service path to delete the instance from the network
deleteServicePathDryRun

Dry Run Delete Service Instance from a Path

DELETE /service_management/deleteServicePathDryRun/:service_path/:host

Utilize a service path to dry run delete the instance from the network
deleteServicePaths

Delete Service Instances using Paths

POST /service_management/deleteServicePaths/:host

Utilize a service path to delete the instance from the network
deleteServicePathsDryRun

Dry Run Delete Service Instances

POST /service_management/deleteServicePathsDryRun/:host

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

Get Service Instance Device Modifications

POST /service_management/instance/:path/operations/device-modifications

Get device modifications of a service instance.
DryRun

Dry Run (manual workflow task)

/service_management/task/DryRun
dryrunServiceInstance

Dry-Run Service Instance

POST /service_management/service/instance/:host/dryrun/:outformat

This API call will Dry-Run a Service Instance.
DryRunServiceWithFlags

Service Instance Dry Run with flags

POST /service_management/service/instance/:host/dryrun

This API call will Dry-Run a Service Instance with flags
getDevicesInServiceInstance

Get Devices in a Service Instance

GET /service_management/service/instance/devices/:name/:key/:host

Get detail information about devices associated with a specific service instance.
getInstance

Get Details of a Service Instance

GET /service_management/getInstance/:model/:value

Get all properties for a service model instance
getInstancesOfService

Get All Instances of a Service

GET /service_management/service/instance/:name

Get all instances of a service by service model name.
getServiceInstanceMap

Get Service Instance List

GET /service_management/service/instances

Get all service instances.
getServiceModel

Get Details of a Service Model

GET /service_management/model/:service_model_path

Get all details on a service model; including its name and the fields that make up its keys
getServiceModelDatabase

Get Service Model Fields

GET /service_management/service/model/database

This API call will return a list of Service Model Fields.
getServiceModelMap

Get All Service Model Information.

GET /service_management/service/models

Get the list of service model names along with the adapter names where those service models are found.
getServicesDetails

Get All Service Model Details

GET /service_management/service/details

Get a list of service models and the time it was last changed.
IWANChooseHub

Choose Hub-Site (manual workflow task)

/service_management/task/IWANChooseHub
IWANChooseQOS

Choose QOS (manual workflow task)

/service_management/task/IWANChooseQOS
IWANChooseSite

Choose Site (manual workflow task)

/service_management/task/IWANChooseSite
listServiceModels

List All Service Models

GET /service_management/service/models/list

{Object} An array of objects containing service model paths and host information.
mapInstanceDataToModel

Map Instance Data to a Service Model

POST /service_management/mapInstanceDataToModel

Map Instance Data to a Service Model
reactiveRedeploy

Issue a Reactive Re-deploy on a Service Instance

POST /service_management/instance/:path/operations/reactive-redeploy

Issue a reactive re-deploy on a service instance.
saveInstance

Saves an instance

POST /service_management/saveInstance

Saves an instance
saveInstances

Save Instances

POST /service_management/saveInstances

Create a new service instance or update an existing service instance.
setServiceInstanceTenant

Set Tenant for a Service Instance

POST /service_management/service/setTenant

Set a tenant for a service instance.
testInstance

Tests an instance

POST /service_management/testInstance

Tests an instance
testInstances

Config Dry Run

POST /service_management/testInstances

Calculates the minimum device configuration commands required to save new service instances or update existing service instances.
updateNSOData

Get List of Merged Service Models

POST /service_management/service/models/update

This API call will return a list of Merged Fields for all Service Models.
updateServiceModelDatabase

Set/Update Service Model Fields

POST /service_management/service/model/database

This API call will post changes to Service Model Fields.
ViewDryRun

View Dry Run (manual workflow task)

/service_management/task/ViewDryRun
ViewDryRunService

View Dry Run Results (manual workflow task)

/service_management/task/ViewDryRunService
ViewServiceModelForm

View Service Model (manual workflow task)

/service_management/task/ViewServiceModelForm
ViewTestService

View Dry Run Results (manual workflow task)

/service_management/task/ViewTestService

FAQs

Service Desk

Developer Hub

On-Demand Webinars

Videos