Change status of instance

client.Workflows.Instances.Status.Edit(ctx, workflowName, instanceID, params) (*InstanceStatusEditResponse, error)

PATCH/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/status

Changes the execution status of a workflow instance (e.g., pause, resume, terminate).

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Workers Scripts Write

ParametersExpand Collapse

workflowName string

maxLength64

minLength1

instanceID string

Instance identifier. User-created instances match ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ (max 100 characters); cron-triggered instances can use a longer, system-generated id derived from the cron expression.

maxLength271

minLength1

params InstanceStatusEditParams

AccountID param.Field[string]

Path param

Status param.Field[InstanceStatusEditParamsVariant0Status]

Body param

const InstanceStatusEditParamsVariant0StatusPause InstanceStatusEditParamsVariant0Status = "pause"

ReturnsExpand Collapse

type InstanceStatusEditResponse struct{…}

Status InstanceStatusEditResponseStatus

One of the following:

const InstanceStatusEditResponseStatusQueued InstanceStatusEditResponseStatus = "queued"

const InstanceStatusEditResponseStatusRunning InstanceStatusEditResponseStatus = "running"

const InstanceStatusEditResponseStatusPaused InstanceStatusEditResponseStatus = "paused"

const InstanceStatusEditResponseStatusErrored InstanceStatusEditResponseStatus = "errored"

const InstanceStatusEditResponseStatusTerminated InstanceStatusEditResponseStatus = "terminated"

const InstanceStatusEditResponseStatusComplete InstanceStatusEditResponseStatus = "complete"

const InstanceStatusEditResponseStatusWaitingForPause InstanceStatusEditResponseStatus = "waitingForPause"

const InstanceStatusEditResponseStatusWaiting InstanceStatusEditResponseStatus = "waiting"

const InstanceStatusEditResponseStatusRollingBack InstanceStatusEditResponseStatus = "rollingBack"

Timestamp Time

Accepts ISO 8601 with no timezone offsets and in UTC.

formatdate-time

Change status of instance

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/option"
  "github.com/stainless-sdks/cloudflare-go/workflows"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  response, err := client.Workflows.Instances.Status.Edit(
    context.TODO(),
    "x",
    "x",
    workflows.InstanceStatusEditParams{
      AccountID: cloudflare.F("account_id"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Status)
}

{
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": {
    "status": "queued",
    "timestamp": "2019-12-27T18:11:19.117Z"
  },
  "success": true,
  "result_info": {
    "count": 0,
    "per_page": 0,
    "total_count": 0,
    "cursor": "cursor",
    "page": 0,
    "total_pages": 0
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": {
    "status": "queued",
    "timestamp": "2019-12-27T18:11:19.117Z"
  },
  "success": true,
  "result_info": {
    "count": 0,
    "per_page": 0,
    "total_count": 0,
    "cursor": "cursor",
    "page": 0,
    "total_pages": 0
  }
}