API Version Lifecycle and Status

Various API status are given below:

  • Active: An active API version is the most current and fully supported API. It is the recommended version that should be used by everyone.

  • Deprecated: A deprecated API version is superseded by a newer API version. It is available for the release in which it is deprecated and also available for one additional release.

    For example, if an API is deprecated in release 1.2.0, this API will be available in release 1.3.0, but maybe decommissioned in release 1.4.0.

    New consumers are denied access to the deprecated APIs (enforcement policy pending).

  • Retired: A retired API version is an API that should have been decommissioned but due to extenuating circumstances, it is still in use. The API is no longer supported (no bug fixes) and it includes any API deprecated for more than two releases. Any application using a retired API must migrate to an active API.

  • Decommissioned: A decommissioned API version is no longer available in production. This typically occurs after an API is deprecated in two releases.

State Transition

Active > Deprecated > Retired (Optional) > Decommissioned

Table 1. API Version Status Table

Active

Deprecated

Retired

Decommissioned

API is live in production.

API is live in production.

API is live in production.

API is NOT available in production.

Documentation*: Available for review at launch.

Documentation: Deprecated status indicated and posted on day of deprecation.

Documentation: Retired status indicated and posted on day of retirement.

Documentation: N/A

Support: Updated with bug fixes and new features are available.

Support: Updated with bug fixes for a release only.

Support: None

Support: None

Release Notes: Notify at launch.

Release Notes: Notify on release day; Announce when deprecated.

Release Notes: Notify prior release; Announce when retired.

Release Notes: Notify prior release.

Deprecated APIs

This section contains the list of deprecated APIs, retired APIs, and decommissioned APIs of Cisco MSX. The table below has both original APIs and the APIs that are replacing these original APIs.

The deprecated APIs are:

Deprecated APIs in Cisco MSX 4.3

No APIs have been deprecated.

Deprecated APIs in Cisco MSX 4.2

No APIs have been deprecated.

Retired APIs from Cisco MSX

The table below has APIs that had been deprecated from Cisco MSX releases and may be decommissioned at any time. For more information on retired status, see API Version Lifecycle and Status.

Table 2. APIs Retired from Cisco MSX

Category

Deprecated API

Replacement API

Administration

Global Settings

 
GET
 
/administration/api/v1/
globalsettings
 
GET /administration/api/v2/
globalsettings

Global Settings

 
PUT
 
/administration/api/v1/
globalsettings
 
PUT /administration/api/v2/
globalsettings/{globalSettingId}

Incident

Configuration

 
GET
 
/incident/api/v1/config
 
GET /incident/api/v8/configurations,
GET /incident/api/v8/configurations/{id}

Configuration

 
PATCH
 
/incident/api/v1/config

N/A

Configuration

 
PUT
 
/incident/api/v1/config
 
POST /incident/api/v8/configurations

Manage

Device Templates

 
POST
 
/manage/api/v1/devicetemplates
 (MIME type: multipart/form-data)
 
POST /manage/api/v8/devicetemplates

Device Templates

 
DELETE
 
/manage/api/v3/devices/{deviceId}
/templates
 
DELETE /manage/api/v8/devices/{id}/templates

Device Templates

 
GET
 
/manage/api/v3/devices/{deviceId}
/templates
 
GET /manage/api/v8/devices/{id}/templates

Device Templates

 
POST
 
/manage/api/v3/devices/{deviceId}
/templates
 
POST /manage/api/v8/devices/{id}/templates

Device Templates

 
PUT
 
/manage/api/v3/devices/{deviceId}
/templates
 
PUT /manage/api/v8/devices/{id}/templates

Device Templates

 
DELETE
 
/manage/api/v3/devices/{deviceId}/
templates/{templateId}
 
DELETE /manage/api/v8/devices/{id}/templates
/{templateId}

Device Templates

 
DELETE
 
/manage/api/v4/devices/{id}/
templates
 
DELETE /manage/api/v8/devices/{id}/templates

