Required header for calling a web service
All web service requests must include these two headers.
- Accept:application/json
- The
acceptheader must be present and the value must be set toapplication/json. If the header is missing, or set as a different value, the web service request fails. - BA header
- Each request must contain a BA header with a valid user name and password. If this header is missing, the request fails.
The following example is the valid request format for retrieving
the list of reverse proxy instances by using curl.
curl -k -H "Accept:application/json" --user username:password
https://{appliance_hostname}/reverseproxyNote: The
previous list contains only two headers that are mandatory for all
web service requests. It is not an extensive list of headers that
are required for all request actions. The previous example shows a
curl GET request on a resource URI. This request requires only the
two mandatory headers that are listed. Other HTTP methods, such as
POST or PUT, require more headers. The following example is a valid
request for starting a reverse proxy instance called
inst1 using
curl:curl -k -H "Accept:application/json" -H "Content-type:application/json"
--user username:password --data-binary '{ 'operation':'start' }'
-X PUT https://{appliance_hostname}/reverseproxy/inst1Notice the additional required header Content-type for the PUT operation.
Other HTTP clients, such as Java, might require more headers. For required headers for RESTful web services, check the HTTP client documentation.