Calagopus icon

Calagopus

Interact with the Calagopus API

Actions343

Admin Servers → Cancel Transfer

AI-generated

Summary

Cancel an ongoing server transfer identified by its UUID in the admin servers resource.

Inputs

  • Server UUID (required) — The server UUID or identifier is required to specify which server's transfer should be cancelled.
  • Query Parameters JSON — Optional query parameters to send as a JSON object.
  • Body Mode — Choose how the request body is sent: JSON, Raw Text, or None. This operation typically does not require a request body, so default is 'json' but empty.
  • Body JSON — Optional JSON object to send in the body if Body Mode is set to JSON, typically empty for this operation.
  • Raw Body — Optional raw text to send in the body if Body Mode is set to Raw Text, typically empty for this operation.
  • Additional Options — Optional settings like ignoring HTTP status errors, returning the full HTTP response, or setting request timeout.

Output shape

a single JSON object indicating success or failure of the cancel transfer request

The returned data is the JSON-parsed response from the API. If the API response is undefined or null, it returns { success: true }. Errors may be caught and returned as part of the workflow item if 'Continue On Fail' is enabled.

Examples

Example 1: Cancel a server transfer process

Set Resource to 'Admin Servers', Operation to 'Cancel Transfer', provide the Server UUID of the server whose transfer is to be cancelled. Other body parameters can typically be left at defaults.

Links

Discussion