Ana içeriğe geç

Delete LLM Provider Definition

Endpoint

DELETE /apiops/projects/{projectName}/llm-provider-definitions/{definitionName}/

Authentication

Requires a Personal API Access Token.

Authorization: Bearer YOUR_TOKEN

Request

Headers

HeaderValueRequired
AuthorizationBearer {token}Yes

Path Parameters

ParameterTypeRequiredDescription
projectNamestringYesProject name
definitionNamestringYesProvider catalog definition name to delete

Query Parameters

None

Response

Success Response (200 OK)

{
"status": "SUCCESS",
"deploymentResult": {
"success": true
}
}

Response Fields

FieldTypeDescription
statusstringResponse status: SUCCESS or FAILURE
deploymentResultobjectStandard write-envelope result; no worker undeploy is involved (see Notes)
deploymentResult.successbooleantrue when the definition was removed

EnumStatus

  • SUCCESS - Operation successful
  • FAILURE - Operation failed

Error Response (400 Bad Request)

{
"status": "FAILURE",
"resultMessage": "Provider definition (name: internal-llm-gateway) was not found!"
}

or

{
"status": "FAILURE",
"resultMessage": "Built-in provider definitions are read-only."
}

or

{
"status": "FAILURE",
"resultMessage": "Provider definition name can not be empty!"
}

Error Response (401 Unauthorized)

{
"status": "FAILURE",
"resultMessage": "Token is not valid!"
}

cURL Example

curl -X DELETE \
"https://demo.apinizer.com/apiops/projects/MyProject/llm-provider-definitions/internal-llm-gateway/" \
-H "Authorization: Bearer YOUR_TOKEN"

Permissions

  • User must have AI_DEVELOPMENT + MANAGE permission in the project

Notes and Warnings

  • Name-based Deletion:
    • The definition is located by name (case-insensitive) within the caller's visible scope; a non-existent name returns a 400 Bad Request with a "was not found" message
  • Built-in Is Read-Only:
    • Deleting a built-in (Mongock seed) definition is rejected with 400 Bad Request ("Built-in provider definitions are read-only.")
  • Project Ownership Enforced:
    • The service re-verifies the definition belongs to the calling project before deleting, even though the name lookup already scoped to built-in ∪ this project
  • No Worker Undeploy:
    • Unlike deleting an LLM Provider connection, deleting a catalog definition does not undeploy anything from AI Gateway workers — it only removes the template
  • Existing Connections Unaffected:
    • Deleting a definition does not delete or break any ConnectionConfigLlm (LLM Provider) that references it via providerDefinitionId; it only removes it from the catalog offered for future connections
  • Irreversible:
    • There is no soft-delete; deletion is permanent