Les API REST de Netskope utilisent un jeton d’authentification pour effectuer des appels autorisés vers l’API. Les API REST de Netskope permettent d’accéder aux ressources via des chemins URI. Le jeton doit être utilisé dans chaque appel API REST pour le locataire. Le jeton peut être généré ou révoqué dans l'interface utilisateur de Netskope en allant à Settings > Tools > Rest API v1.
 |
Pour définir l'expiration du jeton, cliquez sur l'icône en forme de crayon à côté de la date d'expiration.
 |
Dans la liste déroulante, sélectionnez le nombre d'heures, de jours, de semaines ou de mois pendant lesquels le jeton doit rester valide, ou celui pour qu'il n'expire jamais, puis cliquez sur Save.
 |
Demandes HTTP
Le format de l'URL de la demande est le suivant :
https://<tenant-URL>/api/v1/<endpointname>>&<op>=<value>
Les noms des points d'accès et les paramètres de requête valides sont décrits dans les sections suivantes. Le jeton obtenu à partir de la page de l'API REST dans l'interface utilisateur de Netskope est nécessaire.
Réponses HTTP
L'API REST de Netskope utilise le format JSON pour toutes les réponses avec les codes d'erreur suivants :
| Code de réponse HTTP | Description |
|---|---|
| 200 | Success |
| 302 | Redirect |
| 403 | Unauthorized |
| 404 | Non trouvé |
| 429 | Trop de demandes |
| 500 | Erreur de serveur interne |
| 503 | Service en maintenance |
Le format général d'une réponse positive est le suivant :
{
"status" : "success",
"data" : [
{ result entry 1 },
{ result entry 2 },
…
]
}
Le format général d'une réponse d'erreur est le suivant :
{
"status" : "error",
"errorCode" : "error code in string format e.g. Authorization Error"
"errors" : [ "error message 1", "error message 2", ... ]
}
Chaque erreur produit une entrée dans le tableau des erreurs.
Limitation du taux
La limitation du débit doit être prise en compte lors de l'utilisation des API REST de Netskope. Si un niveau d'utilisation excessif est atteint, une erreur standard 429 Too Many Requests sera renvoyée. Pour éviter cette erreur, limitez vos appels à l'API REST à un maximum de 24 requêtes toutes les 5 secondes. Quatre demandes sont traitées la première seconde, tandis que 20 sont mises en file d'attente et traitées au cours des quatre secondes suivantes.
Il existe deux requêtes au format API REST. En voici une :
curl --location 'https://devicedata.qa.boomskope.com/api/v1/clients' \
--header 'Cookie: debug.var.show_response_debug_headers=1' \
--header 'Content-Type: application/json' \
--data '{
"token": "<tenantToken>",
"fields": "host_info.steeringConfig",
"limit": "10"
}'
En voici un autre :
curl --location 'https://webui-qe01-lon3-mp-prod.goskope.com/api/v1/clients' \
--header 'Cookie: debug.var.show_response_debug_headers=1' \
--header 'Content-Type: application/json' \
--data '{
"token": "<tenant token>",
"query": "host_info.steeringConfig notlike Defau",
"limit": "100"
}'
Il existe plusieurs opérateurs. Par exemple : like, not like, gt, lt, ge, et le sont différents opérateurs que vous pouvez utiliser pour "query": "host_info.steeringConfig <OPERATOR> VALUE"