ReferenceAPI reference
Setup
4 operations in the Setup group.
GET /api/resources/{workspace}/installs
Operation ID: listInstalls
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Runner installs. | InstallCollectionResponse |
POST /api/resources/{workspace}/installs
Operation ID: createInstall
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 201 | Created install. | InstallResponse |
POST /api/resources/{workspace}/pairing-codes
Operation ID: createPairingCode
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 201 | Created pairing code. | PairingCodeCreateResponse |
GET /api/resources/{workspace}/workflow-setup-readiness
Operation ID: getWorkflowSetupReadiness
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Machine-readable setup readiness and repair plan for automation creation. | WorkflowSetupReadinessResponse |