さくらのクラウド さくらのクラウド API ポータル クラウドマニュアルへ
API docs by Redocly

Security Control API (1.0.0)

Download OpenAPI specification:Download OpenAPI Spec (YAML)Download OpenAPI Spec (JSON)

さくらのクラウド セキュリティコントロール機能のAPI。

クラウド環境におけるセキュリティ上の問題を早期に発見して対応を支援する。

https://manual.sakura.ad.jp/cloud/controlpanel/eventlog/security-control.html

有効化

現在のプロジェクトの有効化

現在のプロジェクトでセキュリティコントロールを有効化します。 成功時は201を返し、リクエストが不正な場合は400を返します。

Authorizations:
BasicAuth
Request Body schema: application/json
required
servicePrincipalId
required
string

プロジェクトに紐づくサービスプリンシパルID（評価対象リソースへのアクセス権限付与）。

Responses

Request samples

Content type
application/json
{
  • "servicePrincipalId": "string"
}

Response samples

Content type
application/json
{
  • "servicePrincipalId": "string",
  • "isActive": true,
  • "automatedActionLimit": 0
}

現在のプロジェクトの有効化状態の取得

現在のプロジェクトの有効化状態を取得します。 成功時は200で有効化詳細を返し、プロジェクトがまだ一度も有効化されていない場合は404を返します。

Authorizations:
BasicAuth

Responses

Response samples

Content type
application/json
{
  • "servicePrincipalId": "string",
  • "isActive": true,
  • "automatedActionLimit": 0
}

現在のプロジェクトの有効化状態の更新

現在のプロジェクトの有効化状態を更新します。 成功時は200で更新後の有効化詳細を返し、リクエストが不正な場合は400を返します。

Authorizations:
BasicAuth
Request Body schema: application/json
required
servicePrincipalId
required
string

プロジェクトに紐づくサービスプリンシパルID（評価対象リソースへのアクセス権限付与）。

isActive
required
boolean

現在のプロジェクトで「セキュリティコントロール」が有効かどうか。

Responses

Request samples

Content type
application/json
{
  • "servicePrincipalId": "string",
  • "isActive": true
}

Response samples

Content type
application/json
{
  • "servicePrincipalId": "string",
  • "isActive": true,
  • "automatedActionLimit": 0
}

評価ルール

評価ルール一覧の取得

プロジェクトの評価ルール一覧を取得します。

pageSizeの最大値は100。100を超える値は100として扱う。 pageSize未指定時は50。

Authorizations:
BasicAuth
query Parameters
page_size
integer

返却する要素の最大数。

サービス側でこの値より少なく返す場合がある。

next
string

このページトークンより後の要素を取得する。

このフィールドと prev は同時に指定できない。

ページネーション時、他のリクエストパラメータは元のリクエストと一致している必要がある。 無効な場合は400 Bad Requestとなる。

prev
string

このページトークンより前の要素を取得する。

このフィールドと next は同時に指定できない。

ページネーション時、他のリクエストパラメータは元のリクエストと一致している必要がある。 無効な場合は400 Bad Requestとなる。

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "nextPageToken": "string",
  • "prevPageToken": "string",
  • "totalSize": 0
}

評価ルール詳細の取得

指定されたIDの評価ルール詳細を取得します。

Authorizations:
BasicAuth
path Parameters
evaluationRuleId
required
string (EvaluationRuleID)
Enum: "server-no-public-ip" "disk-encryption-enabled" "dba-encryption-enabled" "dba-no-public-ip" "objectstorage-bucket-acl-changed" "objectstorage-bucket-encryption-enabled" "addon-datalake-no-public-access" "addon-dwh-no-public-access" "addon-threat-detection-enabled" "elb-logging-enabled" "iam-member-operation-detected" "nosql-encryption-enabled" "addon-threat-detections" "addon-vulnerability-detections"

Responses

Response samples

Content type
application/json
{
  • "rule": {
    },
  • "description": "string",
  • "iamRolesRequired": [
    ],
  • "isEnabled": true
}

評価ルールの更新

指定されたIDの評価ルールを更新します。

