Create a capping configuration on a given endpoint identified by its URL. The endpoint can be used in one or more actions and data sources.

In the given payload, the capping configuration is defined by :

• url : the URL of the endpoint, as defined in the actions or data sources.

• methods : the methods called on this endpoint, as defined in the actions or data sources.

• Within services JSON object, one of the two following values is expected :

  • "action" if the capping will be applied on the endpoint when executing a Custom Action
  • "dataSource" if the capping will be applied on the endpoint when fetching data from a Data Source

• (optional) maxHttpConnections: max count of simultaneous connections to the endpoint (max value is 400). If not provided, there will be no limitation of the number of connections to the endpoint.

• Within rating JSON object :

  • maxCallsCount: max count of calls to be performed in the given period (min value is 1)
  • periodInMs: duration in milliseconds (value greater than 0)

In the response to this call, the created configuration is returned along with its uid (Unique ID) that is expected to be passed afterwards in the other calls.

Return the capping configuration identified by the given Unique ID. The latest definition is returned.

In addition to the data provided when creating or updating a configuration, the response essentially contains the following elements:

• uid : Unique ID of the capping configuration, generated at creation time
• metadata : information about creation, last update and last deployment
• state : current state of the capping configuration, either 'created', 'updated' or 'deployed'
• hasBeenDeployed : true or false
• deployedConfig in case the configuration has been deployed: this is the capping configuration at latest deployment time. The current capping configuration differs if it has been updated since.

Update the capping configuration identified by the given Unique ID. The operation is an overwrite of the existing configuration, therefore the request body must include all fields required to create a configuration.

A configuration can be updated at any time, even if it has been deployed. In such case, state is 'updated' and hasBeenDeployed is true. To apply the latest changes, the configuration must be deployed again. The deployedConfig object always defines the configuration which is currently deployed.

Delete the capping configuration identified by the given Unique ID.

In case the configuration has been deployed, it must be undeployed before being deleted. Otherwise an error response with HTTP Status Code 500 is returned :

{
  "status": 500,
  "error": {
    "code":1451,
    "family": "INPUT_OUTPUT_ERROR",
    "message": "Can't delete a deployed endpoint config. Undeploy it before deleting it",
    "service": "vyg-authoring-api",
    "version": "ce5cac3",
    "context": "com.adobe.voyager.service.authoring.restapis.v1_0.EndpointConfigService:189"
    "schema":"21835D7E5BFF031F0A494026@AdobeOrg_prod_journeyVersions"
  },
  "requestId": "pxSRgsBzUKYcMyNlqc0paqIJZfc0qdAw"
}

To override this control, you need to pass forceDelete=true as query parameter.

Calling this operation is not mandatory for using any other operation of the capping API. It allows to verify whether or not a capping configuration can be deployed. It returns the validation status of the configuration identified by its Unique ID, either:

• "ok"
• "error"

The potential errors are:

• ERR_ENDPOINTCONFIG_100: capping config: missing or invalid url
• ERR_ENDPOINTCONFIG_101: capping config: malformed url
• ERR_ENDPOINTCONFIG_102: capping config: malformed url: wildchar in url not allowed in host:port
• ERR_ENDPOINTCONFIG_103: capping config: missing HTTP methods
• ERR_ENDPOINTCONFIG_104: capping config: no call rating defined
• ERR_ENDPOINTCONFIG_107: capping config: invalid max calls count (maxCallsCount)
• ERR_ENDPOINTCONFIG_108: capping config: invalid max calls count (periodInMs)
• ERR_ENDPOINTCONFIG_111: capping config: can't create endpoint config: invalid payload
• ERR_ENDPOINTCONFIG_112: capping config: can't create endpoint config: expecting a JSON payload
• ERR_AUTHORING_ENDPOINTCONFIG_1: invalid service name '<given value>': must be 'dataSource' or 'action'

The potential warning is:

• ERR_ENDPOINTCONFIG_106: capping config: max HTTP connections not defined: no limitation by default

Deploy the capping configuration identified by the given Unique ID.

A successful deployment returns an empty response body and HTTP Status Code 204 (No-content). In such case, the configuration state is changed to 'deployed' and hasBeenDeployed is true.

Undeploy the capping configuration identified by the given Unique ID.

A successful undeployment returns an empty response body and HTTP Status Code 204 (No-content). In such case, the configuration state is changed back to the state before the deployment, either 'created' or 'updated', and hasBeenDeployed is changed to false.

Return the list of all endpoint capping configurations defined for the given IMS organization and sandbox.