One Identity Safeguard for Privileged Sessions 7.0.5.1 LTS - REST API Reference Guide

URL

GET https://<IP-address-of-SPS>/api/configuration/http/error_templates

Operations

Operations with the /http/error_templates endpoint include:

Sample request

The following command lists the available HTTP proxy error templates.

curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/http/error_templates

Response

The following is a sample response received when available HTTP proxy error templates are queried.

{
     "name": "Template_with_logo",
     "color": "#123456",
     "logo": "<'logo_id' from the response of the first creation>",
     "brand_name": "Noname brand",
     "md_contents": {
       "auth": "Custom auth failed markdown content.",
       "badcontent": "Custom bad content error markdown content.",
       "clientsyntax": "Custom client syntax error markdown content.",
       "clienttimeout": "Custom client timeout error markdown content.",
       "connecterror": "Custom connection error markdown content.",
       "ftperror": "Custom FTP error markdown content.",
       "internal": "Custom internal error markdown content.",
       "invalidurl": "Custom invalid URL markdown content.",
       "ioerror": "Custom I/O error markdown content.",
       "policysyntax": "Custom policy syntax error markdown content.",
       "policyviolation": "Custom policy violation error markdown content.",
       "redirect": "Custom redirect markdown content.",
       "serversyntax": "Custom server syntax error markdown content.",
       "servertimeout": "Custom server timeout error markdown content."
     }
    }

The following is a sample response received when HTTP proxy error template information is queried with /api/configuration/http/error_templates?info=.

{
     "error_type_names": {
       "auth": "Authentication Failed",
       "badcontent": "Bad Content",
       "clientsyntax": "Client Syntax",
       "clienttimeout": "Client Timeout",
       "connecterror": "Connection Error",
       "ftperror": "FTP Error",
       "internal": "Internal Error",
       "invalidurl": "Invalid URL",
       "ioerror": "I/O Error",
       "policysyntax": "Policy Syntax",
       "policyviolation": "Policy Violation",
       "redirect": "Redirect",
       "serversyntax": "Server Syntax",
       "servertimeout": "Server Timeout"
     }
    }

Elements of the response message include:

For details of the meta object, see Message format.

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.

For more information and a complete list of standard HTTP response codes, see Application level error codes.