Resyncing overwrites the existing imported endpoint articles. Manually-authored articles are left untouched.
The API token used for authenticating the request. This must be passed as a header parameter. To generate an API token, go to Settings > Knowledge base portal > API tokens. This token must correspond to a valid workspace and permission level.
Resync an API reference with specific apiReferenceId projectVersionId, userId and a spec file url or a file type.
{
"api_reference_id": "d2eafb73-ccb6-4d15-9c4a-959b3c232ddb",
"project_version_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"user_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"force_import": true,
"url": "https://petstore.swagger.io/v2/swagger.json",
"file": null
}The ID of the API reference to resync.
The ID of the workspace (also called project version). Fetch via GET /v2/projectversions.
The ID of the team account performing the resync. Fetch via GET /v2/teams.
When true, the resync proceeds even if validation errors or alerts are present (and confirms deletions surfaced on a previous dry run). When false, validation issues block the resync.
URL pointing to the OpenAPI/Swagger spec to resync from. Mutually exclusive with Document360.Core.Messages.Public.ApiDocumentation.ApiDocumentationResyncRequestCustomer.File.
Uploaded OpenAPI/Swagger spec file (JSON or YAML). Mutually exclusive with Document360.Core.Messages.Public.ApiDocumentation.ApiDocumentationResyncRequestCustomer.Url.
Operation succeeded. Inspect the response envelope's success flag and the result/data payload.
This is the sample response for single API reference resync with server variables.
{
"data": {
"errors": [],
"alerts": [],
"categories_created": 23,
"articles_created": 23,
"deleted_endpoints": null
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}This is the sample response for single API reference resync without server variables.
{
"data": {
"errors": [],
"alerts": [],
"categories_created": 3,
"articles_created": 23,
"deleted_endpoints": null
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [
{
"extension_data": null,
"description": "You may not be able to use try-it feature. Looks like server variables aren’t defined in your OpenAPI Specification file.",
"warning_code": null
}
],
"information": []
}This is the sample response for single API reference resync with force import as false.
{
"data": {
"errors": [
{
"message": "Declared path parameter 'contentId' needs to be defined as a path parameter at either the path or operation level",
"pointer": "#/paths/~1v2~1Content~1{Id}~1version~1{contentCategoryId}/delete/parameters/2/in"
}
],
"alerts": [
{
"message": "Data and type mismatch found.",
"pointer": "#/paths/~1v2~1Content/{Id}/depete/response/200/content/application~1json/examples/Content"
}
],
"categories_created": 3,
"articles_created": 23,
"deleted_endpoints": null
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}Response wrapper for PUT /v2/apireferences — carries the resync summary plus any errors/alerts and (in dry-run mode) the list of endpoint articles that would be removed.
Resync summary — counts, validation results, and pending deletions.
Error log response
One error or alert raised while parsing an imported OpenAPI/Swagger spec.
Descriptive message of the problem.
JSON pointer to the path inside the spec where the problem occurred.
Alerts log response
One error or alert raised while parsing an imported OpenAPI/Swagger spec.
Descriptive message of the problem.
JSON pointer to the path inside the spec where the problem occurred.
Total categories created
Total articles created
Endpoints that will be removed by this spec update. Populated only on dry-run (ForceImport = false). Pass ForceImport = true to confirm.
One endpoint article that a resync would remove. Returned during dry-run (when ForceImport = false) so callers can confirm before committing.
HTTP method, e.g. GET, POST.
Endpoint path, e.g. /users/.
Article ID associated with this endpoint.
Title of the article that documents this endpoint.
Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
One non-fatal warning attached to an otherwise-successful response.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
The request body or query parameters failed validation. Inspect errors[].description for the offending fields.
Kindly ensure that the given project version ID is valid.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "The supplied project version id d2eafb73-ccb6-4d15-9c4a-959b3c232ddba does not exist in your project",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}Kindly ensure that the given API reference ID is valid.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Api reference not found.",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}Kindly ensure that the given user ID is valid.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "The user with id 'f11efc6f-e968-4e95-82eb-85ad61559de8a' does not exist in your project.",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}You have reached your maximum API reference limit, for continuing add a new version.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Unable to add API Reference: Maximum API Reference limit reached",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}You have to provide a valid OAS spec file URL.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Invalid Url",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}You have to provide only a valid OAS spec file or a spec file URL.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "You can only upload URL or a spec file.",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}You have to upload a valid JSON or YAML file.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Only YAML or JSON files are allowed.",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
One non-fatal warning attached to an otherwise-successful response.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
Authentication failed — the api_token header is missing, malformed, or has been revoked.
Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
One non-fatal warning attached to an otherwise-successful response.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
Rate limit exceeded for this api_token. Wait for the duration in the Retry-After header before retrying.
Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
One non-fatal warning attached to an otherwise-successful response.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.