Connection API
Operations the SDK connection client exposes, generated from the SDK.
Connection client operations
createConnectionClient({request}) exposes exactly these operations. The authenticated host supplies request; Block code receives neither credentials nor an arbitrary network proxy. Paths are relative to the connections API.
| Operation | Method | Path | Query |
|---|---|---|---|
search | GET | /catalog | q, refresh |
capabilities | GET | /capabilities | appId |
block | GET | /block | appId, capabilityId, projectId, configurationRunId, metadataOnly |
accounts | GET | /accounts | appId, refresh |
connect | POST | /sessions | — |
finishConnection | POST | /sessions/:id/finish | — |
revokeAccount | POST | /accounts/:id/revoke | — |
accountImpact | GET | /accounts/:id/impact | — |
inspect | POST | /execution-context | — |
quote | POST | /reviews | — |
approve | POST | /reviews/:id/approve | — |
execute | POST | /runs | — |
run | GET | /runs/:id | — |
recover | GET | /requests/:id | — |
cancel | POST | /runs/:id/cancel | — |
referenceBudget | POST | /reference-budgets | — |
closeReferenceBudget | POST | /reference-budgets/:id/close | — |
previewReference | POST | /references/preview | — |
attachReference | POST | /references | — |
readReference | GET | /references/:id | projectId, version |
refreshReferenceContext | POST | /references/:id/refresh-context | — |
refreshReference | POST | /references/:id/refresh | — |
detachReference | POST | /references/:id/detach | — |
referenceDependencies | GET | /references/dependencies | projectId |
sharedWork | POST | /shared-work | — |
sharedWorkLinks | GET | /shared-work-links | projectId |
inspectGenerated | POST | /generated/inspect | — |
testGenerated | POST | /generated/test | — |
installGenerated | POST | /generated/install | — |
readGenerated | GET | /generated/:id | — |
installLocal | POST | /generated/local/install | — |
previewLocalReference | POST | /references/local/preview | — |
attachLocalReference | POST | /references/local | — |
localReferenceSource | POST | /references/local/source | — |
refreshLocalReference | POST | /references/:id/local-refresh | — |
recentRuns | GET | /runs | projectId, limit |
placementTasks | POST | /placements/tasks | — |
previewPlacementTask | POST | /placements/preview-task | — |
applyPlacementTask | POST | /placements/apply-task | — |
listTriggers | GET | /workflow-triggers/:projectId | — |
previewTriggerPlan | POST | /workflow-triggers/:projectId/plan | — |
reviewTrigger | POST | /workflow-triggers/:projectId/review | — |
createTrigger | POST | /workflow-triggers/:projectId | — |
changeTrigger | POST | /workflow-triggers/:projectId/triggers/:id/state | — |
fireManualTrigger | POST | /workflow-triggers/:projectId/triggers/:id/fire | — |
listUnattendedGrants | GET | /workflow-triggers/:projectId/grants | — |
createUnattendedGrant | POST | /workflow-triggers/:projectId/grants | — |
revokeUnattendedGrant | POST | /workflow-triggers/:projectId/grants/:id/revoke | — |
executeUnattendedGrant | POST | /workflow-triggers/:projectId/grants/execute | — |
listLiveReferenceGrants | GET | /workflow-triggers/:projectId/live-reference-grants | — |
grantLiveReference | POST | /workflow-triggers/:projectId/live-reference-grants | — |
revokeLiveReferenceGrant | POST | /workflow-triggers/:projectId/live-reference-grants/revoke | — |