Deletes an API reference
  • 25 Nov 2023
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Deletes an API reference

  • Dark
    Light

Article Summary

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": []
}
Expand All
object
data
Array of object (DeleteApiDefinitionCustomer)

Response data of the deletion

object
api_reference_id
string

The ID of the API reference

details
string

Status message

extension_data
object (ExtensionDataObject)
success
boolean

Status indication for customer API response

errors
Array of object (BaseError)

Errors in the customer API response

object
extension_data
object (ExtensionDataObject)
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api response

custom_data
object
warnings
Array of object (BaseWarning)

Warning in the customer API response

object
extension_data
object (ExtensionDataObject)
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object (BaseInformation)

Information passed by the customer API response

object
extension_data
object (ExtensionDataObject)
description
string

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.

{
  "data": null,
  "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": []
}
Expand All
object
data
Array of object (DeleteApiDefinitionCustomer)

Response data of the deletion

object
api_reference_id
string

The ID of the API reference

details
string

Status message

extension_data
object (ExtensionDataObject)
success
boolean

Status indication for customer API response

errors
Array of object (BaseError)

Errors in the customer API response

object
extension_data
object (ExtensionDataObject)
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api response

custom_data
object
warnings
Array of object (BaseWarning)

Warning in the customer API response

object
extension_data
object (ExtensionDataObject)
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object (BaseInformation)

Information passed by the customer API response

object
extension_data
object (ExtensionDataObject)
description
string

status description for customer Api response information


Was this article helpful?