Device Templates

 
POST
 
/manage/api/v8/parameters/scan

N/A

Devices

 
GET
 
/manage/api/v1/devices/aggregate

N/A

Devices

 
GET
 
/manage/api/v3/devices/{deviceId}
/config
 
GET /manage/api/v8/devices/{id}
/config

Devices

 
POST
 
/manage/api/v3/devices/{deviceId}
/redeploy
 
POST /manage/api/v8/devices/{id}
/redeploy

Devices

 
GET
 
/manage/api/v4/devices
 
GET /manage/api/v8/devices

Devices

 
POST
 
/manage/api/v4/devices
 
POST /manage/api/v8/devices

Devices

 
DELETE
 
/manage/api/v4/devices/{id}
 
DELETE /manage/api/v8/devices/{id}

Devices

 
GET
 
/manage/api/v4/devices/{id}
 
GET /manage/api/v8/devices/{id}

Devices

 
PUT
 
/manage/api/v4/devices/{id}
 
PUT /manage/api/v8/devices/{id},
 PATCH /manage/api/v8/devices/{id}

Services

 
DELETE
 
/manage/api/v1/serviceinstances/
{serviceInstanceId}
 
DELETE /manage/api/v8/services/{id}

Services

 
PUT
 
/manage/api/v1/serviceinstances/
{serviceInstanceId}
 
PUT /manage/api/v8/services/{id}

Services

 
GET
 
/manage/api/v1/serviceinstances/
subscriptions/{subscriptionId}

N/A

Services

 
POST
 
/manage/api/v1/serviceinstances/
subscriptions/{subscriptionId}
 
POST /manage/api/v8/services

Services

 
POST
 
/manage/api/v1/services/
{serviceId}/offers/{offerId}
 
POST /manage/api/v8/services/{serviceId}
/offers/{offerId}

Services

 
PUT
 
/manage/api/v1/services/
{serviceId}/offers/{offerId}
 
PUT /manage/api/v8/services/{serviceId}
/offers/{offerId}

Services

 
GET
 
/manage/api/v2/serviceinstances/
{serviceInstanceId}
 
GET /manage/api/v8/services/{id}

Services

 
GET
 
/manage/api/v2/serviceinstances
/subscriptions/{subscriptionId}

N/A

Sites

 
GET
 
/manage/api/v2/site/device/
{deviceInstanceId}
 
GET /manage/api/v8/sites/{id}

Sites

 
GET
 
/manage/api/v3/sites
 
GET /manage/api/v8/sites

Sites

 
POST
 
/manage/api/v3/sites
 
POST /manage/api/v8/sites

Sites

 
DELETE
 
/manage/api/v3/sites/{id}
 
DELETE /manage/api/v8/sites/{id}

Sites

 
GET
 
/manage/api/v3/sites/{id}
 
GET /manage/api/v8/sites/{id}

Sites

 
PUT
 
/manage/api/v3/sites/{id}
 
PUT /manage/api/v8/sites/{id}

Sites

 
DELETE
 
/manage/api/v3/sites/{id}/devices/
{deviceId}
 
POST /manage/api/v8/sites/{id}/devices
/remove

Sites

 
PUT
 
/manage/api/v3/sites/{id}/devices/
{deviceId}
 
POST /manage/api/v8/sites/{id}/devices
/add

Sites

 
DELETE
 
/manage/api/v3/sites/{id}/services/
{serviceInstanceId}
 
POST /manage/api/v8/sites/{id}/services
/remove

Sites

 
PUT
 
/manage/api/v3/sites/{id}/services/
{serviceInstanceIds}
 
POST /manage/api/v8/sites/{id}/services
/add

Sites

 
PUT
 
/manage/api/v3/sites/{id}/status

N/A

Monitor

Metrics

 
GET
 
/monitor/api/v1/metrics/
status/history

N/A

Query

 
PUT
 
/monitor/api/v1/query/devicehealth
 
PUT /monitor/api/v2/query/
devicehealth

