API Control Plane Agent Properties

Edit online

The following set of properties are used to establish the connectivity between the webMethods API Gateway and API Control Plane :

Property Default Description
apigw_cp_agentConfig_enabled* false This property decides whether the runtime should start communicating with API Control Plane.
apigw_cp_agentConfig_​runtimeConfig_runtimeName* - The name of the runtime is used as ID in API Control Plane. This property defines how you want to identify the runtime in API Control Plane.
apigw_cp_agentConfig_​runtimeConfig_description - The runtime description.
apigw_cp_agentConfig_​runtimeConfig_deploymentType SAG_SAAS The runtime deployment type. Permitted values are as follows:
  • ON_PREMISE
  • SAG_SAAS
  • PRIVATE_CLOUD
.
apigw_cp_​agentConfig_runtimeConfig​_heartBeatIntervalInSeconds 60 The duration in seconds in which the runtime has to send health check status to API Control Plane.
apigw_cp_​agentConfig_runtimeConfig​_metricsSynchIntervalInSeconds 60 The duration in seconds in which the runtime has to send metrics to API Control Plane.
apigw_cp_​agentConfig_runtimeConfig​_assetSynchIntervalInSeconds 120 The duration in seconds in which the runtime has to synchronize the changes made to the assets to API Control Plane.
apigw_cp_​agentConfig_controlPlaneConfig​_retry_maxAttempts 60 The maximum number of retry attempts allowed for the runtime to establish a connection with API Control Plane if it is lost.
apigw_cp_agentConfig_​controlPlaneConfig​_retry_retryTimeIntervalInSeconds 60 The duration in seconds in which the runtime has to re-establish the connection with API Control Plane if it is lost.
apigw_cp_agentConfig_​runtimeConfig_location - The location where the runtime is deployed. Example:apigw_cp_agentConfig_​runtimeConfig_location =Oregon
apigw_cp_agentConfig_​runtimeConfig_tags - The tag name of the runtime. Tags are used to organize and categorize the runtimes. Multiple tags can be specified by adding comma. Example:apigw_cp_agentConfig​_runtimeConfig_tags= test,local,dev.
apigw_cp_agentConfig_​runtimeConfig_host - The host name of the runtime. Example:apigw_cp_agentConfig​_runtimeConfig_host =http://demo.apigw-aw-us.webmethods.in.
Note: The host name can also be in IPv4 or IPv6 address format.
apigw_cp_agentConfig__​runtimeConfig_region - The region name where the runtime is hosted. Example:apigw_cp_agentConfig​__runtimeConfig_region= AWS-US.
apigw_cp_agentConfig_​runtimeConfig_capacity_value - The number of transaction calls that a runtime can process for the specified duration.
apigw_cp_agentConfig​_runtimeConfig_capacity_units - The duration for which the runtime threshold capacity is defined. Possible values are as follows:
  • per second
  • per minute
  • per hour
  • per day
  • per week
  • per month
  • per year
apigw_cp_agentConfig_​controlPlaneConfig_controlPlaneURL* - The valid URL that is used to access API Control Plane.
apigw_cp_agentConfig​_controlPlaneConfig_username - User name that is used to log in to API Control Plane.
Note: Make sure the user belongs to API platform provider and API product manager user groups.
apigw_cp_agentConfig​_controlPlaneConfig_password - Password of the corresponding user name, which is used for logging into the API Control Plane through basic authentication.
apigw_cp_agentConfig​_controlPlaneConfig_cpToken - A token provided enhance the security of communications with API Control Plane. If you opt for token-based authentication it is imperative to configure this property.
Note: Initially, the token is retrieved from the configuration file. Subsequently, the token is purged from the configuration file and securely stored in the webMethods API Gateway passman. This stored token is then utilized for subsequent restarts. It is crucial that the token supplied in this property precisely matches the token specified in the APICP_AGENT_AUTH_KEY property, which is defined within API Control Plane. For more details about the APICP_AGENT_AUTH_KEY property, see Configuration Details section under Administering API Control Plane in API Control Plane documentation. Furthermore, depending on your deployment method:
  • If you have deployed API Control Plane using Docker, the APICP_AGENT_AUTH_KEY property should be defined within the environment section of ingress in the docker-compose.yml file
  • If you have used the Helm command for API Control Plane deployment, the APICP_AGENT_AUTH_KEY property should be configured within the data section of the ingress_configmap.yaml file
Note: If you have defined both the apigw_cp_agentConfig_controlPlaneConfig_password and apigw_cp_agentConfig_controlPlaneConfig_cpToken properties, basic authentication takes precedence over token-based authentication.

* indicates that the properties are mandatory and must be configured to set up the API Control Plane agent.