Managing Connectors
Troubleshooting
An unsuccessful API request will return the following information in the response body:
- Type: A link to the standard HTTP response code.
- Details: A brief description of the error.
- Parameters: An optional JSON object to provide extra error information.
Sample API error response
{
"type": "404",
"detail": "resource not found",
"parameters":
{
"name": "entityType",
"value": "the request URL"
}
}
<!--NeedCopy-->
Response codes
The following section lists the response codes for the APIs with examples.
200 OK
GET/ connectors
Connectors retrieved successfully
[
{
"id": "82f74aa7-cf5a-426f-9b77-e5575f345161",
"fqdn": "test.test.com99",
"role": null,
"windowsSid": "H-1-5-55-3517433112-90434251-1726469244-1000",
"location": "7b0b5e50-2321-45e9-a2da-a79a9234d66c",
"currentVersion": "4.354.0.60932",
"currentBootstrapperVersion": "6.96.0.61152",
"expectedVersion": "4.370.0.1227",
"expectedBootStrapperVersion": "6.109.0.1227",
"versionState": "Normal",
"inMaintenance": false,
"leaseEndDateTime": null,
"upgradeDisabled": false,
"connectorType": "Windows",
"status": "Unknown",
"lastContactDate": "2024-11-21T18:34:40.5714338Z"
},
{
"id": "4c8da152-4acc-4eca-b593-1c8174931032",
"fqdn": "test.test.com",
"role": null,
"windowsSid": "S-1-5-21-1788343907-83030196-1888898617-11255",
"location": "bcea109e-6c35-8892-868d-eb7f5528291b",
"currentVersion": "4.354.0.61119",
"currentBootstrapperVersion": "6.96.0.61152",
"expectedVersion": "4.370.0.1227",
"expectedBootStrapperVersion": "6.109.0.1227",
"versionState": "Normal",
"inMaintenance": false,
"leaseEndDateTime": null,
"upgradeDisabled": false,
"connectorType": "Windows",
"status": "Unknown",
"lastContactDate": "2024-07-02T16:57:42.1421261Z"
}
]
<!--NeedCopy-->
401 Unauthorized
GET/ connectors
Case 1: If the authorization header is empty or missing, the ‘value’ in the ‘parameters’ subschema is ‘missing’
{
"type": "https://errors-api.cloud.com/common/authentication",
"detail": "Missing or invalid authentication details",
"parameters": [
{
"name": "reason",
"value": "missing"
}
]
}
<!--NeedCopy-->
Case 2: If the Authorization header is invalid the reason mentioned in the parameters value is invalid
{
"type": "https://errors-api.cloud.com/common/authentication",
"detail": "Missing or invalid authentication details",
"parameters": [
{
"name": "reason",
"value": "invalid"
}
]
}
<!--NeedCopy-->
403 Forbidden
If the Authorization details are provided incorrectly in the header then following error occurs:
GET/ connectors
Case 1: Customer (bearer token) details are not correct
{
"type": "https://errors-api.cloud.com/common/authorization",
"detail": "Access denied"
}
<!--NeedCopy-->
404 Not Found
GET/ connectors
Case 1: In case the URL does not match the OpenAPI Specification
{
"type": "https://errors-api.cloud.com/connectors/notFound",
"detail": "resource not found",
"parameters": [
{
"name": "entityType",
"value": "/connectors"
}
]
}
<!--NeedCopy-->
500 Internal Server Error
Report these errors directly to the engineering team to help resolve the issues. Take a note of the customer ID and Transaction ID from the customer to troubleshoot further.
GET/ connectors
Case 1: Server Errors
{
"type": "https://errors-api.cloud.com/connectors/internalerror",
"detail": "There was a internal issue"
}
<!--NeedCopy-->
Troubleshooting
In this article
Copied!
Failed!