Query

 
GET
 
/monitor/api/v1/query/devicehealth/
{deviceId}
 
GET /monitor/api/v2/query/
devicehealth/{deviceId}

Query

 
POST
 
/monitor/api/v1/query/servicemetric
 
POST /monitor/api/v2/query

Query

 
PUT
 
/monitor/api/v1/query/servicemetric
 
PUT /monitor/api/v2/query/
servicemetric

Query

 
DELETE
 
/monitor/api/v1/query/
servicemetric/{serviceId}
 
DELETE /monitor/api/v2/query/
servicemetric/{serviceId}

Query

 
GET
 
/monitor/api/v1/query/
servicemetric/{serviceId}
 
GET /monitor/api/v2/query/
servicemetric/{serviceId}

Query

 
GET
 
/monitor/api/v1/template/devicehealth
 
GET /monitor/api/v2/querytemplates/
device

Query

 
POST
 
/monitor/api/v1/template/devicehealth
 
POST /monitor/api/v2/querytemplates/
device

Query

 
DELETE
 
/monitor/api/v1/template/devicehealth/
{type}/{profile}/{specifictype}
 
DELETE /monitor/api/v2/querytemplates/
device/{type}/{profile}/{specifictype}

Query

 
GET
 
/monitor/api/v1/template/devicehealth/
{type}/{profile}/{specifictype}
 
GET /monitor/api/v2/querytemplates/
device/{type}/{profile}/{specifictype}

Query

 
GET
 
/monitor/api/v1/template/servicemetric
 
GET /monitor/api/v2/querytemplates/
service

Query

 
POST
 
/monitor/api/v1/template/servicemetric
 
POST /monitor/api/v2/querytemplates/
service

Query

 
DELETE
 
/monitor/api/v1/template/servicemetric/
{servicename}
 
DELETE /monitor/api/v2/querytemplates/
service/{servicename}

Query

 
GET
 
/monitor/api/v1/template/servicemetric/
{servicename}
 
GET /monitor/api/v2/querytemplates/
service/{servicename}

Health

 
GET
 
/monitor/api/v2/health/devices
 N/A

Health

 
GET
 
/monitor/api/v2/health/services
 N/A

Orchestration

Catalogs

 
GET
 
/orchestration/api/v1/shards/
{shardId}/config/catalog/
 
GET /orchestration/api/v1/
services/{serviceType}/config/catalog/

Catalogs

 
POST
 
/orchestration/api/v1/shards/
{shardId}/config/catalog/
 
PUT /orchestration/api/v1/
services/{serviceType}/config/catalog/{id}

Catalogs

 
DELETE
 
/orchestration/api/v1/shards/
{shardId}/config/catalog/{id}
 
DELETE /orchestration/api/v1/
services/{serviceType}/config/catalog/{id}

Catalogs

 
GET
 
/orchestration/api/v1/shards/
{shardId}/config/catalog/{id}
 
GET /orchestration/api/v1/
services/{serviceType}/config/catalog/{id}

Catalogs

 
PUT
 
/orchestration/api/v1/shards/
{shardId}/config/catalog/{id}
 
PUT /orchestration/api/v1/
services/{serviceType}/config/catalog/{id}

NSDs

 
GET
 
/orchestration/api/v1/shards/
{shardId}/config/nfvo/nsd/
 
GET /orchestration/api/v1/
services/{serviceType}/config/nfvo/nsd/

NSDs

 
POST
 
/orchestration/api/v1/shards/
{shardId}/config/nfvo/nsd/
 
PUT /orchestration/api/v1/
services/{serviceType}/config/nfvo/nsd/{id}

NSDs

 
DELETE
 
/orchestration/api/v1/shards/
{shardId}/config/nfvo/nsd/{id}
 
DELETE /orchestration/api/v1/
services/{serviceType}/config/nfvo/nsd/{id}

NSDs

 
GET
 
/orchestration/api/v1/shards/
{shardId}/config/nfvo/nsd/{id}
 
