Access Proxy

[tags: RPAD, DMA]

Resource Root

https://localhost:8443/api/rest//access-proxies

Summary

Resources	Methods
https://localhost:8443/api/rest//access-proxies	GET Retrieves the current list of defined access proxies. POST Creates the given access proxy from the given definition .
https://localhost:8443/api/rest//access-proxies/settings	GET Retrieves the current access proxy settings. PUT Updates the access proxy settings.
https://localhost:8443/api/rest//access-proxies/{access-proxy-identifier}	GET Retrieves the specified access proxy definition. PUT Updates the access proxy given by the access-proxy-identifier and the updated config. DELETE Deletes the access proxy given by the access-proxy-identifier.
https://localhost:8443/api/rest//access-proxies/statistics	GET Retrieves a list of access proxy usage counters grouped as requested by grouping query parameter.
https://localhost:8443/api/rest//access-proxies/statistics/reset	POST Resets the max connection count for each access proxy protocol and instance counter.

Resources

https://localhost:8443/api/rest//access-proxies

Methods

GET

Retrieves the current list of defined access proxies.

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-access-proxy-list+xml application/vnd.plcm.plcm-access-proxy-list+json
304		Access proxy list has not changed since the last GET. This includes whether any of the elements in the list have changed or not. Note: The API client must provide the "plcm-access-proxy-list" 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 request in the "If-None-Match" header, then the HTTP response will contain the same information in the message body as the previous request. The "plcm-access-proxy-list" ETag can be accessed from the initial request result's HTTP response header. If another client has changed an element in the list, the ETag value will be out of date and a request with the outdated ETag will return the full "plcm-access-proxy-list".
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unauthorized.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. administrator permissions required

POST

Creates the given access proxy from the given definition

Request

Representations

application/vnd.plcm.plcm-access-proxy+xml

application/vnd.plcm.plcm-access-proxy+json

Response

Status	Representation	Description
201		Access proxy was successfully created
400	text/plain	Bad request.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unauthorized.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. administrator permissions required
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Listening port is not valid for this protocol
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Another proxy is already defined with the same listening port
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No listening address type was specified
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The internal access proxy address does not match the destination type
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The external access proxy address does not match a member of the listening address types
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Only one HTTP_TUNNEL can be defined
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	An HTTP_TUNNEL cannot have any hops
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The access proxy config for this proxy type must have one next hop defined
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Destination address and address type do not match
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	A host header value is either missing or invalid
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The URI filter field is required when the server type is Other

https://localhost:8443/api/rest//access-proxies/settings

Methods

GET

Retrieves the current access proxy settings.

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-access-proxy-settings+xml application/vnd.plcm.plcm-access-proxy-settings+json	Access proxy settings are returned
304		Access proxy settings have not changed since the last GET. Note: The API client must provide the "plcm-access-proxy-settings" 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 request in the "If-None-Match" header, then the HTTP response will contain the same information in the message body as the previous request. The "plcm-access-proxy-settings" ETag can be accessed from the initial request result's HTTP response header. If another client has changed the settings, the ETag value will be out of date and a request with the outdated ETag will return the full "plcm-access-proxy-settings".
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unauthorized.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. administrator permissions required

PUT

Updates the access proxy settings.

Request

Representations

application/vnd.plcm.plcm-access-proxy-settings+xml

application/vnd.plcm.plcm-access-proxy-settings+json

Response

Status	Representation	Description
204	application/vnd.plcm.plcm-access-proxy-settings+xml application/vnd.plcm.plcm-access-proxy-settings+json	Access proxy settings successfully updated.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unauthorized.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. administrator permissions required
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Port range exceeded.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Port ranges are not valid. minimum-port must be less than the maximum-port
412	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The access-proxy-settings resource has changed on the server. Note: The- response will contain the ETag value and link that reflects the server's access-proxy-settings resource in the HTTP response header. The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-access-proxy-settings.xsd" for details. If the message body does not contain the ETag value, the server will look for the ETag in the "If-Match" header.
428	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-proxy-settings.xsd" for details. If the message body does not contain the ETag value, the server will look for the ETag in the "If-Match" header.

https://localhost:8443/api/rest//access-proxies/{access-proxy-identifier}

Template Parameters

Name	Type	Description
access-proxy-identifier	xs:string	The access proxy identifier

Methods

GET

Retrieves the specified access proxy definition.

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-access-proxy+xml application/vnd.plcm.plcm-access-proxy+json	Access proxy exists and was returned.
304		Access proxy information has not changed since the last GET. Note: The API client must provide the "plcm-access-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 request in the "If-None-Match" header, then the HTTP response will contain the same information in the message body as the previous request. The "plcm-access-proxy" ETag can be accessed from the initial GET result's HTTP response header. If another client has changed the access-proxy, the ETag value will be out of date and a request with the outdated ETag will return the full "plcm-access-proxy".
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unauthorized.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. administrator permissions required
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Access proxy specified by the access-proxy-identifier did not exist

PUT

Updates the access proxy given by the access-proxy-identifier and the updated config

Request

Representations

application/vnd.plcm.plcm-access-proxy+xml

application/vnd.plcm.plcm-access-proxy+json

Response

Status	Representation	Description
204		Access proxy was successfuly updated
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unauthorized.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. administrator permissions required
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Access proxy specified by the access-proxy-identifier did not exist
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Listening port is not valid for this protocol
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Another proxy is already defined with the same listening port
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No listening address type was specified
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The internal access proxy address does not match the destination type
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The external access proxy address does not match a member of the listening address types
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Only one HTTP_TUNNEL can be defined
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	An HTTP_TUNNEL cannot have any hops
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The access proxy config for this proxy type must have one next hop defined
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Destination address and address type do not match
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	A host header value is either missing or invalid
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The URI filter field is required when the server type is Other
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Access proxy id in body does no match the resource specified in the URL
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot change transport value
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot change protocol value
412	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	This access proxy resource has changed on the server. Note: The response will contain the ETag value and link that reflects the server's access proxy resource in the HTTP response header. The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-access-proxy.xsd" for details. If the message body does not contain the ETag value, the server will look for the ETag in the "If-Match" header.
428	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-proxy.xsd" for details. If the message body does not contain the ETag value, the server will look for the ETag in the "If-Match" header.

DELETE

Deletes the access proxy given by the access-proxy-identifier

Request

Response

Status	Representation	Description
204		Access proxy was successfuly deleted
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unauthorized.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. administrator permissions required
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Access proxy specified by the access-proxy-identifier did not exist

https://localhost:8443/api/rest//access-proxies/statistics

Methods

GET

Retrieves a list of access proxy usage counters grouped as requested by grouping query parameter.

Request

Query Parameters

Name	Type	Description
grouping	xs:string	Specifies the way in which access proxy usage counts should be grouped. Default is PROTOCOL.

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-access-proxy-list-statistics+xml application/vnd.plcm.plcm-access-proxy-statistics-list+json

https://localhost:8443/api/rest//access-proxies/statistics/reset

Methods

POST

Resets the max connection count for each access proxy protocol and instance counter.

Response

Status	Representation	Description
204		Access proxy usage max counts were successfuly reset to zero.