Self-Hosted Runners

Get runner deployment instructions

Retrieves deployment instructions for setting up runners in a pool

post/runners/runner-pools/{poolId}/deployment-instructions

Request

Base URL
https://api.firefly.ai/v2
Auth
HTTP bearer
TypeScript
https://skmtc.dev/firefly/apis/api-gateway/docs/runners/runner-pools/:poolId/deployment-instructions/post.ts
A function with typed inputs. Its response is checked against the schema.

poolIdstring required

Unique identifier of the runner pool

initialCountinteger required

deploymentType'kubernetes' | 'docker' | 'binary' required

Type of deployment for runners

Runner deployment instructions retrieved successfully

string required

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