GET /orchestration/api/v1/
services/{serviceType}/config/nfvo/nsd/{id}

NSDs

 
PUT
 
/orchestration/api/v1/shards/
{shardId}/config/nfvo/nsd/{id}
 
PUT /orchestration/api/v1/
services/{serviceType}/config/nfvo/nsd/{id}

Other

 
POST
 
/orchestration/api/v1/subscription
 
POST /orchestration/api/v1/submit

VNFDs

 
GET
 
/orchestration/api/v1/shards/
{shardId}/config/nfvo/vnfd/
 
GET /orchestration/api/v1/
services/{serviceType}/config/nfvo/vnfd/

VNFDs

 
POST
 
/orchestration/api/v1/shards/
{shardId}/config/nfvo/vnfd/
 
PUT /orchestration/api/v1/
services/{serviceType}/config/nfvo/vnfd/{id}

VNFDs

 
DELETE
 
/orchestration/api/v1/shards/
{shardId}/config/nfvo/vnfd/{id}
 
DELETE /orchestration/api/v1/
services/{serviceType}/config/nfvo/vnfd/{id}

VNFDs

 
GET
 
/orchestration/api/v1/shards/
{shardId}/config/nfvo/vnfd/{id}
 
GET /orchestration/api/v1/
services/{serviceType}/config/nfvo/vnfd/{id}

VNFDs

 
PUT
 
/orchestration/api/v1/shards/
{shardId}/config/nfvo/vnfd/{id}
 
PUT /orchestration/api/v1/
services/{serviceType}/config/nfvo/vnfd/{id}

Service Configuration

Applications

 
POST
 
/template/api/v1/serviceconfigurations/
{serviceConfigId}/applications/
{applicationId}/status
 
PATCH /template/api/v8/templates
/applications/{id}

Applications

 
GET
 
/template/api/v1/serviceconfigurations/
{serviceConfigId}/applications/target/
{targetEntityType}/{targetEntityId}
 
GET /template/api/v8/
templates/applications

Applications

 
GET
 
/template/api/v1/serviceconfigurations/
applications
 
GET /template/api/v8/
templates/applications

Applications

 
POST
 
/template/api/v1/serviceconfigurations/
applications
 
POST /template/api/v8/
templates/{id}/applications

Applications

 
DELETE
 
/template/api/v1/serviceconfigurations/
applications/{id}
 
DELETE /template/api/v8/
templates/applications/{id}

Applications

 
GET
 
/template/api/v1/serviceconfigurations/
applications/{id}
 
GET /template/api/v8/
templates/applications/{id}

Application Audit

 
GET
 
/template/api/v1/serviceconfigurations/
applications/audits
 
GET /template/api/v8/templates/
applications/{id}/history

Assignments

 
GET
 
/template/api/v1/serviceconfigurations/
assign/{id}
 
GET /template/api/v8/templates/
assignments/{id}

Assignments

 
DELETE
 
/template/api/v1/serviceconfigurations/
assign/{serviceConfigId}
 
POST /template/api/v8/templates/
{id}/assignments/remove

Assignments

 
POST
 
/template/api/v1/serviceconfigurations/
assign/{serviceConfigId}
 
POST /template/api/v8/
templates/{id}/assignments/add

Assignments

 
GET
 
/template/api/v1/serviceconfigurations/
assign/all
 
GET /template/api/v8/
templates/assignments

Assignments

 
GET
 
/template/api/v1/serviceconfigurations/
assign/config/{serviceConfigId}
 
GET /template/api/v8/
templates/assignments

Assignments

 
POST
 
/template/api/v1/serviceconfigurations/
assign/events/{serviceConfigId}/
{assignedTenantId}
 
PATCH /template/api/v8/
templates/assignments/{id}

Assignments

 
GET
 
/template/api/v1/serviceconfigurations/
assign/tenants/{serviceConfigId}
 
GET /template/api/v8/
templates/assignments

Audit

 
GET
 
