Cisco Secure Application API

このページでは、選択したパラメータ、ダッシュボード、およびセキュリティレポートをクエリするために使用できる Cisco Secure Application API メソッドについて説明します。

アクセストークンの生成

OAuth API を使用してトークンを生成することによって、コントローラへの各 API アクセスコールのアクセストークンを生成できます。

エンドポイントの使用例：

curl -X GET  'https://<controller address>/controller/argento/public-api/v1/applications' \
--header 'Authorization: Bearer <your-token-from-ouath-above>'

BASH

アプリケーションリストの取得

この API コールは、指定されたクエリパラメータに基づいてアプリケーションのリストを取得します。

GET controller/argento/public-api/v1/applications

CODE

パラメータ

名前	[タイプ（Type）]	説明
`date`	`string`	これは、アプリケーションのノードの日次統計カウントの日付です。これは RFC3339 フォーマットです。例：2023-05-25T00:10:01-02:00
`sort`	`string`	これにより、特定のフィールドでアプリケーションをソートできます。例：`sort=applicationName`。
`order`	`string`	アプリケーションの昇順または降順です。
`filter`	`string`	これにより、特定のフィールドでアプリケーションをフィルタできます。例：`filter=applicationName eq "application1"`。
`max`	`integer`	返されるアプリケーションの最大数です。デフォルトは `10` に設定されています。
`offset`	`integer`	ページネーションのオフセットです。デフォルトは `0` に設定されています。
`applicationId`	`integer`	これは、出力を 1 つのアプリケーションに制限するグローバルアプリケーションフィルタです。応答からフィールド `appdApplicationId` 値を使用します。

レスポンス

アプリケーションリストが正常に取得された場合：

{
  "items": [
    {
      "appdApplicationId": 0,
      "applicationCreatedAt": "string",
      "applicationId": "string",
      "applicationName": "string",
      "applicationSecurityEnabled": true,
      "applicationSecurityEnabledComputed": true,
      "countApmActive": 0,
      "countReady": 0,
      "countSecured": 0,
      "countSecurityEnabled": 0,
      "countSupportedAgent": 0
    }
  ],
  "total": 0
}

JSON

不正な要求の場合：

{
  "error": "string"
}

JSON

内部サーバーエラーの場合：

{
  "error": "string"
}

JSON

アプリケーションの詳細の取得

この API コールは、特定のアプリケーションと指定されたクエリパラメータに基づいて階層のリストを取得します。

GET controller/argento/public-api/v1//applications/{applicationId}/tiers

CODE

パラメータ

名前	[タイプ（Type）]	説明
`applicationId`	`string`	特定のアプリケーション階層の詳細に使用される必須のアプリケーション ID です。
`date`	`string`	これは、RFC3339 フォーマットの日付です。例：2023-05-25T00:10:01-02:00
`sort`	`string`	これにより、特定のフィールドでアプリケーションをソートできます。例：`sort=applicationName`。
`order`	`string`	アプリケーションの昇順または降順です。
`filter`	`string`	これにより、特定のフィールドでアプリケーションをフィルタできます。例：`filter=applicationName eq "application1"`。
`max`	`integer`	返されるアプリケーションの最大数です。デフォルトは `10` に設定されています。
`offset`	`integer`	ページネーションのオフセットです。デフォルトは `0` に設定されています。
`applicationId`	`integer`	これは、出力を 1 つのアプリケーションに制限するグローバルアプリケーションフィルタです。
`tierId`	`integer`	出力を 1 つの階層のみに制限するグローバル階層フィルタです。応答の `appdTierId` 値を使用します。

レスポンス

特定のアプリケーションの階層リストが正常に取得された場合：

{
  "items": [
    {
      "appdApplicationId": 0,
      "appdTierId": 0,
      "applicationName": "string",
      "countApmActive": 0,
      "countReady": 0,
      "countSecured": 0,
      "countSecurityEnabled": 0,
      "countSupportedAgent": 0,
      "id": "string",
      "tierCreatedAt": "string",
      "tierEnableSecurity": true,
      "tierEnableSecurityStatus": true,
      "tierName": "string"
    }
  ],
  "total": 0
}

JSON

不正なリクエストの場合：

{
  "error": "string"
}

JSON

内部サーバーエラーの場合：

{
  "error": "string"
}

JSON

攻撃リストの取得

attackSummaryId が指定されている場合、この API コールは特定の攻撃の詳細を取得します。指定されていない場合、この API は攻撃リストを取得します。

