Aruba Central Next Gen icon

Aruba Central Next Gen

Consume Aruba Central Next Gen API

Actions408

Scope Management → Delete Site Collection

AI-generated

Overview

This node operation deletes a site collection within the Scope Management domain of the Aruba Central Next Gen API. It is useful for administrators who need to programmatically remove site collections from their network management scope, helping maintain an organized and updated network environment. For example, it can be used to delete obsolete or decommissioned site collections automatically as part of network cleanup or reconfiguration workflows.

Use Case Examples

  1. Deleting a site collection by specifying its scopeId to remove it from the network management system.
  2. Automating cleanup of site collections that are no longer needed in the configuration domain.

Properties

Name Meaning
Debug Mode Whether to enable detailed debug logs for troubleshooting.
Domain API domain to interact with, set to 'configuration' for this operation.
Scope ID The scopeId of the site collection to delete.

Output

JSON

  • success - Indicates whether the site collection was successfully deleted.
  • message - Additional information or status message about the deletion operation.

Dependencies

  • Requires an API key credential for Aruba Central Next Gen OAuth2 authentication.

Troubleshooting

  • Common issues include invalid or missing scopeId, which will cause the deletion to fail.
  • If the API domain is not set to 'configuration', the operation may not execute as expected.
  • Debug Mode can be enabled to get detailed logs for troubleshooting errors.

Discussion