Response Codes

These error codes appear in the body of the HTTP status code response.

Example of 401 error code:

{
  "statusCode": 401,
  "message": "Unauthorized"
}
                                            

Response Codes for GET Requests

Error - 400

When a 400 response code is returned, the following error codes may be included.

Error Code	Description
ConfigurationRestrictedFilterField	The filter field requested was explicitly marked as restricted within the API end point.
ConfigurationRestrictedOperation	The operation requested was explicitly marked as restricted within the provided Query Language Configuration.
ConfigurationRestrictedSortField	The sort field requested was explicitly marked as restricted within the API end point.
FilterExpressionParsingFailed	The filter expression provided could not be parsed. When this occurs, it is recommended to double check the filter input and verify strings are properly single quoted and escaped properly and filter fields have the appropriate spacing after the filter field name.
FilterTokenizationFailed	The filter expression provided could not be fully tokenized. The tokenization process looks to map all aspects of the filter string to an expected output. When this occurs, it is recommended to double check the filter input and verify the proper operations are being used and there are no spelling errors or extra characters.
InvalidFilterFieldName	An invalid filter field name was detected. When this error code is returned, a filter field was used which is not within the API end point schema, i.e. ThisFieldDoesNotExist eq ‘string’.
InvalidFilterFunctionRequested	An invalid filter function name was detected. When this error code is returned, an unknown function was requested. (See the list of valid functions we support, i.e. eq, gt, ge, lt, le, ne, startswith, endswith, in, contains, etc.)
InvalidFilterOperationForField	The filter operation requested is invalid for the filter field. When this error code is returned, an invalid filter operation was requested for the filter field. For example, the function startswith, endswith or contains may have been used against a non-string field.
InvalidFilterValueForField	The filter value provided is invalid for the filter field. See the tables where the value types are listed. For example, an explicit decimal must be declared as 55.00M, if 55.00M is requested for a Guid property, this error would be raised, etc.
InvalidPageSize	The api request has an invalid page size. This error code would be raised if the value of 0 was provided.
InvalidPageNumber	The api request has an invalid page number. This error code would be raised if the value of 0 was provided.
InvalidSortFieldName	An invalid sort field name was detected. When this error code is returned, a sort field was used which is not within the API end point schema, i.e. ThisFieldDoesNotExist eq ‘string’.
MissingRequiredHeader	The http request did not provide a required header. The identifier value of the ApiResponseRecord will provide the header name.
SortExpressionParsingFailed	The sort expression provided could not be parsed. When this occurs, it is recommended to double check the sort input and verify strings are properly single quoted and escaped properly and sort fields have the appropriate spacing after the sort field name.
SortTokenizationFailed	The sort expression provided could not be fully tokenized. The tokenization process looks to map all aspects of the sort string to an expected output. When this occurs, it is recommended to double check the sort input and verify the proper operations are being used and there are no spelling errors or extra characters.

Response Codes for cves-to-patch-group Requests

Error Code	Description
CveHasNoAffectedPatch	At least one of the specified CVEs has no affected patches. Will only occur if the error policy is set to throw.
CveListInvalid	There were no CVEs provided in the request; the list is empty.
CveNotFound	At least one of the specified CVEs does not exist. Will only occur if the error policy is set to throw.
NoAffectedPatchesFound	The list of CVEs provided in the request do not have any affected patches.
PatchGroupAlreadyExists	The patch group name already exists. You must use a unique name when creating a new patch group.
PatchGroupDoesNotExist	The patch group does not exist. You must specify an existing patch group ID when editing a patch group.
PatchGroupCreationFailed	A general error occurred when trying to create the patch group.
PatchGroupNameInvalid	The patch group name provided in the request is invalid. The name cannot be blank or whitespace. Spaces in the name are acceptable, but the name itself cannot be empty.

Error 401

When a 401 response returns following error codes may be included.

Error Code	Description
Unauthorized	If the API call made originally was not successful due to error 401, recall to get a new token and retry their original call with the new JWT.

Error 404

When a 404 response returns following error codes may be included.

Error Code	Description
Not Found	Not Found response status code indicates that the server cannot find the requested resource.

Error 524

When a 524 response returns following error codes may be included.

Error Code	Description
A timeout occurred	This is a temporary error condition that occurs when a web server takes too long to respond to a client request and can be successful the next time with the wait period of 250 milliseconds.