REST API v1 の概要

Netskope REST API 使う APIに対して認可された呼び出しを行うための認証トークン。 Netskope REST APIはURIパスを通じてリソースへのアクセスを提供します。テナントのREST APIコールごとにトークンは使うでなければなりません。 トークンはNetskope UIで生成または取り消すことができ、 Settings > Tools > Rest API v1に行って行えます。

トークンの有効期限を設定するには、有効期限の横にある鉛筆アイコンをクリックしてください。

ドロップダウンリストから、トークンを有効に保つ時間、日数、週数、月数を選択するか、有効期限をなくすかを選択し、 Saveをクリックします。

HTTPリクエスト

リクエストURLの形式は次のとおりです。

 https://<tenant-URL>/api/v1/<endpointname>>&<op>=<value>

有効なエンドポイント名とクエリパラメータについては、以降のセクションで説明します。Netskope UIのREST APIページから取得したトークンが必要です。

HTTPレスポンス

Netskope REST API 以下のエラーコードを含むすべてのレスポンスのJSON形式：

成功時の応答の一般的な形式は以下のとおりです。

{
    "status" : "success",
    "data" : [
        {   result entry 1 },
        {   result entry 2 },
        …
     ]
}

エラー応答の一般的な形式は以下のとおりです。

{
    "status" : "error",
    "errorCode" :  "error code in string format e.g. Authorization Error"

    "errors" : [ "error message 1", "error message 2", ... ]
}

エラーが発生するたびに、errors配列にエントリが追加されます。

律速段階

Netskope REST API を使用する場合は、レート制限を考慮する必要があります。 使用量が過剰レベルに達した場合、標準のエラーコード「429 Too Many Requests 」が返されます。このエラーを回避するには、REST API呼び出しを5秒間に24件以下に制限してください。最初の1秒間に4件のリクエストが処理され、残りの20件はキューに格納され、次の4秒間に処理される。

REST API形式のクエリは2つあります。ここに一つ例を挙げます。

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

もう一つ例を挙げます。

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

様々な事業者が存在します。例えば、 like 、 not like 、 gt 、 lt 、 ge 、 leは、使用できるさまざまな演算子です。 "query": "host_info.steeringConfig <OPERATOR> VALUE"の場合