Update Deployment Settings

Turn public execution on or off. A public deployment can be executed without an API key. Turning it on returns 403 when public API access is turned off for the SteelEngine instance or for the owner's permission group. Successful updates record a `workflow.public_api_updated` audit event with the actor and previous/new `isPublicApi` values; API-key requests also record the key ID and type. Requires admin access to the workflow's workspace, the same permission the Deploy button needs. The key acts as its owner, so the owner's current workspace role must allow it. A scoped or organization key also needs an admin grant on the workspace or workflow; a key without one is rejected with 401.

PATCH/api/workflows/{id}/deploy

Authorization

apiKey
X-API-Key<token>

Your SteelEngine API key (personal, workspace, or organization). Create personal and workspace keys under Settings > API Keys. Create organization keys under Organization Settings > API Keys.

In: header

Path Parameters

id*string

The unique identifier of the workflow.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/workflows/string/deploy" \  -H "Content-Type: application/json" \  -d '{    "isPublicApi": true  }'
{  "isPublicApi": false}