ApiFilter

ApiFilter
ApiFilter

API filters allow external systems (external services and external endpoints) to extend the standard API included with VCD with custom URLs or custom processing of request's responses.

JSON Example
{
    "id": "urn:vcloud:apiFilter:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "externalSystem": {
        "name": "string",
        "id": "string"
    },
    "urlMatcher": {
        "urlPattern": "string",
        "urlScope": "string"
    },
    "responseContentType": "string"
}
string
id
Optional

The unique id of the api filter.

externalSystem
Required

externalSystem

urlMatcher
Optional

urlMatcher

string
responseContentType
Optional

The responseContentType is expressed as a MIME Content-Type string. Responses whose Content-Type attribute has a value that matches this string are routed to the service. responseContentType is mutually exclusive with urlMatcher.