Runtime APIs
Learn about the various APIs you can use to create, manage, and configure integration runtimes.
Learn about the various APIs you can use to create, manage, and configure integration runtimes.
The Runtime Management APIs allow you to create and manage runtimes. For more information on runtime management, see Register Edge Runtimes, Integartion Runtimes Management and Integration Runtimes Access Privileges.
All runtimes use the Base URL, https://host/apis/v1/rest/control-plane/runtimes.
All runtime APIs use Basic Tenant authentication for Authorization.
Status Codes: The following errors appear when,
400 Bad request
: Incorrect runtime details are provided.401 Unauthorized
: Perform any actions on a runtime without being its owner.403 Forbidden
: Permission is not available for you to access the runtime.500
: Runtime is not reachable or does not respond.Allows you to retrieve the list of all runtimes including the default Cloud Designtime and Cloud Runtime details. The instances associated with runtimes are not listed by default. If you want to view even them, include the parameter includeInstances and set it to true.
../runtimes/
Parameters
includeInstances
: [Optional] Specify one of the following values:
true
: Displays the specific runtime details along with instance information.
false
: Displays the runtime details without any instance information. This is the default setting.
Content-Type: application/json
None
If the request is successful, you receive the HTTP 200 OK success status response code.
[
{
"agentID": "1ba0a988c99d11ef9cd20242ac120002",
"agentGroup": "default",
"name": "MyEdge1",
"description": "Edge server running on local.",
"createdDate": 1735796517000,
"modifiedDate": 1735796839000,
"status": "Running",
"permission": [
"MANAGE",
"ACCESS"
],
"visibility": "PRIVATE",
"owner": {
"fullName": "webMethodsIntegration Administrator",
"userId": "6173cacbf3f64dc5aede0691f7479b62"
}
},
{
"agentID": "38a748d4c99d11ef9cd20242ac120002",
"agentGroup": "default",
"name": "MyEdge2",
"description": "Edge server running on local",
"createdDate": 1735886338000,
"modifiedDate": 1735886357000,
"status": "Running",
"permission": [
"MANAGE",
"ACCESS"
],
"visibility": "PRIVATE",
"owner": {
"fullName": "webMethodsIntegration Administrator",
"userId": "6173cacbf3f64dc5aede0691f7479b62"
}
}
]
Allows you to retrieve the details of a specific runtime.
../<runtimeAlias>?includeInstances=<true>
Parameters
runtimeAlias
: Alias (alternative name) that is used to represent a runtime.
includeInstances
: [Optional] Specify one of the following values:
true
: Displays the specific runtime details along with instance information. This is the default setting.
false
: Displays the runtime details without any instance information.
Content-Type: application/json
None
If the request is successful, you receive the HTTP 200 OK success status response code.
If includeInstances=\<true\>
:
{
"agentID": "4dd48e1a90294421b34f6346a272ab3e",
"agentGroup": "default",
"name": "LocalWSLEdge",
"description": "Edge server running on local WSL",
"createdDate": 1735796517000,
"modifiedDate": 1735796839000,
"status": "Running",
"instances": [
{
"instanceID": "9973c9bf5c99",
"status": "Unknown"
}
],
"permission": [
"MANAGE",
"ACCESS"
],
"visibility": "PRIVATE",
"owner": {
"fullName": "webMethodsIntegration Administrator",
"userId": "6173cacbf3f64dc5aede0691f7479b62"
}
}
If includeInstances=\<false\>
:
{
"agentID": "4dd48e1a90294421b34f6346a272ab3e",
"agentGroup": "default",
"name": "LocalWSLEdge",
"description": "Edge server running on local WSL",
"createdDate": 1735796517000,
"modifiedDate": 1735796839000,
"status": "Running",
"permission": [
"MANAGE",
"ACCESS"
],
"visibility": "PRIVATE",
"owner": {
"fullName": "webMethodsIntegration Administrator",
"userId": "6173cacbf3f64dc5aede0691f7479b62"
}
}
If you are not the owner of a runtime:
{
"message":
{
"code": -1,
"description": "401-Unauthorized"
}
}
Allows you to register a new logical entity for a runtime. This entity is not yet ready to perform any operations. You must pair in order to use this runtime. In the Integration Runtimes page, the runtime card is created and it is in offline state.
../runtimes/
Parameters
name
: Name of the runtime.
description
: [Optional] Short description about the runtime.
visibility
: [Optional] Specify one of the values:
{
"name":"[runtime name]",
"description":"[optional runtime Description for self-reference]",
"visibility":"[optional private or public]"
}
Content-Type: application/json
If the request is successful, you receive the HTTP 201 Created success status response code.
{
"name": "SampleEdge_1",
"agentID": "5c81755566b44f7089085803f4b9be10",
"createdDate": 1733373434260
}
Allows you to generate a pairing token for a runtime instance. Pairing token can be used to bring up the new runtime instance and assocaite it with the logical entity. This API also provides the docker run command that can be used to start a runtime instance in a container.
../<runtimeAlias>/instances/new-pairing-request
Parameters
runtimeAlias
: Alias (alternative name) that is used to represent a runtime.Content-Type: application/json
None
If the request is successful, you receive the HTTP 200 OK success status response code.
{
"agentId": "14fe873f37f2495fb26a78d3e037db31",
"agentName": "testedgepub1",
"env": {
"SAG_IS_CLOUD_REGISTER_URL": "https://host",
"SAG_IS_CLOUD_REGISTER_TOKEN": "ba51541ca8884b73850793c65ed51799d76e10bc496d4cb09620431287071d6f",
"SAG_IS_EDGE_CLOUD_ALIAS": "EdgeRuntime_87071d6f"
},
"imageRegistryURL": "iregistry.infra.webmethods.io/aim/msr-edge-runtime:latest",
"dockerRunCommand": "docker run -p 5555:5555 -d -e SAG_IS_CLOUD_REGISTER_URL=https://host -e SAG_IS_EDGE_CLOUD_ALIAS=EdgeRuntime_testedgePub1 -e SAG_IS_CLOUD_REGISTER_TOKEN=ba51541ca8884b73850793c65ed51799d76e10bc496d4cb09620431287071d6f --name=testedgePub1_87071d6f iregistry.infra.webmethods.io/aim/msr-edge-runtime:latest"
}
Allows you to update the description of a runtime.
../{runtimeAlias}
Parameters
runtimeAlias
: Alias (alternative name) that is used to represent a runtime.Content-Type: application/json
{
"description":"[optional runtime Description for self-reference]"
}
If the request is successful, you receive the HTTP 200 OK success status response code.
Allows you to enable or disable a runtime.
For enabling a runtime: ../<runtimeAlias>/enable
For disabling a runtime: ../<runtimeAlias>/disable
Parameters
runtimeAlias
: Alias (alternative name) that is used to represent a runtime.Content-Type: application/json
None
If the request is successful, you receive the HTTP 200 OK success status response code.
Allows you to ping a runtime to verify it’s availabilty.
../<runtimeAlias>/ping
Parameters
runtimeAlias
: Alias (alternative name) that is used to represent a runtime.Content-Type: application/json
None
If the request is successful, you receive the HTTP 200 OK success status response code.
{
"$status": "success"
}
Allows you to ping a runtime instance to verify it’s availabilty.
../<runtimeAlias>/instances/<{instanceID}>/ping
Parameters
runtimeAlias
: Alias (alternative name) that is used to represent a runtime.
instanceID
: Unique identification number of the instance.
Content-Type: application/json
None
If the request is successful, you receive the HTTP 200 OK success status response code.
{
"$status": "success"
}
Allows you to deregister edge runtimes if you do not want to use them in the future. Deregistering an edge runtime removes all instances associated with that edge runtime. The runtime is no longer available in the Integration Runtimes page. However, the instances still continue running in your environment, but they would not be able to communicate with the control plane.
../<runtimeAlias>
Parameters
runtimeAlias
: Alias (alternative name) that is used to represent a runtime.Content-Type: application/json
None
If the request is successful, you receive the HTTP 204 No Content success status response code.
Allows you to delete a particular instance of an edge runtime.
../<runtimeAlias>/instances/<{instanceID}>
Parameters
runtimeAlias
: Alias (alternative name) that is used to represent a runtime.
instanceID
: Unique identification number of the instance.
Content-Type: application/json
None
If the request is successful, you receive the HTTP 204 No Content success status response code.
The Runtime Configuration APIs allow you to manage global configurations of a runtime. The following configurations are supported:
All runtimes use the Base URL, https://host/apis/v1/rest/control-plane/runtimes.
All runtime APIs use Basic Tenant authentication for Authorization.
Allows you to retrieve names of all extended settings configured for Cloud Designtime.
Usage: Cloud Designtime
../default/configurations/settings
Parameters
None
None
[
{
"assetId": "watt.server.coder.responseAsXML",
"type": "settings"
},
{
"assetId": "watt.client.data.maxToStringLength ",
"type": "settings"
}
]
Allows you to retrieve the value of a setting.
Usage: Cloud Designtime, Cloud Runtime, Edge Runtime
../<runtime-alias>/configurations/settings/<asset-id>
Parameters
runtime-alias
: Name of the Edge Runtime. Specify the value as default
for Cloud Designtime and CloudRuntime
for Cloud Runtime.
asset-id
: Name of the extended setting such as, watt.server.coder.responseAsXML.
For example, ../default/configurations/settings/watt.server.coder.responseAsXML
None
{
"propertyKey": "watt.server.coder.responseAsXML",
"value": "true"
}
Allows you to set a new value for the extended setting. This value is not updated immediately unless you run the Synchronize Extended Setting Configuration API or set the updateRuntime
value to true
.
Usage: Cloud Designtime, Cloud Runtime, Edge Runtime
../<runtime-alias>/settings/configurations/<asset-id>?updateRuntime=(true|false)
Parameters
runtime-alias
: Name of the Edge Runtime. Specify the value as default
for Cloud Designtime and CloudRuntime
for Cloud Runtime.
asset-id
: Name of the extended setting such as, watt.server.coder.responseAsXML.
For example, /default/configurations/settings/watt.server.coder.responseAsXML
updateRuntime
: Set with one of the following values:
true
: Value of the extended setting is synchronized with runtime.
false
: Value of the extended setting is updated when the runtime is restarted or when you run the Synchronize Extended Setting value API. This is the default setting.
For example, ../default/configurations/settings/watt.server.coder.responseAsXML
Content-Type: application/json
{
"value": "false"
}
If the request is successful, the HTTP 200 OK success status response code is received.
{
"code": 0,
"description": "Property was updated successfully. Synchronize with <runtime-alias> to apply the changes."
}
If updateRuntime
is set to true
, then the following response is received:
{
"code": 0,
"description": "Property was updated successfully. The synchronization process has started. Check the <runtime-alias> for more details later."
}
Allows you to synchronize the configured setting with the runtime.
Usage: Cloud Designtime, Cloud Runtime, Edge Runtime
../<runtime-alias>/configurations/settings/<asset-id>/sync
Parameters
runtime-alias
: Name of the Edge Runtime. Specify the value as default
for Cloud Designtime and CloudRuntime
for Cloud Runtime.
asset-id
: Name of the extended setting such as, watt.server.coder.responseAsXML.
For example, ../default/configurations/settings/watt.net.maxRetries/sync
None
{
"code": 0,
"description": "The synchronization process has started. Check the <runtime-alias> for more details later."
}
Allows you to retrieve names of all global variables configured for Cloud Designtime.
Usage: Cloud Designtime
../default/globalvariable
Parameters
None
Content-Type: application/json
None
[
{
"assetId": "globalvariable.OnPremiseISPkg.username",
"displayName": "username",
"type": "globalvariable"
},
{
"assetId": "globalvariable.OnPremiseISPkg.Password",
"displayName": "Password",
"type": "globalvariable"
}
]
Allows you to set a new value for the global variable in Cloud Designtime. This value is not updated immediately unless you run the Synchronize Global Variables API or set the updateRuntime
value to true
.
Usage: Cloud Designtime, Edge Runtime
/default/globalvariable/
Parameters
asset-id
: Name of the global variable.
updateRuntime
: Set with one of the following values:true
: Value of the global variable is synchronized with runtime.
false
: Value is applied when the runtime is restarted or when you run the Synchronize Global Variables API. This is the default setting.
Content-Type: application/json
{
"properties":
[
{
"propertyKey": "globalvariable.OnPremiseISPkg.abc.value",
"value": "avc1"
}
]
}
Calling ../default/globalvariable/globalvariable.OnPremiseISPkg.abc
API with above value updates the value of globalvariable.OnPremiseISPkg.abc
global variable in the Cloud Designtime.
If the request is successful, the following response is received:
{
"code": 0,
"description": "Asset was updated successfully. Synchronize with <runtime-alias> to apply these configurations."
}
If updateRuntime
is set to true
, the following response is received:
{
"code": 0,
"description": "Asset was updated successfully. The synchronization process has started. Check the <runtime-alias> for more details later."
}
Allows you to override values of a global variable for a particular Edge Runtime. It must always be invoked for a runtime other than Cloud Designtime or Cloud Runtime. Like create or update APIs, the overridden values are not immediately updated in the runtime, unless the updateRuntime value is set to true
or the Synchronize Global Variable API is run.
Usage: Edge Runtime
../<runtime-alias>/globalvariable/
Parameters
runtime-alias
: Name of the Edge Runtime.
asset-id
: Name of the global variable.
updateRuntime
: Set with one of the following values:
true
: Value of the global variable is synchronized with runtime.
false
: Value is applied when the runtime is restarted or when you run the Synchronize Global Variable API. This is the default setting.
Content-Type: application/json
{
"properties":
[
{
"propertyKey": "globalvariable.OnPremiseISPkg.abc.value",
"value": "avc1"
}
]
}
Calling ../MyEdgeServer/globalvariable/globalvariable.OnPremiseISPkg.abc
API with above would update value of globalvariable.OnPremiseISPkg.abc
in the MyEdgeServer runtime.
Response when updateRuntime is false :
{
"code": 0,
"description": "Asset configurations were successfully overridden for <runtime-alias>. Synchronize with <runtime-alias> to apply the changes."
}
Response when updateRuntime
is true
:
{
"code": 0,
"description": "Asset configurations were successfully overridden for <runtime-alias>. The synchronization process has started. Check the runtime for more details later."
}
Response when you specify default
as runtime-alias:
{
"code": -1,
"description": "You do not need to override asset values for <runtime-alias>."
}
Allows you to synchronize global variable with a runtime. This ensures that the global variable is created or updated on the runtime.
Usage: Cloud Designtime, Cloud Runtime, Edge Runtime
../
Parameters
runtime-alias
: Name of the Edge Runtime. Specify the value as default
for Cloud Designtime and CloudRuntime
for Cloud Runtime.
asset-id
: Name of the global variable.
Content-Type: application/json
Calling ../MyEdgeServer/globalvariable/globalvariable.OnPremiseISPkg.abc/sync
API synchronizes globalvariable.OnPremiseISPkg.abc
value with MyEdgeServer.
{
"code": 0,
"description": "The synchronization process has started. Check the <runtime-alias> for more details later."
}
JNDI aliases can be created or updated only in the cloud runtime.
Allows you to retrieve names of all JNDI settings for Cloud Designtime.
Usage: Cloud Designtime
../default/configurations/jndi
Parameters
None
None
[
{
"assetId": "DEFAULT_IS_JNDI_PROVIDER",
"type": "jndi"
},
{
"assetId": "LocalJNDI",
"type": "jndi"
}
]
Allows you to create a JNDI alias for a Cloud Designtime. JNDI Alias is not created immediately on the Cloud Designtime unless updateRuntime
is set to true
or Synchronize JNDI Alias with runtime API is run.
../default/configurations/jndi/<asset-id>?updateRuntime=(true|false)
Parameters
asset-id
: Name of the JNDI alias.
updateRuntime
: Set with one of the following values:
true
: Newly created JNDI alias is synchronized with the Cloud Designtime.
false
: Newly created JNDI alias is not synchronized with the Cloud Designtime. This is the default setting.
for example, ../default/configurations/jndi/LocalJNDI
creates JNDI alias with name LocalJNDI
for the Cloud Designtime.
{
Content-Type: application/json
}
{
"properties": [
{
"propertyKey": "description",
"value": "Connection to local UM"
},
{
"propertyKey": "initialContextFactory",
"value": "com.pcbsys.nirvana.nSpace.NirvanaContextFactory"
},
{
"propertyKey": "providerURL",
"value": "<UMRealmURL>"
},
{
"propertyKey": "securityPrincipal",
"value": "<Username>"
},
{
"propertyKey": "securityCredentials",
"value": "<Password>"
}
]
}
Response when updateRuntime
value is set to true
:
{
"code": 0,
"description": "Asset was added successfully. The synchronization process has started. Check the <runtime-alias> for more details later."
}
Response when updateRuntime
value is set to false
:
{
"code": 0,
"description": "Asset was added successfully. Synchronize with <runtime-alias> to apply the changes."
}
Allows you to update the values of a JNDI alias in Cloud Designtime. These values are not updated immediately in the Cloud Designtime unless updateRuntime
is true
or the Synchronize JNDI Alias with runtime API is run.
Usage: Cloud Designtime
../default/configurations/jndi/<asset-id>?updateRuntime=(true|false)
Parameters
asset-id
: Name of the JNDI alias.
updateRuntime
: Set with one of the following values:
true
: Newly created values are synchronized with the Cloud Designtime.
false
: Newly created values are not synchronized with the Cloud Designtime. This is the default setting.
{
Content-Type: application/json
}
{
"properties": [
{
"propertyKey": "description",
"value": "LocalJNDI_updated"
}
]
}
../default/configurations/jndi/LocalJNDI
API with the mentioned details updates the description of LocalJNDI
in the Cloud Designtime.Response when the request is successful:
{
"code": 0,
"description": "Asset was updated successfully. Synchronize with <runtime-alias> to apply these configurations."
}
Response when updateRuntime
value is set to true
:
{
"code": 0,
"description": "Asset was updated successfully. The synchronization process has started. Check the <runtime-alias> for more details later."
}
Allows you to override JNDI alias for a particular Edge Runtime. Like create or update APIs, the overridden values are not immediately displayed on the runtime, unless the updateRuntime
value is set to true
or the Synchronize JNDI Alias with runtime API is run.
Usage: Edge Runtime
../<runtime-alias>/configurations/jndi/<asset-id>?updateRuntime=(true|false)
Parameters
runtime-alias
: Name of the Edge Runtime. Specify the value as default
for Cloud Designtime and CloudRuntime
for Cloud Runtime.
asset-id
: Name of the JNDI alias.
updateRuntime
: Set with one of the following values:
true
: Overridden configurations are applied to the provided runtime after save.
false
: Overridden configurations are not applied to the provided runtime. You must synchronize the changes by calling the Synchronize JNDI Alias with runtime API. This is the default setting.
{
Content-Type: application/json
}
{
"properties": [
{
"propertyKey": "description",
"value": "JNDI_updated"
}
]
}
../MyEdgeServer/configurations/jndi/LocalJNDI
API with the mentioned details overrides the description of LocalJNDI
connection for MyEdgeServer runtime.Response when updateRuntime
is true
:
{
"code": 0,
"description": "Asset configurations were successfully overridden for <runtime-alias>. The synchronization process has started. Check the <runtime-alias> for more details later."
}
Response when updateRuntime
is false
:
{
"code": 0,
"description": "Asset configurations were successfully overridden for <runtime-alias> . Synchronize with runtime to apply the changes."
}
Response when you specify default
as runtime-alias
:
{
"code": -1,
"description": "You do not need to override asset values for <runtime-alias>."
}
Allows you to synchronize JNDI alias with a runtime. This ensures that the JNDI alias is created or updated on the runtime.
Usage: Cloud Designtime, Cloud Runtime, Edge Runtime
../<runtime-alias>/configurations/jndi/<asset-id>/sync
Parameters
runtime-alias
: Name of the Edge Runtime. Specify the value as default
for Cloud Designtime and CloudRuntime
for Cloud Runtime.
asset-id
: Name of the JNDI alias.
For example, ../MyEdgeServer/configurations/jndi/LocalJNDI/sync
synchronizes LocalJNDI
alias with MyEdgeServer.
Calling ../MyEdgeServer/configurations/jndi/LocalJNDI
API with mentioned details updates the description of LocalJNDI
in the MyEdgeServer runtime.
{
"code": 0,
"description": "The synchronization process has started. Check the <runtime-alias> for more details later."
}
JMS aliases can only be created or updated in the Cloud Designtime.
Allows you to retrieve all JMS aliases present on the Cloud Designtime.
Usage: Cloud Designtime
../default/configurations/jms
Parameters
None
None
[
{
"assetId": "DEFAULT_IS_JMS_CONNECTION",
"type": "jms"
},
{
"assetId": "PE_NONTRANSACTIONAL_ALIAS",
"type": "jms"
}
{
"assetId": "jmsLDS2",
"type": "jms"
}
]
Allows you to set a new JMS alias for the Cloud Designtime. JMS alias is not created immediately on the Cloud Designtime unless updateRuntime
is true
or the Synchronize JMS Alias with runtime API is run.
../default/configurations/jms/<asset-id>?updateRuntime=(true|false)
Parameters
asset-id
: Name of the JMS alias.
updateRuntime
: Set with one of the following values:
true
: New JMS alias is synchronized with the Cloud Designtime.
false
: New JMS alias is not synchronized with the Cloud Designtime. This is the default setting.
for example, ../default/configurations/jms/LocalJMS
creates a JMS alias with the name LocalJMS
for the Cloud Designtime.
{
Content-Type: application/json
}
{
"properties": [
{
"propertyKey": "description",
"value": "My local JMS connection"
},
{
"propertyKey": "clientID",
"value": "LOCAL_JMS_CLIENT"
},
{
"propertyKey": "user",
"value": "<username>"
},
{
"propertyKey": "password",
"value": "<password>"
},
{
"propertyKey": "jndi_jndiAliasName",
"value": "LocalJNDI"
},
{
"propertyKey": "jndi_connectionFactoryLookupName",
"value": "LocalFactory"
}
]
}
Response when updateRuntime
value is set to true
:
{
"code": 0,
"description": "Asset was added successfully. The synchronization process has started. Check the <runtime-alias> for more details later."
}
Response when updateRuntime
value is set to false
:
{
"code": 0,
"description": "Asset was added successfully. Synchronize with <runtime-alias> to apply the changes."
}
Allows you to set new changes to the values of an existing JMS alias in the Cloud Designtime. These values are not displayed in the Cloud Designtime unless the updateRuntime
value is set to true
or the Synchronize JMS Alias with runtime API is run.
Usage: Cloud Designtime
../default/configurations/jms/<asset-id>?updateRuntime=(true|false)
Parameters
asset-id
: Name of the JMS alias.
updateRuntime
: Set with one of the following values:
true
: Newly created values are synchronized with the Cloud Designtime.
false
: Newly created values are not synchronized with the Cloud Designtime. This is the default setting.
{
Content-Type: application/json
}
{
"properties":
[
{
"propertyKey": "description",
"value": "Updated JMS alias description"
}
]
}
../default/configurations/jms/LocalJMS
API with the mentioned details updates the description of LocalJMS
in the Cloud Designtime.Response when the updateRuntime
value is set to false
or not set:
{
"code": 0,
"description": "Asset was updated successfully. Synchronize with <runtime-alias> to apply these configurations."
}
Response when the updateRuntime
value is set to true
:
{
"code": 0,
"description": "Asset was updated successfully. The synchronization process has started. Check the <runtime-alias> for more details later."
}
Allows you to override values of a JMS alias for a particular Edge Runtime. Like create or update APIs, overridden values are not immediately displayed on the runtime, unless the updateRuntime
value is set to true
or Synchronize JMS Alias with runtime API is run.
Usage: Edge Runtime
../<runtime-alias>/configurations/jms/<asset-id>
Parameters
runtime-alias
: Name of the Edge Runtime. Specify the value as default
for Cloud Designtime and CloudRuntime
for Cloud Runtime.
asset-id
: Name of the JMS alias.
updateRuntime
: Set with one of the following values:
true
: Overridden configurations are applied to provided runtime after save.
false
: Overridden configurations are not applied to provided runtime. You must synchronize the changes by calling the Synchronize JMS Alias API. This is the default setting.
{
Content-Type: application/json
}
{
"properties":
[
{
"propertyKey": "description",
"value": "Updated JMS alias description for MyEdgeServer"
}
]
}
../MyEdgeServer/configurations/jms/LocalJMS
API with the mentioned details updates the description of LocalJMS
in the MyEdgeServer runtime.Response when updateRuntime
is set to false
or not set:
{
"code": 0,
"description": "Asset configurations were successfully overridden for <runtime-alias>. Synchronize with <runtime-alias> to apply the changes."
}
Response when updateRuntime
is set to true
:
{
"code": 0,
"description": "Asset configurations were successfully overridden for <runtime-alias>. The synchronization process has started. Check the <runtime-alias> for more details later."
}
Response when you specify default
as runtime-alias
:
{
"code": -1,
"description": "You do not need to override asset values for <runtime-alias>."
}
Allows you to synchronize JMS alias with a runtime. This ensures that the JMS alias is created or updated on the runtime.
Usage: Cloud Designtime, Cloud Runtime, Edge Runtime
../<runtime-alias>/configurations/jms/<asset-id>/sync
Parameters
runtime-alias
: Name of the Edge Runtime. Specify the value as default
for Cloud Designtime and CloudRuntime
for Cloud Runtime.
asset-id
: Name of the JMS alias.
For example, ../MyEdgeServer/configurations/jms/LocalJMS/sync synchronizes LocalJMS alias with MyEdgeServer.
Calling ../MyEdgeServer/configurations/jms/LocalJMS
API with the mentioned details updates the description of LocalJMS
in MyEdgeServer runtime.
{
"code": 0,
"description": "The synchronization process has started. Check the <runtime-alias> for more details later."
}
Allows you to enable or disable a JMS alias on a runtime. Unlike other API calls, the Enable/Disable JMS Alias API applies the state immediately on the runtime.
Usage: Cloud Designtime, Cloud Runtime, Edge Runtime
../<runtime-alias>/configurations/jms/<asset-id>/properties/state
Parameters
runtime-alias
: Name of the Edge Runtime. Specify the value as default
for Cloud Designtime and CloudRuntime
for Cloud Runtime.
asset-id
: Name of the JMS alias.
{
Content-Type: application/json
}
{
"enabled": "<true|false>"
}
Calling ../MyEdgeServer/configurations/jms/LocalJMS/properties/state
API with enabled
set to false
in the mentioned payload, disables the LocalJMS
in the MyEdgeServer runtime.
{
"code": 0,
"description": "Asset state was updated successfully. The synchronization process has started. Check the <runtime-alias> for more details later."
}