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.

EntityReference
externalSystem
Required

Entity reference used to describe VCD entities

UrlMatcher
urlMatcher
Optional

The UrlMatcher consists of urlPattern and urlScope which together identify a URL which will be serviced by an external system. For example, if you want the external system to service all requests matching '/ext-api/custom/.', the URL Matcher object should be: { "urlPattern": "/custom/.", "urlScope": "EXT_API" } It is important to note that in the case of EXT_UI_TENANT urlScope, the tenant name is not part of the urlPattern. The urlPattern will match the request after the tenant name - if request is "/ext-ui/tenant/testOrg/custom/test", the pattern will match against "/custom/test".

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.

Availability
Added in 37.3
Parameter To
Returned By