API referansı İngilizce yayımlanır.

Manually run a routine

POST/api/routines/{id}/run
Personal API keyAgent API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

Manually run a routine.

Idempotency. Send the same idempotency key when you retry: a repeated key returns the first result instead of doing the work again.

Yetkilendirme

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Anahtarlar nasıl çalışır.

Yol parametreleri

idstringZorunluThe routine's id.

İstek gövdesi

application/json · zorunlu

triggerIdstring (uuid) | nullİsteğe bağlı
payloadobject | nullİsteğe bağlı
variablesobject<string, string | number | boolean> | nullİsteğe bağlı
projectIdstring (uuid) | nullİsteğe bağlı
projectWorkspaceIdstring (uuid) | nullİsteğe bağlı
assigneeAgentIdstring (uuid) | nullİsteğe bağlı
idempotencyKeystring | nullİsteğe bağlıat most 255 characters
sourcestringİsteğe bağlıone of: "manual", "api"
executionWorkspaceIdstring (uuid) | nullİsteğe bağlı
executionWorkspacePreferencestring | nullİsteğe bağlıone of: "inherit", "shared_workspace", "isolated_workspace", "operator_branch", "reuse_existing", "agent_default"
executionWorkspaceSettingsobject | nullİsteğe bağlı
executionWorkspaceSettings.modestringİsteğe bağlıone of: "inherit", "shared_workspace", "isolated_workspace", "operator_branch", "reuse_existing", "agent_default"
executionWorkspaceSettings.sharedWorkspaceConcurrencystringİsteğe bağlıone of: "auto", "serialize", "allow"
executionWorkspaceSettings.environmentIdstring (uuid) | nullİsteğe bağlı
executionWorkspaceSettings.workspaceStrategyobject | nullİsteğe bağlı
executionWorkspaceSettings.workspaceStrategy.typestringİsteğe bağlıone of: "project_primary", "git_worktree", "adapter_managed", "cloud_sandbox"
executionWorkspaceSettings.workspaceStrategy.baseRefstring | nullİsteğe bağlı
executionWorkspaceSettings.workspaceStrategy.branchTemplatestring | nullİsteğe bağlı
executionWorkspaceSettings.workspaceStrategy.existingBranchstring | nullİsteğe bağlı
executionWorkspaceSettings.workspaceStrategy.worktreeParentDirstring | nullİsteğe bağlı
executionWorkspaceSettings.workspaceStrategy.provisionCommandstring | nullİsteğe bağlı
executionWorkspaceSettings.workspaceStrategy.runtimeProvisionCommandstring | nullİsteğe bağlı
executionWorkspaceSettings.workspaceStrategy.teardownCommandstring | nullİsteğe bağlı
executionWorkspaceSettings.workspaceRuntimeobject | nullİsteğe bağlı
executionWorkspaceSettings.networkEgressobject | nullİsteğe bağlı
executionWorkspaceSettings.networkEgress.allowFqdnsarray<string>İsteğe bağlıeach at most 253 characters
executionWorkspaceSettings.networkEgress.allowCidrsarray<string>İsteğe bağlıeach at most 64 characters

Yanıtlar

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).

Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.

Routines