Remote Configurations & Business Rules Manager

The Rules API allows you to evaluate your business rules and receive the desired remote configurations based on the provided context. We'll dive into the different endpoints you can use to interact with your rules.

Evaluate remote configurations

POST /v1/remoteconfigs

This endpoint allows you to evaluate your remote configurations with the provided context. If no context is provided the default value of your configuration matrix will be returned.

Body parameters

keys array

An array of strings containing the remote configurations keys that are being requested.

context object optional

Key-value pairs that match your data model and fields declared in the configuration matrix. If you send multiple rule keys, the context will be applied to the evaluation of each rule.

metadata object optional

Set of key-value pairs of additional data you want to attach to the log generated by this request.

Request

POST • /v1/remoteconfigs

curl https://api.orquesta.cloud/v1/remoteconfigs \
  -H 'Authorization: Bearer {apiKey}' \
  -H "Content-Type: application/json" \
  -d '{"keys":["remote_config_key_one","remote_config_key_two"],"context":{"environments":"develop"}}'

Response

{
  "rule_key_one": {
    "value": true,
    "trace_id": "ae2519ac-ed42-4caf-b16d-5fd8df35662b"
  },
  "rule_key_two": {
    "value": {
      "db": "test",
      "table": "test",
      "column": "test"
    },
    "trace_id": "ed4219ac-ed42-4caf-ae25-5fd8df35662b"
  }
}

Add remote configuration metrics

POST /v1/metrics

This endpoint allows you add custom metrics to the log generated by a request

Body parameters

metadata  object optional

Custom key-value pairs that you attach to your logs. This is useful for storing additional information related to your services and setup. If no metadata is provided, the endpoint will still accept the request, but nothing will be added to your logs.

Request

POST • /v2/remoteconfigs/:trace_id/metrics

curl -G https://api.orquesta.dev/v2/remoteconfigs/:trace_id/metrics \
 -H "Authorization: Bearer {apiKey}" \
 -d '{"metadata":{"custom1":"aaa","custom2":123}}'

Response

{
  "ok": true
}