Structure de la demande

Les méthodes de demande disponibles sont les suivantes :

• GET – Extrait les données de l’objet spécifié.

• PUT – Ajoute les informations fournies à l’objet indiqué. Renvoie une erreur 404 indiquant que la ressource est introuvable si l’objet n’existe pas.

• POST – Crée l’objet avec les informations fournies.

• DELETE – Supprime l’objet spécifié.

• PATCH – Applique des modifications partielles à l’objet spécifié.

Structure de la réponse

Chaque demande génère une réponse HTTPS par de l’appareil de sécurité adaptable Cisco avec les en-têtes, le contenu de la réponse et le code d’état standard.

La structure de réponse peut être :

• LOCATION – ID de la ressource nouvellement créée; pour POST uniquement : contient le nouvel ID de la ressource (sous forme de représentation d’URI).

• CONTENT-TYPE – Type de support décrivant le corps du message de réponse; décrit la représentation et la syntaxe du corps du message de la réponse.

Chaque réponse comprend un état HTTP ou un code d’erreur. Les codes disponibles appartiennent aux catégories suivantes :

• 20x – Un code de la série deux cent indique qu’une opération a réussi, y compris :

  • 200 OK – Réponse standard pour les demandes ayant réussi.

  • 201 Created – Demande terminée; nouvelle ressource créée.

  • 202 Accepted – Demande acceptée, mais traitement incomplet.

  • 204 No Content – Demande du serveur avec succès; aucun contenu n’est renvoyé.

• 4xx – Un code de la série quatre cent indique une erreur du côté client, notamment :

  • 400 Bad Request – Paramètres de la requête non valides, y compris les paramètres non reconnus, les paramètres manquants ou les valeurs non valides.

  • 204 Not Found – URL fournie qui ne correspond à aucune ressource existante. Par exemple, une demande HTTP DELETE peut échouer, car la ressource n’est pas disponible.

  • 405 Method not Allowed – Demande HTTP présentée qui n’est pas autorisée pour la ressource; par exemple, une demande POST pour une ressource en lecture seule.

• 5xx – Un code de la série cinq cent indique une erreur du côté du serveur.

Dans le cas d’une erreur, en plus du code d’erreur, la réponse renvoyée peut inclure un objet erreur contenant plus de détails sur l’erreur. Le schéma de réponse de l’erreur/avertissement JSON est le suivant :

[
{ “code” : “string”,
“details”: “string”,
“context”: attribute name,
“level” : <Error/Warning/Info>
},
...
]

dans lequel les propriétés de l’objet sont :

Remarque

Les modifications à la configuration des appareils de sécurité adaptables Cisco effectuées par les appels d’API REST ne sont pas conservées dans la configuration de démarrage, ce qui veut dire que les modifications sont apportées uniquement à la configuration en cours. Pour enregistrer ces modifications à la configuration de démarrage, vous pouvez utiliser la commande POST pour une demande d’API writemem. Pour en savoir plus, consultez l’entrée « Write Memory API » dans la table des matières À propos de l’API REST de l’appareil de sécurité adaptable Cisco.

JavaScript

L’utilisation d’un fichier javascript nécessite l’installation de node.js, qui se trouve à l’adresse http://nodejs.org/. À l’aide de node.js, vous pouvez exécuter un fichier javascript généralement écrit pour un navigateur, comme un script pour ligne de commande. Suivez simplement les instructions d’installation, puis exécutez votre script avec le script de node script.js.

Python

Les scripts Python nécessitent l’installation de Python, disponible sur le site https://www.python.org/. Une fois que vous avez installé Python, vous pouvez exécuter votre script avec python script.py nom d’utilisateur mot de passe.

Perl

L’utilisation des scripts Perl nécessite une configuration supplémentaire. Vous aurez besoin de cinq composants, soit Perl lui-même et quatre bibliothèques Perl :

• Perl package disponible à l’adresse http://www.perl.org/

• Bundle::CPAN disponible à l’adresse http://search.cpan.org/~andk/Bundle-CPAN-1.861/CPAN.pm

• REST::Client disponible à l’adresse

  http://search.cpan.org/%7Emcrawfor/REST-Client-88/lib/REST/Client.pm

• MIME::Base64 disponible à l’adresse http://perldoc.perl.org/MIME/Base64.html

• JSON disponible à l’adresse http://search.cpan.org/~makamaka/JSON-2.90/lib/JSON.pm

Voici un exemple de démarrage de Perl sur un Macintosh :

$ sudo perl -MCPAN e shell
cpan> install Bundle::CPAN
cpan> install REST:: Client
cpan> install MIME::Base64
cpan> install JSON

Après avoir installé les dépendances, vous pouvez exécuter votre script en utilisant le script perl script.pl nom d’utilisateur mot de mot de passe.