Update Tenant Site Status

Update the status of a tenant site for a specified region and tenant with three options: Suspend, Disable, and Enable.
Suspend stops all scheduled jobs and suspends the site from ingesting new events or incidents.
Disable sets the site to an inactive state, halting, inactivating, and hiding all scheduled jobs, dashboards, automation rules, and connections.
Enable reactivates a site from a suspended or inactive state. Note that schedules and configurations that were stopped or made inactive will not be automatically recovered.

Implementation	System
Command Category	System Utility
Tags	MULTITENANCY

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Tenant Region	Optional	The region of the tenant	`AMER`
Tenant Name	Optional	Tenant name for the site	`Tenant name for the site`
Tenant Site	Optional	The name of the tenant site	`Tenant Site1`
Offboarding Actions	Required	Offboarding actions of client site: Suspend, Disable and Enable	`suspend`

Output

Return Data

The returned result of this command. If some required parameters are not defined, this returned data could be empty. The returned result can be passed down directly to a subsequent command in playbooks.

SAMPLE DATA

JSON

{
    "Status": "Successful"
}

Remote Command API

The D3 command API allows you to send requests to D3 SOAR to execute this utility command via REST API.

Request

POST

CODE

https:/{base_url}/{api_namespace}/api/Command/UpdateTenantSiteStatus

Headers

Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.

Request Body

JSON

{
  "Username": "<Username here>",
  "Site": "<Site here>",
  "CommandParams": {
    "Tenant Region": "<Tenant Region here>",
    "Tenant Name": "<Tenant Name here>",
    "Tenant Site": "<Tenant Site here>",
    "Offboarding Actions": "<Offboarding Actions here>",
  }
}

Body Parameters

Parameter Name	Type	Required/Optional	Description
Username	`String`	Required	The username of your D3 SOAR account.
Site	`String`	Required	The D3 SOAR site to run the remote command.
Tenant Region	`text`	Optional	The region of the tenant
Tenant Name	`text`	Optional	Tenant name for the site
Tenant Site	`text`	Optional	The name of the tenant site
Offboarding Actions	`text`	Required	Offboarding actions of client site: Suspend, Disable and Enable

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Tenant Region": "AMER",
    "Tenant Name": "AMER Tenant",
    "Tenant Site": "Tenant Site1",
    "Offboarding Actions": "suspend"
  }
}

Response

Response Fields

Field Name	Type	Description
error	`Text`	The error message if the API request has failed.
returnData	`Text`	The return data from the API request.

Sample Response

JSON

{
    "error": "",
    "returnData": {
        "Status": "Successful"
    }
}