Deletes an API reference
- 02 Nov 2024
- 2 Minutes To Read
- Contributors
- Print
- Dark modeLight
- PDF
Deletes an API reference
- Updated On 02 Nov 2024
- 2 Minutes To Read
- Contributors
- Print
- Dark modeLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Delete
/v2/APIReferences
Security
API Key
Header parameter nameapi_token
Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
Query parameters
projectVersionId
stringRequired
The ID of the project version
apiReferenceId
stringRequired
The ID ofthe API reference
Responses
200
Success
API reference deleted
API reference is deleted successfully.
{
"data": [
{
"api_reference_id": "0a39bfeb-90f8-4fb3-b37a-5838db6387f6",
"details": "Successfully deleted"
}
],
"extension_data": null,
"success": false,
"errors": [],
"warnings": [],
"information": []
}object
data
Array of object (DeleteApiDefinitionCustomer) | null
Response data of the deletion
object
api_reference_id
string | null
The ID of the API reference
details
string | null
Status message
extension_data
object | null
Extention data for customer API response
success
boolean
Status indication for customer API response
errors
Array of object (BaseError) | null
Errors in the customer API response
object
extension_data
object | null
Thids is the Extention data object
stack_trace
string | null
Stack trace for error response message
description
string | null
Description for error cause
error_code
string | null
Error code for Api response
custom_data
object | null
property*
warnings
Array of object (BaseWarning) | null
Warnings in the customer API response
object
extension_data
object | null
Extention Data for customer Api warning
description
string | null
Warning description
warning_code
string | null
warning code for customer Api base response
information
Array of object (BaseInformation) | null
Information passed by the customer API response
object
extension_data
object | null
Extention data for customer Api response information
description
string | null
status description for customer Api response information
400
Bad Request
Invalid API reference
Kindly verify that the API reference ID is valid and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "The supplied project version id 99f4b8d5-ccbd-41c9-8892-57c2fcf338d2 does not exist in your project.",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}object
extension_data
object | null
Extention data for customer API response
success
boolean
Status indication for customer API response
errors
Array of object (BaseError) | null
Errors in the customer API response
object
extension_data
object | null
Thids is the Extention data object
stack_trace
string | null
Stack trace for error response message
description
string | null
Description for error cause
error_code
string | null
Error code for Api response
custom_data
object | null
property*
warnings
Array of object (BaseWarning) | null
Warnings in the customer API response
object
extension_data
object | null
Extention Data for customer Api warning
description
string | null
Warning description
warning_code
string | null
warning code for customer Api base response
information
Array of object (BaseInformation) | null
Information passed by the customer API response
object
extension_data
object | null
Extention data for customer Api response information
description
string | null
status description for customer Api response information
Was this article helpful?
