Catalytic for Developers

Welcome, developers

Catalytic speaks your language. Our developer tools allow you to code, customize and create more with our platform.

Get Started    

Stop an Instance

The Stop Method

Stops a running Instance of a Workflow.

👍

Permissions Required

Find and Edit permissions are required for an Instance in order to stop it. The Instance Owner has implicit Find and Edit permissions, and can always stop Instances they own.

Method Signature

Instance Stop(Guid id);
async Task<Instance> StopAsync(Guid id);
ParameterTypeDescription
idGuidThe id of the Instance to stop
returnsInstanceThe stopped Instance
Instance Stop(string id);
async Task<Instance> StopAsync(string id);
ParameterTypeDescription
idstringThe id of the Instance to stop
returnsInstanceThe stopped Instance

Example

/*
 * This example demonstrates stopping an Instance by ID
 */
using Catalytic.Sdk.Entities;

namespace Catalytic.Sdk.Examples
{
    class Program
    {
        static void Main(string[] args)
        {
            var catalytic = new Catalytic.Sdk.CatalyticClient(Credentials.Default);
            var instance = catalytic.Instances.Stop("c9f2beec-10c0-4f2f-b4e0-1d884c7e053c");
        }
    }
}

Updated 4 months ago

Stop an Instance


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.