Delete A Tool

Permanently removes a tool registration and its key pair. Launches referencing this tool will fail afterwards.

tip

If you only want to stop launches temporarily, deactivate the tool instead — deactivation is reversible, deletion is not.

Path Parameters

toolId string required
The tool's ID, as returned at registration. This is also the tool's clientId.
Example: 3wT7bVhUADSsfdG33fVV

Responses

• 204
• 401
• 403
• 404

---

Tool deleted

The Authorization header was missing, malformed, or carried the wrong key.

application/json

Schema

Example (from schema)

Example

---

Schema

status integer
error string
details object

Context for the failure. Always carries a message code; the other keys depend on what went wrong.

message string

description string

property name* any

Context for the failure. Always carries a message code; the other keys depend on what went wrong.

{
  "status": 403,
  "error": "Forbidden",
  "details": {
    "message": "INACTIVE_SERVICE",
    "description": "string"
  }
}

{
  "status": 401,
  "error": "Unauthorized",
  "details": {
    "message": "INVALID_BEARER_AUTHORIZATION_HEADER",
    "description": "Invalid API Key for account."
  }
}

The account is not permitted to use this endpoint — most often because it is an LTIAAS Launch account rather than a Connect one, or because a trial quota has been reached.

application/json

Schema

Example (from schema)

Example

---

Schema

status integer
error string
details object

Context for the failure. Always carries a message code; the other keys depend on what went wrong.

message string

description string

property name* any

Context for the failure. Always carries a message code; the other keys depend on what went wrong.

{
  "status": 403,
  "error": "Forbidden",
  "details": {
    "message": "INACTIVE_SERVICE",
    "description": "string"
  }
}

{
  "status": 403,
  "error": "Forbidden",
  "details": {
    "message": "INVALID_ACCOUNT_TYPE"
  }
}

No tool with that ID is registered on this account.

application/json

Schema

Example (from schema)

Example

---

Schema

status integer
error string
details object

Context for the failure. Always carries a message code; the other keys depend on what went wrong.

message string

description string

property name* any

Context for the failure. Always carries a message code; the other keys depend on what went wrong.

{
  "status": 403,
  "error": "Forbidden",
  "details": {
    "message": "INACTIVE_SERVICE",
    "description": "string"
  }
}

{
  "status": 404,
  "error": "Not Found",
  "details": {
    "message": "UNREGISTERED_TOOL"
  }
}

Loading...