Errors and Troubleshooting

This page describes the HTTP response status codes that are returned by the Cisco Observability Platform Knowledge Store API and how to troubleshoot them.

304 Not Modified

What Went Wrong?

You supplied an ETag value equal to the current ETag value for the knowledge object you are fetching. For more information on ETags, see RFC 7273.

How to Resolve?

To fetch the knowledge object, get the ETag header from your initial request and supply it as the value to the if-none-match header in the new request.

Example Error Response

Empty response body.

400 Bad Request

What Went Wrong?

The Knowledge Store cannot process the request due to a bad request schema from the client.

How to Resolve?

Check your request syntax, correct the problem, and issue the corrected request.

Example Error Response

{
"type": "bad-data",
"title": "Request has invalid or missing data",
"detail": "If one of layerId or layerType is set, other should be set as well"
}

401 Unauthorized

What Went Wrong?

The client is not authorized to access the selected resource.

How to Resolve?

Ensure that you have the correct permissions to access the selected knowledge object.

Example Error Response

{
"type": "UnAuthorized",
"title": "Authorization Error",
"detail": "Principal information is missing or invalid"
}

403 Forbidden

What Went Wrong?

The client is not authenticated to access the selected resource.

How to Resolve?

Ensure that you meet the following requirements:

  1. You have a valid authorization token.
  2. You have access to the resource you are trying to access.

Example Error Response

{
"type": "not-allowed",
"title": "Operation not allowed",
"detail": "Operation not allowed. Please subscribe to the SOLUTION_NAME solution and retry your operation"
}

404 Not Found

What Went Wrong?

The client is trying to access a resource that does not exist.

How to Resolve?

Ensure that:

  1. You are using the correct knowledge object ID.
  2. All of your headers are set correctly.

Example Error Response

{
"type": "not-found",
"title": "object not found",
"detail": ""
}

409 Conflict

What Went Wrong?

The client is trying to create a knowledge object with the ID of an existing knowledge object, causing an ID conflict issue.

How to Resolve?

Ensure that the ID for the knowledge object that you want to create is not the same as the ID of an existing knowledge object at that layer.

Example Error Response

{
"type": "Conflict",
"title": "Conflict: Object with id YOUR_ID, layerId: YOUR_LAYER_ID and layerType: TENANT, fqtn: YOUR_FQTN already exists",
"detail": ""
}

412 Precondition Failed

What Went Wrong?

The client is issuing a request to a knowledge object with an incorrect if-match ETag header.

How to Resolve?

Ensure that the if-match header for the ETag in your request is set correctly.

Example Error Response

{
"type": "Precondition Failed",
"title": "Precondition Failed",
"detail": ""
}

500 Internal Server Error

What Went Wrong?

The server cannot process the request due to an unexpected error.

How to Resolve?

Ensure that:

  • There are no errors in the configuration of your request, such as typos, whitespace, or invalid JSON formatting.
  • The following elements are configured correctly in the request:
    • Request headers
    • Parameters in the request body
    • Query parameters
      • Filter query parameters
    • HTTP method

If the error persists, reach out to Cisco AppDynamics support.

Example Error Response

Empty response body.