Self-Hosted Runners
Add a workspace run (self-hosted)
post/self-hosted/{accountId}/workspaces/{workspaceId}/runs
Request
- Base URLhttps://api.firefly.ai/v2
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
accountIdstring required
Unique identifier of the account
workspaceIdstring required
Unique identifier of the workspace
Request body
Example request
{
"workspaceRun": {
"id": "507f1f77bcf86cd799439011",
"accountId": "507f1f77bcf86cd799439011",
"workspaceId": "507f1f77bcf86cd799439012",
"workspaceName": "production-infra",
"runId": "run-123456",
"runName": "Deploy to Production",
"status": "plan_success",
"pullRequestId": "123",
"pullRequestUrl": "https://github.com/org/repo/pull/123",
"branch": "main",
"commitId": "abc123def456",
"commitUrl": "https://github.com/org/repo/commit/abc123def456",
"runnerType": "github-actions",
"buildId": "build-789012",
"buildUrl": "https://github.com/org/repo/actions/runs/789012",
"buildName": "CI Build",
"vcsType": "github",
"repo": "org/repo",
"repoUrl": "https://github.com/org/repo",
"ownerSummary": {
"email": "john.doe@example.com",
"name": "John Doe",
"initials": "JD",
"customColor": "#00000F"
},
"title": "Update infrastructure for new feature",
"terraformVersion": "1.0.11",
"iacType": "terraform",
"backendSummary": {
"backendType": "s3"
},
"planTaskId": "507f1f77bcf86cd799439013",
"applyTaskId": "507f1f77bcf86cd799439014",
"plan": [
{
"id": "507f1f77bcf86cd799439011",
"accountId": "507f1f77bcf86cd799439011",
"status": "completed",
"resultStatus": "success",
"type": "post-plan",
"guardrailsSummary": {
"total": 10,
"passed": 8,
"failed": 2,
"violations": [
{
"id": "v1",
"severity": "high",
"message": "Resource does not have required tags"
}
]
},
"backendSummary": {
"type": "s3",
"config": {
"bucket": "terraform-state",
"key": "prod/terraform.tfstate"
},
"resources": 42
},
"changedFilesCodeSummary": {
"total": 5,
"added": 2,
"modified": 3,
"files": [
{
"path": "main.tf",
"type": "modified"
}
]
},
"vcsType": "github",
"runnerType": "github-actions"
}
],
"apply": [
{
"id": "507f1f77bcf86cd799439011",
"accountId": "507f1f77bcf86cd799439011",
"status": "completed",
"resultStatus": "success",
"type": "post-plan",
"guardrailsSummary": {
"total": 10,
"passed": 8,
"failed": 2,
"violations": [
{
"id": "v1",
"severity": "high",
"message": "Resource does not have required tags"
}
]
},
"backendSummary": {
"type": "s3",
"config": {
"bucket": "terraform-state",
"key": "prod/terraform.tfstate"
},
"resources": 42
},
"changedFilesCodeSummary": {
"total": 5,
"added": 2,
"modified": 3,
"files": [
{
"path": "main.tf",
"type": "modified"
}
]
},
"vcsType": "github",
"runnerType": "github-actions"
}
]
}
}Response
Workspace run added successfully
Changes
No recorded changes to this operation across all 1 revision of this API.