Http Proxy API

The BPC allows to setup HTTP proxy Connections to make calls through the applications, e.g. to reach external resources which need authentication or can only be reached via a proxy. These endpoints allow to make calls using the defined HTTP proxies. The API supports the following HTTP methods: GET, POST, PUT, DELETE, PATCH and OPTIONS.

Method Endpoint

GET

/cxf/bpc-httpproxy/httpProxy/{instanceId}\{targetPath: (/.*)?}

Description

Perform an HTTP GET on the 'http proxy' backend connection.

Parameters Path

instanceId

the id of the 'http proxy' backend connections instance to use

targetPath

the path to call on the target system

Query Parameters

targetUrl

optional URL Parameter. Function equals targetPath

Returns

The response of the called backend connection

HTTP Status Code

  • 200: OK

  • 404: Resource unavailable:

    • One of the used services is not available

    • The backend connections module is not available

    • The backend connections module instance is not available

  • 500: General problem with the backend system

  • 503: Connection to backend system refused

  • 504: Connection to backend system timed out

Required Access Rights

A logged in user, API Key or access token is required.

POST

/cxf/bpc-httpproxy/httpProxy/{instanceId}\{targetPath: (/.*)?}

Description

Perform an HTTP POST on the 'http proxy' backend connection.

Parameters Path

instanceId

the id of the 'http proxy' backend connections instance to use

targetPath

the path to call on the target system

Query Parameters

targetUrl

optional URL Parameter. Function equals targetPath

Returns

The response of the called backend connection

HTTP Status Code

  • 200: OK

  • 404: Resource unavailable:

    • One of the used services is not available

    • The backend connections module is not available

    • The backend connections module instance is not available

  • 500: General problem with the backend system

  • 503: Connection to backend system refused

  • 504: Connection to backend system timed out

Required Access Rights

A logged in user, API Key or access token is required.

PUT

/cxf/bpc-httpproxy/httpProxy/{instanceId}\{targetPath: (/.*)?}

Description

Perform an HTTP PUT on the 'http proxy' backend connection.

Parameters Path

instanceId

the id of the 'http proxy' backend connections instance to use

targetPath

the path to call on the target system

Query Parameters

targetUrl

optional URL Parameter. Function equals targetPath

Returns

The response of the called backend connection

HTTP Status Code

  • 200: OK

  • 404: Resource unavailable:

    • One of the used services is not available

    • The backend connections module is not available

    • The backend connections module instance is not available

  • 500: General problem with the backend system

  • 503: Connection to backend system refused

  • 504: Connection to backend system timed out

Required Access Rights

A logged in user, API Key or access token is required.

DELETE

/cxf/bpc-httpproxy/httpProxy/{instanceId}\{targetPath: (/.*)?}

Description

Perform an HTTP DELETE on the 'http proxy' backend connection.

Parameters Path

instanceId

the id of the 'http proxy' backend connections instance to use

targetPath

the path to call on the target system

Query Parameters

targetUrl

optional URL Parameter. Function equals targetPath

Returns

The response of the called backend connection

HTTP Status Code

  • 200: OK

  • 404: Resource unavailable:

    • One of the used services is not available

    • The backend connections module is not available

    • The backend connections module instance is not available

  • 500: General problem with the backend system

  • 503: Connection to backend system refused

  • 504: Connection to backend system timed out

Required Access Rights

A logged in user, API Key or access token is required.

OPTIONS

/cxf/bpc-httpproxy/httpProxy/{instanceId}\{targetPath: (/.*)?}

Description

Perform an HTTP OPTIONS on the 'http proxy' backend connection.

Note: As OPTIONS requests are always proxied, an introspection of this endpoint using OPTIONS is not possible.

Path Parameters

instanceId

the id of the 'http proxy' backend connections instance to use

targetPath

the path to call on the target system

Query Parameters

targetUrl

optional URL Parameter. Function equals targetPath

Returns

The response of the called backend connection

HTTP Status Code

  • 200: OK

  • 404: Resource unavailable:

    • One of the used services is not available

    • The backend connections module is not available

    • The backend connections module instance is not available

  • 500: General problem with the backend system

  • 503: Connection to backend system refused

  • 504: Connection to backend system timed out

Required Access Rights

A logged in user, API Key or access token is required.

PATCH

/cxf/bpc-httpproxy/httpProxy/{instanceId}\{targetPath: (/.*)?}

Description

Perform an HTTP PATCH on the 'http proxy' backend connection.

Parameters Path

instanceId

the id of the 'http proxy' backend connections instance to use

targetPath

the path to call on the target system

Query Parameters

targetUrl

optional URL Parameter. Function equals targetPath

Returns

The response of the called backend connection

HTTP Status Code

  • 200: OK

  • 404: Resource unavailable:

    • One of the used services is not available

    • The backend connections module is not available

    • The backend connections module instance is not available

  • 500: General problem with the backend system

  • 503: Connection to backend system refused

  • 504: Connection to backend system timed out

Required Access Rights

A logged in user, API Key or access token is required.
Press Esc to exit full screen
Modal image placeholder
Press Esc to exit full screen