Upload a custom logo to your custom HTTP proxy error pages.
Supported formats: PNG, JPEG, GIF.
URL
GET https://<IP-address-of-SPS>/api/configuration/http/proxy_error_logo
Cookies
| session_id |
Contains the authentication token of the user |
Required |
The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For more information on authentication, see Authenticate to the SPS REST API.
NOTE: This session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format). |
Operations
Operations with the /http/proxy_error_logo endpoint include:
| Uploading a custom logo |
POST |
/api/upload/http/proxy_error_logo |
If you upload an oversized logo, for example 800x800 pixels, your image will be automatically resized to 128x128 pixels, keeping the original aspect ratio. |
NOTE: GET / PUT / DELETE methods are not allowed on logo upload.
Sample request
The following command uploads a custom logo.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/http/proxy_error_logo
Response
The following is a sample response received when the custom logo has been uploaded.
The response of the creation without the unique ID is the following.
{
"logo_id": "rest_XXXXXXXX",
"meta": {
"href": "/api/upload/http/proxy_error_logo",
"parent": "/api/upload/http"
}
}
The response of the query without a unique logo ID is the following.
{
"changes": [
{
"new_value": "rest_XXXXXXXX",
"path": "/api/upload/http/proxy_error_logo",
"type": "creation"
}
],
"meta": {
"href": "/api/transaction/changes",
"parent": "/api/transaction",
"transaction": "/api/transaction"
}
}
For more information on the meta object, see Message format.
Elements of the response message include:
| logo_id |
string |
The identifier of the custom logo. |
|
| supported_formats |
enum |
The supported image formats. |
Possible values: PNG, JPEG, GIF. |
| actual_resolution |
number |
The actual resolution of the uploaded custom logo. |
|
| max_resolution |
number |
The maximal resolution of the uploaded custom logo. |
The maximum accepted size is 4096x4096 pixels. |
|
file_size |
number |
The actual size of the file. |
|
|
file_limit |
number |
The maximum size of the file. |
The file size limit is 16 megabyte. |
HTTP response codes
HTTP response codes comprise of standard or endpoint-specific HTTP status and error codes. The following table lists the endpoint-specific HTTP response codes for this request.
| 400 |
ResolutionTooLarge |
The logo you uploaded (5200x5200 pixels) is larger than the maximum accepted size (4096x4096 pixels). Upload a logo that is not larger than 4096x4096 pixels. |
|
413 |
FileTooLarge |
The file in the request exceeds the file size limitation. |
|
415 |
InvalidImageFormat |
The file format of the uploaded logo is not supported. Make sure that you upload a logo in one of our supported file formats (PNG, JPEG, GIF). |
For more information and a complete list of standard HTTP response codes, see Application level error codes.
List of endpoints for configuring the policies, options and connection rules of ICA connections.
URL
GET https://<IP-address-of-SPS>/api/configuration/ica
Cookies
| session_id |
Contains the authentication token of the user |
Required |
The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For more information on authentication, see Authenticate to the SPS REST API.
NOTE: This session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format). |
Sample request
The following command lists the available settings for configuring for ICA connections.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/ica
Response
The following is a sample response received when listing the configuration settings.
For more information on the meta object, see Message format.
{
"items": [
{
"key": "channel_policies",
"meta": {
"href": "/api/configuration/ica/channel_policies"
}
},
{
"key": "connections",
"meta": {
"href": "/api/configuration/ica/connections"
}
},
{
"key": "options",
"meta": {
"href": "/api/configuration/ica/options"
}
},
{
"key": "settings_policies",
"meta": {
"href": "/api/configuration/ica/settings_policies"
}
}
],
"meta": {
"first": "/api/configuration/aaa",
"href": "/api/configuration/ica",
"last": "/api/configuration/x509",
"next": "/api/configuration/local_services",
"parent": "/api/configuration",
"previous": "/api/configuration/http",
"transaction": "/api/transaction"
}
}
| channel_policies |
List of the default and custom channel policies. |
|
connections |
List of ICA connection policies. |
| options |
List of global ICA options that affect all connections. |
| settings_policies |
List of protocol-level settings (timeout, reliability). You can create multiple variations, and choose the appropriate one for each connection policy. |
Status and error codes
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.
| 401 |
Unauthenticated |
The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
| 403 |
Unauthorized |
The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
| 404 |
NotFound |
The requested object does not exist. |
Connection policies determine if a server can be accessed from a particular client. Connection policies reference other resources (policies, usergroups, keys) that must be configured and available before creating a connection policy.
|
|
Caution:
The connection policies of this protocol are available in READ-ONLY mode on the REST API. Also, the returned data is incomplete, it does not include any protocol-specific settings, only the parameters that are common to every supported protocol.
To modify the connection policies of this protocol, you must use the SPS web interface.
Using the REST API, you can modify the connection policies of the RDP and SSH protocols. |
URL
GET https://<IP-address-of-SPS>/api/configuration/ica/connections/
Cookies
| session_id |
Contains the authentication token of the user |
Required |
The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For more information on authentication, see Authenticate to the SPS REST API.
NOTE: This session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format). |
Sample request
The following command lists ICA connection policies.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/ica/connections/
The following command retrieves the properties of a specific policy.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/ica/connections/<connection-key>
