Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Microsoft Copilot Studio provides administrators with robust tools to manage bot security and compliance, including quarantine actions for agents through the Power Platform API.
Quarantining agents is part of Copilot Studio’s broader security framework, and works in tandem with your overall security approach in Copilot Studio.
For example, bots that violate Data Loss Prevention (DLP) policies or lack compliance documentation can be flagged as part of audits, runtime protection, or other admin reports or notifications. Admins can then use the quarantine APIs to isolate the noncompliant agents while investigating and remediating security and compliance issues.
Agents that have been quarantined will still be visible to agent users (and agent makers in Copilot Studio), but they can't interact with or use the agent.
Prerequisites
- You have admin-level roles such as Tenant Admin, Power Platform Administrator, or Dynamics 365 Service Administrator.
- You have the Bot ID and Environment ID for the target agent.
- You have authentication tokens for the service or user using the API.
- You’re authenticated via Microsoft Entra ID OAuth2, using the implicit flow in the authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize?resource=https://api.powerplatform.com.
API operations for bot quarantine management
Copilot Studio supports three key REST API operations for managing bot quarantine status, as part of the Power Platform API.
For more information on how and when to use the Power Platform API, see:
- Power Platform API and SDKs: From UX-first to API-first (Blog) (Power Platform Developer Blog)
- Programmability and extensibility overview (Power Platform documentation)
- Get started with Power Platform API (preview) (Power Platform documentation)
This article describes the operations available, which are also defined in the Power Platform API reference documentation.
Get bot quarantine status
- Endpoint:
GET /powervirtualagents/environments/{EnvironmentId}/bots/{BotId}/api/botQuarantine/GetBotQuarantineStatus. - Purpose: Retrieve the current quarantine status of a bot.
- Response: Returns a boolean
isBotQuarantinedandlastUpdateTimeUtc.
See the API reference documentation for quarantine status for parameter requirements and response codes.
Set bot as quarantined
- Endpoint:
POST /powervirtualagents/environments/{EnvironmentId}/bots/{BotId}/api/botQuarantine/SetAsQuarantined. - Purpose: Mark a bot as quarantined, restricting its availability and interactions.
- Response: Confirms quarantine status update.
See the API reference documentation for quarantining agents for parameter requirements and response codes.
Set bot as unquarantined
- Endpoint:
POST /powervirtualagents/environments/{EnvironmentId}/bots/{BotId}/api/botQuarantine/SetAsUnquarantined. - Purpose: Remove a bot from quarantine after risk assessment and remediation.
- Response: Confirms quarantine status update.
See the API reference documentation for unquarantining agents for parameter requirements and response codes.