REST 403 Forbidden error on queryResults request

Expand

Collapse

Advanced SearchOpens new dialog

Enter plus (+) or minus (-) signs in search terms to make a word required or excluded
Search Tips

Search terms

Screen Reader users press enter to select a Filter by product. Filter by product

Screen Reader users press enter to select a Filter by category. Filter by category

Sort by Direction

Answer ID 12122 | Last Review Date 03/17/2022

Why does a queryResults REST request get a 403 Forbidden error?

Environment:

REST queryResults request using a browser based REST client

Issue:

Client does properly URL encode the request URL

Resolution:

Use URL encoding on full REST queryResults requsest URL

Notes:

A queryResults REST request is a standard URL GET request and it needs to have URL encoding on the whole request string. Many browser based rest clients do not properly account for this, the actual request they generate is not fully URL encoded, and it fails before it is actually sent.

If a queryResults request URL like below is used in a browser rest client:

https://examplesite.custhelp.com/services/rest/connect/latest/queryResults/?query=SELECT LookupName FROM Contact WHERE LookupName LIKE '%test%'

A user can get a "Status Code: 403 Forbidden" error and no response will be there. This is because URL used on the request is not fully URL encoded. The full request command can be like below:

curl -X GET -k -H 'OSvC-CREST-Application-Context: Good' -H 'Authorization: Basic REMOVED' -i 'https://examplesite.custhelp.com/services/rest/connect/latest/queryResults/?query=SELECT LookupName FROM Contact WHERE LookupName LIKE '\''%test%'\'

If that command is run, the curl command throws the error, "Status Code: 403 Forbidden" and the request will be not sent.

To avoid that error, get the request sent, and the expected results returned, the URL entered needs to be fully URL encoded. For the above query that would be:

https://examplesite.custhelp.com/services/rest/connect/latest/queryResults/?query=SELECT%20LookupName%20FROM%20Contacts%20WHERE%20LookupName%20LIKE%20'%25test%25'

If a request is properly URL encoded, sent, and does encounter an error from here, an error response and headers would be returned.

Loading...

Login

Why does a queryResults REST request get a 403 Forbidden error?

Was this answer helpful?

Still have questions?

Related Answers

Login