Tool löschen

Ermöglicht das Löschen von Tool innerhalb einer bestimmten Organisation.

Über diese Schnittstelle können Sie Tool innerhalb einer bestimmten Organisation löschen. Für Tool, die bereits von einem Agent eingebunden sind, gilt weiterhin der Löschschutz der Konsole.

Anfragemethode

POST

Anfrage-URL

https://api.${endpoint}/v1/org/tool/delete

Authentifizierung der Anfrage

Basic-Authentifizierung mit DevKey / DevSecret auf Kontoebene; das aufrufende Konto muss über die Berechtigung zum Löschen von Tool der Organisation verfügen.

Anfrage

Beispielanfrage

curl -X POST 'https://api.${endpoint}/v1/org/tool/delete' \ -H 'Authorization: Basic ${BASIC_TOKEN}' \ -H 'Content-Type: application/json' \ -d '{ "org_id": "p-xxxx", "id": "tool-xxxx" }'

                      
                      curl -X POST 'https://api.${endpoint}/v1/org/tool/delete' \
  -H 'Authorization: Basic ${BASIC_TOKEN}' \
  -H 'Content-Type: application/json' \
  -d '{
    "org_id": "p-xxxx",
    "id": "tool-xxxx"
  }'

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Basic ${BASIC_TOKEN}	Basic Token als Base64-Kodierung von `DevKey:DevSecret`.
Content-Type	application/json	Format des Anfrage-Body.

Anfrageparameter (Body Parameters)

Parameter	Typ	Beschreibung	required
org_id	String	Organisations-ID.	true
id	String	Tool-ID.	true

Antwort

Beispielantwort

{ "code": 0, "message": "OK", "affect_count": 1 }

                      
                      {
  "code": 0,
  "message": "OK",
  "affect_count": 1
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
affect_count	Integer	Anzahl der betroffenen Datensätze.

Fehlerantwort

Feld	Typ	Beschreibung
code	Integer	Fehlercode.
message	String	Fehlerdetails.

Statuscodes

Statuscode	Beschreibung
200	Erfolgreich
400	Ungültige Parameter
401	Nicht autorisiert
403	Unzureichende Berechtigungen
429	Zu viele Anfragen
500	Serverfehler