GET controller/argento/public-api/v1/attacks

CODE

パラメータ

名前	[タイプ（Type）]	説明
`startedAt`	`string`	RFC3339 フォーマットのトランザクションの開始時刻です。例：2023-05-25T00:10:01-02:00
`endedAt`	`string`	RFC3339 フォーマットのトランザクションの終了時刻です。例：2023-05-25T00:10:01-02:00
`sort`	`string`	これにより、特定のフィールドで攻撃をソートできます。例：`sort=attackName`。
`order`	`string`	ソートフィールドの昇順または降順です。
`filter`	`string`	これにより、特定のフィールドで攻撃をフィルタできます。例：`filter=attackName eq "dangerousOne"`。
`max`	`integer`	返される攻撃の最大数です。デフォルトは `10` に設定されています。
`offset`	`integer`	ページネーションのオフセットです。デフォルトは `0` に設定されています。
`applicationId`	`integer`	これは、出力を 1 つのアプリケーションに制限するグローバルアプリケーションフィルタです。応答の `appdApplicationId` 値を使用します。
`tierId`	`integer`	出力を 1 つの階層のみに制限するグローバル階層フィルタです。応答の `appdTierId` 値を使用します。

レスポンス

攻撃リストまたは攻撃の詳細が正常に取得された場合：

 {
      "appdApplicationId": 0,
      "appdBtId": 0,
      "appdTierId": 0,
      "applicationName": "string",
      "attackName": "string",
      "attackNote": "string",
      "attackOutcome": "string",
      "attackSource": "string",
      "attackStatus": "string",
      "attackSummaryId": "string",
      "attackTypes": "string",
      "btName": "string",
      "btUuid": "string",
      "firstSeenAt": "string",
      "keyInfo": "string",
      "lastSeenAt": "string",
      "tierName": "string"
    }
  ],
  "total": 0
}

JSON

不正なリクエストの場合：

{
  "error": "string"
}

JSON

内部サーバーエラーの場合：

{
  "error": "string"
}

JSON

攻撃の詳細の取得

attackSummaryId が指定されている場合、この API コールは特定の攻撃の詳細を取得します。指定されていない場合、この API は攻撃リストを取得します。

GET controller/argento/public-api/v1/attacks/{attackSummaryId}

CODE

パラメータ

名前	[タイプ（Type）]	説明
`attackSummaryId`	`string`	特定の攻撃の詳細に必要な攻撃サマリー ID です。
`startedAt`	`string`	RFC3339 フォーマットのトランザクションの開始時刻です。例：2023-05-25T00:10:01-02:00
`endedAt`	`string`	RFC3339 フォーマットのトランザクションの終了時刻です。例：2023-05-25T00:10:01-02:00
`sort`	`string`	これにより、特定のフィールドで攻撃をソートできます。例：`sort=attackName`。
`order`	`string`	ソートフィールドの昇順または降順です。
`filter`	`string`	これにより、特定のフィールドで攻撃をフィルタできます。例：`filter=attackName eq "dangerousOne"`。
`max`	`integer`	返される攻撃の最大数です。デフォルトは `10` に設定されています。
`offset`	`integer`	ページネーションのオフセットです。デフォルトは `0` に設定されています。
`applicationId`	`integer`	これは、出力を 1 つのアプリケーションに制限するグローバルアプリケーションフィルタです。応答の `appdApplicationId` 値を使用します。
`tierId`	`integer`	出力を 1 つの階層のみに制限するグローバル階層フィルタです。応答の `appdTierId` 値を使用します。

レスポンス

攻撃リストまたは攻撃の詳細が正常に取得された場合：

