Topology API
{ http://akana.com/wsdl/lc/1.0 } TopologyAPI
This API provides operations to maintain topologies.
GET/topologiesGet all topologies
Get all defined topologies
Reponse
PUT/topologiesUpdate a topology
Update an existing topology. Care should be taken to preserve environment names.
Parameters
tenants {
credentials {
atomLink {
properties {
environments {
configuration {
apiImplementationProfiles {
virtualServicePolicies {
physicalServicePolicies {
deploymentZoneDetails {
listenerDetails {
promotionProfiles {
deploymentZoneConfigurations {
rules {
resourceMappings {
targetResource {
sourceResource {
approvalProcesses {
policyMappings {
sourcePolicy {
sourcePolicyFilter {
targetPolicy {
processMappings {
sourceProcess {
targetProcess {
assetNotifications {
scriptMappings {
sourceScript {
targetScript {
filters {
classifierCriteria {
valueSetValue {
Reponse
POST/topologiesCreate a new topology
Create a new topology. The topology name must be unique.
Parameters
tenants {
credentials {
atomLink {
properties {
environments {
configuration {
apiImplementationProfiles {
virtualServicePolicies {
physicalServicePolicies {
deploymentZoneDetails {
listenerDetails {
promotionProfiles {
deploymentZoneConfigurations {
rules {
resourceMappings {
targetResource {
sourceResource {
approvalProcesses {
policyMappings {
sourcePolicy {
sourcePolicyFilter {
targetPolicy {
processMappings {
sourceProcess {
targetProcess {
assetNotifications {
scriptMappings {
sourceScript {
targetScript {
filters {
classifierCriteria {
valueSetValue {
Reponse
DELETE/topologies/{topology-name}Delete a topology
Delete the specified topology.
Parameters
Reponse
GET/topologies/{topology-name}Get the specified Topology
Get the topology specified by the topology name
Parameters
Reponse
tenants {
credentials {
atomLink {
properties {
environments {
configuration {
apiImplementationProfiles {
virtualServicePolicies {
physicalServicePolicies {
deploymentZoneDetails {
listenerDetails {
promotionProfiles {
deploymentZoneConfigurations {
rules {
resourceMappings {
targetResource {
sourceResource {
approvalProcesses {
policyMappings {
sourcePolicy {
sourcePolicyFilter {
targetPolicy {
processMappings {
sourceProcess {
targetProcess {
assetNotifications {
scriptMappings {
sourceScript {
targetScript {
filters {
classifierCriteria {
valueSetValue {
GET/topologies/{topology-name}/propertiesGet the properties for the specified Topology
Get the properties for the topology specified by the topology name
Parameters
Reponse
PUT/topologies/{topology-name}/propertiesSet the properties for the specified Topology
Set the properties for the topology specified by the topology name
Parameters
Reponse
POST/topologies/{topology-name}/environmentsAdd Environment
Add an Environment to the specified Topology
Parameters
Reponse
GET/topologies/{topology-name}/environmentsGet all Environments for Topology
Get all the Environments defined for the specified Topology
Parameters
Reponse
PUT/topologies/{topology-name}/environmentsUpdate an Environment
Update an existing Environment in the specified Topology
Parameters
Reponse
DELETE/topologies/{topology-name}/assetsDelete all assets in a Topology
Delete all assets in a Topology. This will also delete all mapping information between environments
Parameters
Reponse
PUT/topologies/{topology-name}/filtersUpdate a filter
Update an existing AssetFilter
Parameters
Reponse
POST/topologies/{topology-name}/tenantsAdd Tenant
Add a Tenant to the specified Environment in the specified Topology
Parameters
Reponse
GET/topologies/{topology-name}/tenantsGet all Tenants for a Topology
Get all Tenants defined for the specified Topology
Parameters
Reponse
PUT/topologies/{topology-name}/tenantsUpdate a Tenant
Update an existing Tenant in the specified Topology
Parameters
Reponse
POST/topologies/{topology-name}/filtersAdd Filter
Add an AssetFilter to the specified Topology
Parameters
Reponse
GET/topologies/{topology-name}/filtersGet the filters for Topology
Get the AssetFilters for the specified topology
Parameters
Reponse
DELETE/topologies/{topology-name}/environments/{environment-name}Delete an Environment
Delete the specified environment.
Parameters
Reponse
GET/topologies/{topology-name}/tenants/{tenant-name}Get a Tenant
Get the specified Tenant from the specified Topology
Parameters
Reponse
DELETE/topologies/{topology-name}/tenants/{tenant-name}Delete a Tenant
Delete the specified Tenant from the specified Topology
Parameters
Reponse
GET/topologies/{topology-name}/environments/{environment-name}Get an Environment
Get the specified Environment for the specified Topology
Parameters
Reponse
GET/topologies/{topology-name}/filters/{filter-name}Get an AssetFilter
Get the specified AssetFilter for the specified Topology
Parameters
Reponse
DELETE/topologies/{topology-name}/filters/{filter-name}Delete an AssetFilter
Delete the specified AssetFilter from the specified Topology
Parameters
Reponse
DELETE/topologies/{topology-name}/environments/{environment-name}/contextDelete the Environment's context information
Delete the context information for the specified Environment in the specified Topology
Parameters
Reponse
PUT/topologies/{topology-name}/environments/{environment-name}/configurationUpdate the Environment configuration
Update the configuration for the specified Environment in the specified Topology
Parameters
atomLink {
properties {
apiImplementationProfiles {
virtualServicePolicies {
physicalServicePolicies {
deploymentZoneDetails {
listenerDetails {
Reponse
DELETE/topologies/{topology-name}/environments/{environment-name}/configurationDelete the Environment's configuration
Delete the Configuration from the specified Environment in the specified Topology
Parameters
Reponse
POST/topologies/{topology-name}/environments/{environment-name}/profilesAdd PromotionProfile
Add a PromotionProfile to the specified Environment in the specified Topology
Parameters
deploymentZoneConfigurations {
rules {
atomLink {
resourceMappings {
targetResource {
sourceResource {
approvalProcesses {
policyMappings {
sourcePolicy {
sourcePolicyFilter {
targetPolicy {
processMappings {
sourceProcess {
targetProcess {
assetNotifications {
scriptMappings {
sourceScript {
targetScript {
properties {
Reponse
PUT/topologies/{topology-name}/environments/{environment-name}/profilesUpdate a PromotionProfile
Update an existing PromotionProfile in the specified Environment in the specified Topology
Parameters
deploymentZoneConfigurations {
rules {
atomLink {
resourceMappings {
targetResource {
sourceResource {
approvalProcesses {
policyMappings {
sourcePolicy {
sourcePolicyFilter {
targetPolicy {
processMappings {
sourceProcess {
targetProcess {
assetNotifications {
scriptMappings {
sourceScript {
targetScript {
properties {
Reponse
GET/topologies/{topology-name}/tenants/{tenant-name}/credentialsGet Credentials for Tenant
Get the Credentials for the specified Tenant in the specified Topology
Parameters
Reponse
PUT/topologies/{topology-name}/environments/{environment-name}/contextUpdate the context information for the Environment
Update the context information for the specified Environment, this information is used in validating dependencies of promoted assets
Parameters
processes {
apiVersions {
policies {
resources {
atomLink {
services {
scripts {
businesses {
properties {
Reponse
GET/topologies/{topology-name}/environments/{environment-name}/contextGet the context information
Get the context information for the specified Environment for the specified Topology
Parameters
Reponse
processes {
apiVersions {
policies {
resources {
atomLink {
services {
scripts {
businesses {
properties {
GET/topologies/{topology-name}/environments/{environment-name}/configurationGet the environment configuration
Get the configuration for the specified Environment for the specified Topology
Parameters
Reponse
atomLink {
properties {
apiImplementationProfiles {
virtualServicePolicies {
physicalServicePolicies {
deploymentZoneDetails {
listenerDetails {
DELETE/topologies/{topology-name}/environments/{environment-name}/assetsDelete assets for an Environment
Delete all assets associated with the specified environment. This will also delete all mapping information for assets associated with the specified environment
Parameters
Reponse
GET/topologies/{topology-name}/environments/{environment-name}/profilesGet all PromotionProfiles for an Environment
Get all PromotionProfiles defined for the specified Environment for the specified Topology
Parameters
Reponse
DELETE/topologies/{topology-name}/environments/{environment-name}/profiles/{profile-name}Delete a PromotionProfile
Delete the specified PromotionProfile from the specified Environment in the specified Topology
Parameters
Reponse
GET/topologies/{topology-name}/environments/{environment-name}/profiles/{profile-name}Get a PromotionProfile
Get the PromotionProfile for the specified Environment for the specified Topology
Parameters
Reponse
deploymentZoneConfigurations {
rules {
atomLink {
resourceMappings {
targetResource {
sourceResource {
approvalProcesses {
policyMappings {
sourcePolicy {
sourcePolicyFilter {
targetPolicy {
processMappings {
sourceProcess {
targetProcess {
assetNotifications {
scriptMappings {
sourceScript {
targetScript {
properties {
PUT/topologies/{topology-name}/tenants//{tenant-name}/credentialsUpdate Tenant Credentials
Update the Credentials for the specified Tenant in the specified Topology
Parameters
Reponse
POST/topologies/{topology-name}/environments/{environment-name}/context/syncSyncs the context information from the specified environment
Sync the latest context information from the specified Environment for the specified Topology
Parameters
Reponse
processes {
apiVersions {
policies {
resources {
atomLink {
services {
scripts {
businesses {
properties {
DELETE/topologies/{topology-name}/environments/{environment-name}/assets/{asset-id}Remove an asset and its mappings from an environment
Remove the specified asset from the specified environment. Note that this removes the asset only from Lifecycle Coordinator but not from the actual environment itself
Parameters
Reponse
PUT/topologies/{topology-name}/environments/{environment-name}/profiles/{profile-name}/scriptSet the mapping script
Add or replace the mapping script for the specified PromotionProfile
Parameters
Reponse
GET/topologies/{topology-name}/environments/{environment-name}/profiles/{profile-name}/scriptGet the mapping script
Get the contents of the mapping script for the specified PromotionProfile
Parameters
Reponse
DELETE/topologies/{topology-name}/environments/{environment-name}/profiles/{profile-name}/scriptDelete the mapping script
Delete the mapping script from the specified PromotionProfile
Parameters
Reponse
GET/topologies/{topology-name}/environments/{environment-name}/profiles/{profile-name}/rulesGet Rules for PromotionProfile
Get the Rules defined for the specified PromotionProfile in the specified Environment and Topology
Parameters
Reponse
GET/topologies/{topology-name}/environments/{environment-name}/profiles/{profile-name}/mappingsGet stored mappings for the PromotionProfile
Get the mappings stored for between the source and target environments
Parameters
Reponse
GET/topologies/{topology-name}/environments/{environment-name}/profiles/{profile-name}/deploymentsGet all DeploymentZoneConfigurations for a PromotionProfile
Get all DeploymentZoneConfigurations defined for the specified PromotionProfile in the specified Environment and Topology
Parameters
Reponse
PUT/topologies/{topology-name}/environments/{environment-name}/profiles/{profile-name}/rulesUpdate a the mapping rules
Update the mapping Rules for a PromotionProfile in the specified Environment in the specified Topology
Parameters
Reponse
PUT/topologies/{topology-name}/environments/{environment-name}/profiles/{profile-name}/mappingsAdd or replace the specified mappings
The specified mappings will be added to or replace matching existing mappings for the source and target environments
Parameters
Reponse
GET/topologies/{topology-name}/environments/{environment-name}/assets/{asset-id}/packageGet the promoted archive for the specified asset
Request promotion of an api version from the specified Environment in the specified Topology
Parameters
Reponse
POST/topologies/{topology-name}/environments/{environment-name}/assets/apis/{api-version-id}/promotePromote an API
Request promotion of an api version from the specified Environment in the specified Topology
Parameters
Reponse
POST/topologies/{topology-name}/environments/{environment-name}/assets/apps/{app-version-id}/promotePromote an App
Request promotion of an application version from the specified Environment in the specified Topology
Parameters
Reponse
GET/topologies/{topology-name}/environments/{environment-name}/profiles/{profile-name}/deployments/{deploymentzone-configuration-name}/rulesGet Rules for DepolymentZoneConfiguration
Get the Rules defined for the specified DeploymentZoneConfiguration in the specified PromotionProfile in the specified Environment and Topology