API referansı İngilizce yayımlanır.

List runs for an organization

GET/api/companies/{companyId}/heartbeat-runs
Personal API keyAgent API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

List runs for an organization.

Pagination. Use limit to page through results. See pagination.

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

companyIdstringZorunluThe organization's id.

Sorgu parametreleri

agentIdstringİsteğe bağlı
limitintegerİsteğe bağlı≥ 1≤ 1000
summarystringİsteğe bağlıone of: "0", "1", "true", "false"
latestFailuresOnlystringİsteğe bağlıone of: "true", "false"

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.

Runs