SUsuperit
workflows

Update Action

patch/api/workflows/{team_key}/actions/{action_key}

Request

  • Base URL
    https://api.superit.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

action_keystring required
team_keystring required

Request body

namestring nullable
descriptionstring nullable
runtime'powershell' | 'python' | 'playwright'
draftstring nullable
authorisationPolicyKeystring nullable
credentialKeysstring[] nullable
allowedHostsstring[] nullable
executionTarget'cloud_sandbox' | 'mesh_device'

Where an action runs by default.

meshDeviceSelectorstring nullable
pollTimeoutSecondsinteger nullable
pollIntervalSecondsinteger nullable
scriptTimeoutSecondsinteger nullable
autoRunboolean nullable

Example request

{
  "authorisation": {
    "rules": [
      {
        "approver": {
          "tag": "group",
          "tags": [
            "superit:admins"
          ]
        },
        "requester": {
          "tag": "group",
          "tags": [
            "superit:staff"
          ]
        }
      }
    ]
  }
}

Response

Successful Response

keystring required
namestring required
descriptionstring required
status'draft' | 'published' required
runtime'powershell' | 'python' | 'playwright' required
draftstring required
publishedstring nullable required
authorisationPolicyKeystring nullable
authorisationPolicyNamestring nullable
publishedByKeystring nullable required
publishedAtstring date-time nullable required
createdAtstring date-time required
updatedAtstring date-time required
allowedHostsstring[] nullable required
executionTargetstring
meshDeviceSelectorstring nullable
pollTimeoutSecondsinteger nullable
pollIntervalSecondsinteger
scriptTimeoutSecondsinteger nullable
autoRunboolean
workflowSummaryStatus'idle' | 'regenerating' | 'failed'
originActionKeystring nullable
originTeamKeystring nullable
publishedTeamCountinteger

Example response

{
  "authorisation": {
    "rules": [
      {
        "approver": {
          "tag": "group",
          "tags": [
            "superit:admins"
          ]
        },
        "requester": {
          "tag": "group",
          "tags": [
            "superit:staff"
          ]
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.