Create Api Filter

Create Api Filter

Create an API filter.

Request
URI
POST
https://{api_host}/cloudapi/1.0.0/apiFilters
COPY
Request Body
ApiFilter of type(s) application/json
Optional 
{
    "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.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ApiFilter of type(s) application/json;version=39.0 
{
    "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
On This Page
Api Filter Operations
POST
Create Api Filter
DELETE
Delete Api Filter
GET
Get Api Filter
GET
Get Api Filters
PUT
Update Api Filter