{
  "items": [
    {
      "appdApplicationId": 0,
      "appdBtId": 0,
      "appdTierId": 0,
      "applicationName": "string",
      "attackName": "string",
      "attackNote": "string",
      "attackOutcome": "string",
      "attackSource": "string",
      "attackStatus": "string",
      "attackSummaryId": "string",
      "attackTypes": "string",
      "btName": "string",
      "btUuid": "string",
      "firstSeenAt": "string",
      "keyInfo": "string",
      "lastSeenAt": "string",
      "tierName": "string"
    }
  ],

JSON

不正なリクエストの場合：

{
  "error": "string"
}

JSON

内部サーバーエラーの場合：

{
  "error": "string"
}

JSON

⁪ビジネストランザクションリストの取得

この API コールは、指定されたクエリパラメータに基づいてビジネストランザクションのリストを取得します。

GET controller/argento/public-api/v1/businessTransactions

CODE

パラメータ

名前	[タイプ（Type）]	説明
`startedAt`	`string`	RFC3339 フォーマットのトランザクションの開始時刻です。例：2023-05-25T00:10:01-02:00
`endedAt`	`string`	RFC3339 フォーマットのトランザクションの終了時刻です。例：2023-05-25T00:10:01-02:00
`sort`	`string`	これにより、特定のフィールドでトランザクションをソートできます。例：`sort=businessTransactionNam`e。
`order`	`string`	ソートフィールドの昇順または降順です。
`filter`	`string`	これにより、特定のフィールドでトランザクションをフィルタできます。例：`filter=businessTransactionName eq "businessOne"`。
`max`	`integer`	返されるトランザクションの最大数です。デフォルトは `10` に設定されています。
`offset`	`integer`	ページネーションのオフセットです。デフォルトは `0` に設定されています。
`applicationId`	`integer`	これは、出力を 1 つのアプリケーションに制限するグローバルアプリケーションフィルタです。応答の `appdApplicationId` 値を使用します。
`tierId`	`integer`	出力を 1 つの階層のみに制限するグローバル階層フィルタです。応答の `appdTierId` 値を使用します。

レスポンス

ビジネストランザクションリストが正常に取得された場合：

{
  "items": [
    {
      "appdApplicationId": 0,
      "appdBusinessTransactionId": 0,
      "applicationId": "string",
      "applicationName": "string",
      "attackOutcomeCountAttempted": 0,
      "attackOutcomeCountBlocked": 0,
      "attackOutcomeCountExploited": 0,
      "brmTitle": "string",
      "businessRiskScore": 0,
      "businessTransactionId": "string",
      "businessTransactionName": "string",
      "entryTierAppdId": 0,
      "entryTierId": "string",
      "entryTierName": "string",
      "riskScore": 0,
      "severityCountCritical": 0,
      "severityCountHigh": 0,
      "severityCountLow": 0,
      "severityCountMedium": 0,
      "tierCount": 0,
      "totalAttackCount": 0,
      "totalVulnCount": 0
    }
  ],
  "total": 0
}

JSON

不正なリクエストの場合：

{
  "error": "string"
}

JSON

内部サーバーエラーの場合：

{
  "error": "string"
}

JSON

ビジネストランザクションの詳細の取得

この API コールは、指定されたクエリパラメータに基づいてビジネストランザクションの詳細を取得します。

GET controller/argento/public-api/v1/businessTransactions/{businessTransactionId}

CODE

パラメータ

名前	[タイプ（Type）]	説明
`businessTransactionId`	`string`	これは、必要なビジネストランザクション ID です。

レスポンス

特定のビジネストランザクションの正常かつ詳細な取得：

{
  "appdApplicationId": 0,
  "appdBusinessTransactionId": 0,
  "applicationName": "string",
  "brmTitle": "string",
  "businessRiskScore": 0,
  "businessTransactionName": "string",
  "entryTierAppdId": 0,
  "entryTierName": "string",
  "riskScore": 0,
  "riskScoreCard": "string"
}

JSON

不正なリクエストの場合：

{
  "error": "string"
}

JSON

内部サーバーエラーの場合：

{
  "error": "string"
}

JSON

ライブラリリストの取得

この API コールは、指定されたクエリパラメータに基づいてライブラリのリストを取得します。

GET controller/argento/public-api/v1/libraries

CODE

パラメータ

名前	[タイプ（Type）]	説明
`startedAt`	`string`	RFC3339 フォーマットのトランザクションの開始時刻です。例：2023-05-25T00:10:01-02:00
`endedAt`	`string`	RFC3339 フォーマットのトランザクションの終了時刻です。例：2023-05-25T00:10:01-02:00
`sort`	`string`	これにより、特定のフィールドでライブラリをソートできます。例：`sort=applicationName`。
`order`	`string`	ソートフィールドの昇順または降順です。
`filter`	`string`	これにより、特定のフィールドでライブラリをフィルタできます。例：`filter=applicationName eq "application1"`
`max`	`integer`	返されるライブラリの最大数です。デフォルトは `10` に設定されています。
`offset`	`integer`	ページネーションのオフセットです。デフォルトは `0` に設定されています。
`applicationId`	`integer`	これは、出力を 1 つのアプリケーションに制限するグローバルアプリケーションフィルタです。応答の `appdApplicationId` 値を使用します。
`tierId`	`integer`	出力を 1 つの階層のみに制限するグローバル階層フィルタです。応答の `appdTierId` 値を使用します。

レスポンス

ライブラリリストが正常に取得された場合：

{
  "items": [
    {
      "active_internet_breach": true,
      "affectedNodeCount": 0,
      "appdApplicationId": 0,
      "appdTierId": 0,
      "applicationName": "string",
      "easily_exploitable": true,
      "kennaRiskScore": 0,
      "libraryId": "string",
      "malware_exploitable": true,
      "packageCanonicalName": "string",
      "packageId": "string",
      "packageLanguage": "string",
      "packageName": "string",
      "packageVersion": "string",
      "popular_target": true,
      "predicted_exploitable": true,
      "recommendedVersion": "string",
      "remote_code_execution": true,
      "riskScore": 0,
      "severity": "string",
      "severityCountCritical": 0,
      "severityCountHigh": 0,
      "severityCountLow": 0,
      "severityCountMedium": 0,
      "status": "string",
      "tierName": "string",
      "totalVulnCount": 0
    }
  ],
  "total": 0
}

JSON

不正なリクエストの場合：

{
  "error": "string"
}

JSON

内部サーバーエラーの場合：

{
  "error": "string"
}

JSON

ライブラリの詳細の取得

この API コールは、指定されたクエリパラメータに基づいてライブラリの詳細を取得します。

GET controller/argento/public-api/v1/libraries/{libraryId}

CODE

パラメータ

名前	[タイプ（Type）]	説明
`libraryId`	`string`	必要なライブラリ ID です。
`applicationId`	`integer`	これは、出力を 1 つのアプリケーションに制限するグローバルアプリケーションフィルタです。応答の `appdApplicationId` 値を使用します。
`tierId`	`integer`	出力を 1 つの階層のみに制限するグローバル階層フィルタです。応答の `appdTierId` 値を使用します。

レスポンス

特定のライブラリの正常かつ詳細な取得：

{
  "active_internet_breach": true,
  "affectedNodeCount": 0,
  "appdApplicationId": 0,
  "appdTierId": 0,
  "applicationName": "string",
  "easily_exploitable": true,
  "kennaRiskScore": 0,
  "libraryId": "string",
  "malware_exploitable": true,
  "packageCanonicalName": "string",
  "packageId": "string",
  "packageLanguage": "string",
  "packageName": "string",
  "packageVersion": "string",
  "popular_target": true,
  "predicted_exploitable": true,
  "recommendedVersion": "string",
  "remote_code_execution": true,
  "riskScore": 0,
  "severity": "string",
  "severityCountCritical": 0,
  "severityCountHigh": 0,
  "severityCountLow": 0,
  "severityCountMedium": 0,
  "status": "string",
  "tierName": "string",
  "totalVulnCount": 0
}

JSON

不正なリクエストの場合：

{
  "error": "string"
}

JSON

内部サーバーエラーの場合：

{
  "error": "string"
}

JSON

ビジネスリスクのスコアの取得

この API コールは、指定されたクエリパラメータに基づいたアプリケーションとビジネストランザクションによってビジネスリスクスコアを取得します。

GET controller/argento/public-api/v1/stats/businessRisk

CODE

パラメータ

名前	[タイプ（Type）]	説明
`btld`	`string`	これは、ビジネストランザクション ID です。
`applicationId`	`integer`	これは、出力を 1 つのアプリケーションに制限するグローバルアプリケーションフィルタです。応答の `appdApplicationId` 値を使用します。
`tierId`	`integer`	出力を 1 つの階層のみに制限するグローバル階層フィルタです。応答の `appdTierId` 値を使用します。

レスポンス

ビジネスリスクスコアが正常に取得された場合：

{
  "brmTitle": "string",
  "businessRiskScore": 0
}

JSON

不正なリクエストの場合：

{
  "error": "string"
}

JSON

内部サーバーエラーの場合：

{
  "error": "string"
}

JSON

脆弱性リストの取得

この API コールは、指定されたクエリパラメータに基づいて脆弱性のリストを取得します。

GET controller/argento/public-api/v1/vulnerabilities

CODE

パラメータ

名前	[タイプ（Type）]	説明
`startedAt`	`string`	RFC3339 フォーマットのトランザクションの開始時刻です。例：2023-05-25T00:10:01-02:00
`endedAt`	`string`	RFC3339 フォーマットのトランザクションの終了時刻です。例：2023-05-25T00:10:01-02:00
`sort`	`string`	これにより、特定のフィールドで脆弱性をソートできます。例：`sort=cweName`。
`order`	`string`	ソートフィールドの昇順または降順です。
`filter`	`string`	これにより、特定のフィールドで脆弱性をフィルタできます。例：filter=cweName eq "CW-94"
`max`	`integer`	返されるライブラリの最大数です。デフォルトは `10` に設定されています。
`offset`	`integer`	ページネーションのオフセットです。デフォルトは `0` に設定されています。
`applicationId`	`integer`	これは、出力を 1 つのアプリケーションに制限するグローバルアプリケーションフィルタです。応答の `appdApplicationId` 値を使用します。
`tierId`	`integer`	出力を 1 つの階層のみに制限するグローバル階層フィルタです。応答の `appdTierId` 値を使用します。

レスポンス

脆弱性リストが正常に取得された場合：

{
  "items": [
    {
      "active_internet_breach": true,
      "affectedNodeCount": 0,
      "appdApplicationId": 0,
      "appdTierId": 0,
      "applicationName": "string",
      "attackSummaryId": "string",
      "cveId": "string",
      "cveName": "string",
      "cvePublishDate": "string",
      "cveTitle": "string",
      "cweName": "string",
      "easily_exploitable": true,
      "firstSeenAt": "string",
      "hasAttacks": true,
      "hasEvent": true,
      "hasObservations": true,
      "incidentId": "string",
      "kennaScore": 0,
      "lastSeenAt": "string",
      "libraryId": "string",
      "malware_exploitable": true,
      "packageCanonicalName": "string",
      "packageId": "string",
      "packageLanguage": "string",
      "popular_target": true,
      "predicted_exploitable": true,
      "remediation": "string",
      "remote_code_execution": true,
      "riskScore": 0,
      "severity": "string",
      "status": "Unknown",
      "tierId": "string",
      "tierName": "string"
    }
  ],
  "total": 0
}

JSON

不正なリクエストの場合：

{
  "error": "string"
}

JSON

内部サーバーエラーの場合：

{
  "error": "string"
}

JSON

脆弱性の詳細の取得

この API コールは、指定されたクエリパラメータに基づいて脆弱性の詳細を取得します。

GET controller/argento/public-api/v1/vulnerabilities/{cveId}

CODE

パラメータ

名前	[タイプ（Type）]	説明
`cveId`	`string`	必要な CVE ID です。

レスポンス

特定の脆弱性の正常かつ詳細な取得です。

{
  "createdAt": "string",
  "cveId": "string",
  "cveTitle": "string",
  "cvss3BaseScore": 0,
  "cvss3VectorString": "string",
  "cweName": "string",
  "description": "string",
  "kenna": {
    "active_internet_breach": true,
    "easily_exploitable": true,
    "malware_exploitable": true,
    "popular_target": true,
    "predicted_exploitable": true,
    "remote_code_execution": true,
    "risk_score_meter": 0
  },
  "name": "string",
  "nvdUrl": "string",
  "publishDate": "string",
  "remediation": "string",
  "severity": "string",
  "updatedAt": "string"
}

JSON

不正なリクエストの場合：

{
  "error": "string"
}

JSON

内部サーバーエラーの場合：

{
  "error": "string"
}

JSON

Swagger YAML 仕様のダウンロード

Swagger YAML 仕様をダウンロードするには、Cisco Secure Application Public API を参照してください。

アクセストークンの生成

アプリケーションリストの取得

パラメータ

レスポンス

アプリケーションの詳細の取得

パラメータ

レスポンス

攻撃リストの取得

パラメータ

レスポンス

攻撃の詳細の取得

パラメータ

レスポンス

⁪ビジネス トランザクション リストの取得

パラメータ

レスポンス

ビジネストランザクションの詳細の取得

パラメータ

レスポンス

ライブラリリストの取得

パラメータ

レスポンス

ライブラリの詳細の取得

パラメータ

レスポンス

ビジネスリスクのスコアの取得

パラメータ

レスポンス

脆弱性リストの取得

パラメータ

レスポンス

脆弱性の詳細の取得

パラメータ

レスポンス

Swagger YAML 仕様のダウンロード

⁪ビジネストランザクションリストの取得