/template/api/v1/serviceconfigurations/
audit/all
 N/A

Audit

 
GET
 
/template/api/v1/serviceconfigurations/
audit/byScId/{serviceConfigId}
 
GET /template/api/v8/
templates/{id}/history

Audit

 
GET
 
/template/api/v1/serviceconfigurations/
audit/byTenantId/{tenantId}
 N/A

Configurations

 
GET
 
/template/api/v1/serviceconfigurations
 
GET /template/api/v8/templates

Configurations

 
POST
 
/template/api/v1/serviceconfigurations
 
POST /template/api/v8/templates

Configurations

 
PUT
 
/template/api/v1/serviceconfigurations
 N/A

Configurations

 
DELETE
 
/template/api/v1/serviceconfigurations/
{serviceConfigId}
 
DELETE /template/api/v8/templates/{id}

Configurations

 
GET
 
/template/api/v1/serviceconfigurations/
{serviceConfigId}
 
GET /template/api/v8/templates/{id}

Configurations

 
POST
 
/template/api/v1/serviceconfigurations/
events/{serviceConfigId}
 
PATCH /template/api/v8/templates/{id}

Usermanagement/IDM

Tenants

 
GET
 
/idm/api/v1/tenants/{tenantName}
 
GET /idm/api/v8/tenants/{id}

Tenants

 
GET
 
/idm/api/v3/tenants
 
GET /idm/api/v8/tenants

Tenants

 
POST
 
/idm/api/v3/tenants
 
POST /idm/api/v8/tenants

Tenants

 
PUT
 
/idm/api/v3/tenants/{id}
 
PUT /idm/api/v8/tenants/{id}

Tenants

 
GET
 
/idm/api/v3/tenants/{tenantId}
 
GET /idm/api/v8/tenants/{id}

Tenants

 
DELETE
 
/idm/api/v3/tenants/{tenantName}
 
DELETE /idm/api/v8/tenants/{id}

Users

 
GET
 
/idm/api/v1/pwdpolicy/userId/
{userId}
 
GET /idm/api/v1/policies/{name}

Users

 
GET
 
/idm/api/v1/pwdpolicy/userId
/{userId}/token/{token}
 
GET /idm/api/v1/pwdpolicy/userId
/{userId}

Users

 
PUT
 
/idm/api/v1/update_password
 
PUT /idm/api/v8/users/{id}/
updatepassword

Users

 
GET
 
/idm/api/v1/users/capabilities
 
GET /idm/api/v8/users/{id},
GET /idm/api/v8/roles/list

Users

 
PUT
 
/idm/api/v1/users/identity
 
PUT /idm/api/v8/users/{id}/
updatepassword

Users

 
GET
 
/idm/api/v1/users/suggestPassword
/{userId}/token/{token}
 
GET /idm/api/v1/users/suggestPassword
/{userId}

Users

 
GET
 
/idm/api/v1/users/tenants
 
GET /idm/api/v8/users/{id}

Users

 
GET
 
/idm/api/v1/users/uuid/{id}
 
GET /idm/api/v8/users/{id}

Users

 
GET
 
/idm/api/v2/users
 
GET /idm/apiv8/users

Users

 
DELETE
 
/idm/api/v2/users/{id}
 
DELETE /idm/api/v8/users/{id}

Users

 
PUT
 
/idm/api/v2/users/{id}
 
PUT /idm/api/v8/users/{id}

Workflow

Categories

 
GET
 
/workflow/api/v1/categories
 
GET /workflow/api/v8/categories
/list

Categories

 
POST
 
/workflow/api/v1/categories
 
POST /workflow/api/v8/categories

Categories

 
DELETE
 
/workflow/api/v1/categories/{id}
 
DELETE /workflow/api/v8/categories/{id}

Categories

 
GET
 
/workflow/api/v1/categories/{id}
 
GET /workflow/api/v8/categories/{id}

Categories

 
PUT
 
/workflow/api/v1/categories/{id}
 
