Supprimer un Tool

Permet de supprimer un Tool au sein de l'organisation spécifiée.

Cette interface permet de supprimer un Tool au sein de l'organisation spécifiée. Les Tools déjà rattachés à un Agent conservent la protection de suppression de la console.

Méthode de requête

POST

URL de la requête

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

Authentification de la requête

Utilise l'authentification Basic avec la DevKey / le DevSecret de niveau compte et requiert que le compte appelant dispose de l'autorisation de suppression des Tools de l'organisation.

Requête

Exemple de requête

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"
  }'

Ce bloc de code dans la fenêtre flottante

En-têtes de la requête

Champ	Type	Description
Authorization	Basic ${BASIC_TOKEN}	Utilisez le Basic Token obtenu en encodant `DevKey:DevSecret` en Base64.
Content-Type	application/json	Format du corps de la requête.

Paramètres de la requête (Body Parameters)

Champ	Type	Description	required
org_id	String	ID de l'organisation.	true
id	String	ID du Tool.	true

Réponse

Exemple de réponse

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

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

Ce bloc de code dans la fenêtre flottante

Réponse en cas de succès

Champ	Type	Description
affect_count	Integer	Nombre d'enregistrements affectés.

Réponse en cas d'échec

Champ	Type	Description
code	Integer	Code d'erreur.
message	String	Détails de l'erreur.

Codes d'état

Code d'état	Description
200	Succès
400	Erreur de paramètre
401	Non autorisé
403	Autorisation insuffisante
429	Requêtes trop fréquentes
500	Erreur du serveur