API referansı İngilizce yayımlanır.

Trigger a plugin job

POST/api/plugins/{pluginId}/jobs/{jobId}/trigger
Personal API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

Trigger a plugin job.

Yetkilendirme

Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. Anahtarlar nasıl çalışır.

Yol parametreleri

pluginIdstringZorunluThe plugin's id.
jobIdstringZorunluThe job's id.

Yanıtlar

200SuccessThe request worked; the body holds the result.
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.

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

Plugins