PUT /workflow/api/v8/categories/{id}

Events

 
GET
 
/workflow/api/v1/events
 
GET /workflow/api/v8/events/list

Events

 
POST
 
/workflow/api/v1/events
 
POST /workflow/api/v8/events

Events

 
DELETE
 
/workflow/api/v1/events/{id}
 
DELETE /workflow/api/v8/categories/{id}

Events

 
GET
 
/workflow/api/v1/events/{id}
 
GET /workflow/api/v8/events/{id}

Events

 
PUT
 
/workflow/api/v1/events/{id}
 
PUT /workflow/api/v8/
categories/{id}

Schemas

 
GET
 
/workflow/api/v1/schemas
 
GET /workflow/api/v8/schemas/list

Schemas

 
GET
 
/workflow/api/v1/schemas/{id}
 
GET /workflow/api/v8/schemas/{id}

Targets

 
GET
 
/workflow/api/v1/targets
 
GET /workflow/api/v8/targets/list

Targets

 
POST
 
/workflow/api/v1/targets
 
POST /workflow/api/v8/targets

Targets

 
DELETE
 
/workflow/api/v1/targets/{id}
 
DELETE /workflow/api/v8/targets/{id}

Targets

 
GET
 
/workflow/api/v1/targets/{id}
 
GET /workflow/api/v8/targets/{id}

Targets

 
PUT
 
/workflow/api/v1/targets/{id}
 
PUT /workflow/api/v8/targets/{id}

Workflow Instances

 
DELETE
 
/workflow/api/v1/workflows/
instances/{id}
 
DELETE /workflow/api/v8/workflows
/instances/{id}

Workflow Instances

 
GET
 
/workflow/api/v1/workflows/
instances/{id}
 
GET /workflow/api/v8/workflows
/instances/{id}

Workflow Instances

 
GET
 
/workflow/api/v1/workflows
/instances/{id}/actions/{actionId}
 
GET /workflow/api/v8/workflows
/instances/{id}/actions/{actionId}

Workflow Instances

 
POST
 
/workflow/api/v1/workflows
/instances/{id}/cancel
 
POST /workflow/api/v8/workflows
/instances/{id}/cancel

Workflows

 
POST
 
/workflow/api/v1.1/workflows

N/A

Workflows

 
GET
 
/workflow/api/v1/workflows
 
GET /workflow/api/v8/workflows/list

Workflows

 
POST
 
/workflow/api/v1/workflows
 
POST /workflow/api/v8/workflows

Workflows

 
DELETE
 
/workflow/api/v1/workflows/{id}
 
DELETE /workflow/api/v8/workflows/{id}

Workflows

 
GET
 
/workflow/api/v1/workflows/{id}
 
GET /workflow/api/v8/workflows/{id}

Workflows

 
PUT
 
/workflow/api/v1/workflows/{id}
 
PUT /workflow/api/v8/workflows/{id}

Workflows

 
GET
 
/workflow/api/v1/workflows/
{id}/export
 
GET /workflow/api/v8/workflows/{id}/
export

Workflows

 
GET
 
/workflow/api/v1/workflows/
{id}/instances
 
GET /workflow/api/v8/workflows/
{id}/instances/list

Workflows

 
POST
 
/workflow/api/v1/workflows/
{id}/start
 
POST /workflow/api/v8/workflows
/{id}/start

Workflows

 
GET
 
/workflow/api/v1/workflows/
{id}/startconfig
 
GET /workflow/api/v8/workflows
/{id}/startconfig

Workflows

 
POST
 
/workflow/api/v1/workflows/
{id}/validate
 
POST /workflow/api/v8/
workflows/{id}/validate

Workflows

 
GET
 
/workflow/api/v1/workflows/
mapping/uniqueName/{uniqueName}
 
GET /workflow/api/v8/workflows/
mapping/uniquename/{uniqueName}

Decommissioned APIs from Cisco MSX 4.3.0

No APIs have been decommissioned.