プライベート・エンドポイント

パブリック・ネットワークで Secrets Manager リソースを管理する必要がある場合は、以下の表を参照して、Secrets Manager API に接続するときに使用する API エンドポイントを決定してください。

プライベート・エンドポイントを使用するために Secrets Manager インスタンスを構成する方法は、Secrets Manager への接続の保護を参照してください。

パブリック・エンドポイント

API を試す準備はできましたか。 ブラウザーから Swagger UI と対話するには、サービス・エンドポイント URL にapi/v2/swagger-uiを追加します。 例えば、https://{instance_ID}.{region}.secrets-manager.appdomain.cloud/api/v2/swagger-ui です。

エンドポイント URL の表示

サービス・エンドポイント URL は、Secrets Manager UI の**「エンドポイント」**ページで見つけることができます。 サービス・エンドポイント URL をプログラムでリトリーブする必要がある場合は、以下の API を呼び出して、ご使用の Secrets Manager インスタンス固有の値を取得することもできます。

curl -X GET  
    -H "Accept: application/json" \
    -H "Authorization: Bearer {IAM_token}"
"https://{region}.secrets-manager.cloud.ibm.com/api/v1/instances/{url_encoded_instance_CRN}/endpoints"

次の表に従って、例の要求内の変数を置き換えてください。

要求が成功すると、指定したリージョンとサービス・インスタンス CRN に関連付けられているエンドポイント URL が返されます。 次の JSON スニペットは、応答の例を示しています。

{
    "plan": "standard",
    "public_endpoints": {
        "service_api": "https://927fb8ae-1ddd-4483-a21f-7d3c0fc81234.us-south.secrets-manager.appdomain.cloud/api",
        "vault_api": "https://927fb8ae-1ddd-4483-a21f-7d3c0fc81234.us-south.secrets-manager.appdomain.cloud"
    },
    "private_endpoints": {
        "service_api": "https://927fb8ae-1ddd-4483-a21f-7d3c0fc1234.private.us-south.secrets-manager.appdomain.cloud/api",
        "vault_api": "https://927fb8ae-1ddd-4483-a21f-7d3c0fc81234.private.us-south.secrets-manager.appdomain.cloud"
    },
    "encryption": {
      "provider_managed_encryption": "key_protect",  
      "encryption_key_crn": "crn:v1:staging:public:kms:us-south:a/791f5fb10986423e97aa8512f181234:31639268-42e8-4420-9872-590a6ee21234:key:b4af8f76-e6ea-4dc5-89cc-5f1b9bb1234"
    }
}

このAPIを試すために、ブラウザーからSwagger UIhttps://{region}.secrets-manager.cloud.ibm.com/swagger-uiと対話できます。

**「プライベートのみ」**オプションをインスタンスに構成した場合は、private_endpoints オブジェクトのみがこの API から応答として返されます。