Skip to main content

Bloodhound: Advanced Actors

Legacy Documentation
You're viewing legacy documentation for API Fortress (deployed via an on-premises container). To view documentation for the new SaaS version of API Fortress — now known as Sauce Labs API Testing and Monitoring (with Sauce Connect tunnels) — see API Testing on the Sauce Labs Cloud.

Type: Transformers​

ReplaceUpstreamActor​

Replaces the upstream base URL if a certain condition is verified.

class: com.apifortress.afthem.actors.transformers.ReplaceUpstreamActor

sidecars: yes

config:

  • expression: a SpEL expression returning a boolean. The condition to be matched
  • upstream: the new upstream base URL

EndpointIdentifierActor​

Labels the current request based on certain factors. The label is then stored within the request in a variable named callId. The use of this actor is to identify calls and take subsequent actions based on the findings.

class: com.apifortress.afthem.actors.transformers.EndpointIdentifierActor

config:

The configuration looks like the following.

regex:
[label1]:
url: [pattern]
method: [method]
[label2]:
url: [pattern]
method: [method]
  • label: the label to assign
  • url: the regex to identify the URL
  • method (optional): the method of the call

TransformPayloadActor​

Alters a textual payload in a message. If the transformer is placed before an Upstream actor, it modifies the request payload. If after, it modifies the response payload.

class: com.apifortress.afthem.actors.transformers.TransformPayloadActor

sidecars: yes

config:

  • set: sets the payload with the given value

  • replace: replaces all the substrings matching a certain regular expression with the provided string. Example:

    replace:
    regex: foo
    value: bar

DeserializerActor​

Deserialize data coming in form of string or array of bytes, to data structures (maps, arrays). The output of this operation is then stored into a meta.

class: com.apifortress.afthem.actors.transformers.DeserializerActor

sidecars: yes

config:

  • expression: a path to the piece of data you wish to deserialize. For example #msg.request().payload() is the path to the request payload
  • contentType: the expected content type of the inbound data
  • meta: the key of the meta that will store the result of the deserialization

AddMetaActor​

Adds a piece of meta information in the message.

class: com.apifortress.afthem.actors.transformers.AddMetaActor

sidecars: yes

config:

  • name: the key of the meta
  • value: the value of the meta. If evaluated is set to true, it can be a dynamic expression
  • evaluated: true if you need the value to be evaluated

Type: Filters​

ApiKeyFilterActor​

Filters out any request that does not carry a valid API key in the headers or in the query string. This base actor loads the API keys from a YAML file.

When the API key is recognized, the ApiKey object is stored in the key meta of the request.

class: com.apifortress.afthem.actors.filters.ApiKeyFilterActor

sidecars: yes

config:

  • filename: path to a file containing the API keys
  • in: either query (expecting the key in the query string) or header (expecting the key in the headers)
  • name: key of the field carrying the API key

The file format looks like the following:

api_keys:
- api_key: ABC123
  app_id: John Doe
  enabled: true
- api_key: DEF456
  app_id: Jane Doe
  enabled: true

BasicAuthFilterActor​

Filters out any request that does not carry a valid basic authentication header. The valid users are stored in an htpasswd (md5, apr1) compatible file.

When the authentication succeeds, the username is stored in the user meta of the request.

class: com.apifortress.afthem.actors.filters.BasicAuthFilterActor

sidecars: yes

config:

  • filename: path to a htpasswd-compatible file

ThrottlingActor​

Limits the number of requests/second the gateway will accept and pass through. Multiple counting buckets are present.

class: com.apifortress.afthem.actors.filters.ThrottlingActor

sidecars: yes

config:

  • global: (int) the maximum number of requests per second globally for this flow
  • app_id: (int) maximum number of requests per second per App ID (as defined by API keys)
  • ip_address: (int) maximum number of requests per second per requesting IP address

Additional Topics:​