External-proxy



The External Proxy API allows an administrator to configure an external HTTP proxy.
All HTTP requests that need to reach the public internet will be routed through the configured proxy.
Note that the configured proxy must support RFC 2817 (HTTP CONNECT). HTTP CONNECT will be used to tunnel HTTPS through the proxy.
[tags: DMA]

Resource Root

https://localhost:8443/api/rest/external-proxy

Summary


Resources Methods
https://localhost:8443/api/rest/external-proxy

GET  Retrieves the external proxy configuration.

PUT Updates the external proxy configuration.

Resources


https://localhost:8443/api/rest/external-proxy


Methods

GET


Retrieves the external proxy configuration. [tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-external-proxy+xml
application/vnd.plcm.plcm-external-proxy+json
Proxy configuration retrieved.
304
External proxy configuration has not changed since the last get.

Note: The API client must provide the "plcm-external-proxy" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval.
This will improve network performance by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous, identical
search in the "If-None-Match" header, then the HTTP response will contain the
search results in the message body.

The "plcm-external-proxy" ETag can be accessed from the initial search result's HTTP
response header. Also, subsequent searches require the identical search filter
to ensure an equivalent ETag value. This also assumes no other client made changes to
the registration shares on the server.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User is not authorized to view the external proxy configuration.
403 application/vnd.plcm.plcm-error+xml
User has insufficient permissions to perform the operation.

PUT

Updates the external proxy configuration. [tags: DMA]

Request

Representations

application/vnd.plcm.plcm-external-proxy+xml
application/vnd.plcm.plcm-external-proxy+json

Response

Status Representation Description
204 External proxy configuration successfully accepted.
409 URL is malformed.
412 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The ETag supplied in the header and/or body does not match
that on the server.
This usually means that an intervening change has been made
to the configuration since the last time you accessed it.
428 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The ETag is missing and required.
The API client must supply the ETag either in the "entity-tag" field
of the message body or in the "If-Match" header.
The server will enforce that the ETag supplied with an update matches
the previous value. This prevents updates from clobbering intervening changes.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User is not authorized to update the external proxy configuration.
403 application/vnd.plcm.plcm-error+xml
User has insufficient permissions to perform the operation.