Self-Hosted Runners

Run a task

Initiates a new task execution (self-hosted)

post/self-hosted/{accountId}/tasks/run

Request

Base URL
https://api.firefly.ai/v2
Auth
HTTP bearer
TypeScript
https://skmtc.dev/firefly/apis/api-gateway/docs/self-hosted/:accountId/tasks/run/post.ts
A function with typed inputs. Its response is checked against the schema.

accountIdstring required

Unique identifier of the account

accountIdstring

Account ID

type'post-plan' | 'post-apply' required

The type of task in the workflow

flowSubTaskType[] required

Flow of sub-tasks to execute

contentobject required

Map of sub-task types to content (base64-encoded byte arrays)

metadataTaskMetadata

Metadata for the task

runnerTypestring

Type of runner

repostring

Repository name

workspacestring

Workspace name

availableLogsstring[]

List of available log identifiers

tfWorkingDirstring

Terraform working directory

environmentstring

Environment name

{
  "type": "post-plan"
}

Task initiated successfully

string required

Task ID

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