Authorizations:
BasicAuth
path Parameters
evaluationRuleId
required
string (EvaluationRuleID)
Enum: "server-no-public-ip" "disk-encryption-enabled" "dba-encryption-enabled" "dba-no-public-ip" "objectstorage-bucket-acl-changed" "objectstorage-bucket-encryption-enabled" "addon-datalake-no-public-access" "addon-dwh-no-public-access" "addon-threat-detection-enabled" "elb-logging-enabled" "iam-member-operation-detected" "nosql-encryption-enabled" "addon-threat-detections" "addon-vulnerability-detections"
Request Body schema: application/json
required
required
object or object or object or object or object or object or object or object or object or object or object or object or object or object (EvaluationRuleUnion)
isEnabled
required
boolean

ルールが有効かどうか。

Responses

Request samples

Content type
application/json
{
  • "rule": {
    },
  • "isEnabled": true
}

Response samples

Content type
application/json
{
  • "rule": {
    },
  • "description": "string",
  • "iamRolesRequired": [
    ],
  • "isEnabled": true
}

自動アクション

自動アクションの作成

新しい自動アクションを作成します。

Authorizations:
BasicAuth
Request Body schema: application/json
required
name
required
string

自動アクションの名称。

description
string

自動アクションの説明。

required
object

アクションの定義（アクションタイプごとに異なる）。

executionCondition
required
string

どのような条件で自動アクションを実行するかの条件式。 この条件式を満たした場合にのみ、自動アクションが実行される。 CEL（Common Expression Language）形式で記述する。

isEnabled
required
boolean

自動アクションが有効かどうか。

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "action": {
    },
  • "executionCondition": "string",
  • "isEnabled": true
}

Response samples

Content type
application/json
{
  • "automatedActionId": "string",
  • "name": "string",
  • "description": "string",
  • "action": {
    },
  • "executionCondition": "string",
  • "isEnabled": true,
  • "createdAt": "2019-08-24T14:15:22Z"
}

自動アクション一覧の取得

自動アクション一覧を取得します。

pageSizeの最大値は100。100を超える値は100として扱う。 pageSize未指定時は50。

Authorizations:
BasicAuth
query Parameters
page_size
integer

返却する要素の最大数。

サービス側でこの値より少なく返す場合がある。

next
string

このページトークンより後の要素を取得する。

このフィールドと prev は同時に指定できない。

ページネーション時、他のリクエストパラメータは元のリクエストと一致している必要がある。 無効な場合は400 Bad Requestとなる。

prev
string

このページトークンより前の要素を取得する。

このフィールドと next は同時に指定できない。

ページネーション時、他のリクエストパラメータは元のリクエストと一致している必要がある。 無効な場合は400 Bad Requestとなる。

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "nextPageToken": "string",
  • "prevPageToken": "string",
  • "totalSize": 0
}

自動アクション詳細の取得

指定されたIDの自動アクション詳細を取得します。

Authorizations:
BasicAuth
path Parameters
actionId
required
string (AutomatedActionID)

自動アクションの一意な識別子。

Responses

Response samples

Content type
application/json
{
  • "automatedActionId": "string",
  • "name": "string",
  • "description": "string",
  • "action": {
    },
  • "executionCondition": "string",
  • "isEnabled": true,
  • "createdAt": "2019-08-24T14:15:22Z"
}

自動アクションの更新

指定されたIDの自動アクションを更新します。

Authorizations:
BasicAuth
path Parameters
actionId
required
string (AutomatedActionID)

自動アクションの一意な識別子。

Request Body schema: application/json
required
name
required
string

自動アクションの名称。

description
string

自動アクションの説明。

required
object

アクションの定義（アクションタイプごとに異なる）。

executionCondition
required
string

どのような条件で自動アクションを実行するかの条件式。 この条件式を満たした場合にのみ、自動アクションが実行される。 CEL（Common Expression Language）形式で記述する。

isEnabled
required
boolean

自動アクションが有効かどうか。

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "action": {
    },
  • "executionCondition": "string",
  • "isEnabled": true
}

Response samples

Content type
application/json
{
  • "automatedActionId": "string",
  • "name": "string",
  • "description": "string",
  • "action": {
    },
  • "executionCondition": "string",
  • "isEnabled": true,
  • "createdAt": "2019-08-24T14:15:22Z"
}

自動アクションの削除

指定されたIDの自動アクションを削除します。

Authorizations:
BasicAuth
path Parameters
actionId
required
string (AutomatedActionID)

自動アクションの一意な識別子。

Responses

Response samples

Content type
{
  • "type": "../dictionary",
  • "title": "string",
  • "status": 401,
  • "detail": "authentication_failed",
  • "instance": "../dictionary"
}