archastro.platform.v1.resources.agent_health_actions 

  1# Copyright (c) 2026 ArchAstro Inc. All Rights Reserved.
  2# This file is auto-generated by @archastro/sdk-generator. Do not edit.
  3# Content hash: 7702c5b228ec
  4
  5from __future__ import annotations
  6
  7from ...runtime.http_client import HttpClient, SyncHttpClient
  8from ...types.common import AgentHealthAction
  9
 10
 11class AsyncAgentHealthActionResource:
 12    def __init__(self, http: HttpClient):
 13        self._http = http
 14
 15    async def get(self, health_action: str) -> AgentHealthAction:
 16        """
 17        Retrieve a health action
 18        Returns a single agent health action by its ID. Use this endpoint to
 19        fetch the current state of a specific health action for example, to
 20        refresh a checklist item after the user completes a setup step or after
 21        polling for status changes.
 22        The caller must be authenticated and scoped to the app that owns the
 23        health action. Returns 404 if the health action does not exist or is not
 24        accessible within the current app scope.
 25
 26        Args:
 27            health_action: Health action ID (`aha_...`) to retrieve.
 28
 29        Returns:
 30            The requested health action object.
 31        """
 32        return await self._http.request(
 33            f"/api/v1/agent_health_actions/{health_action}",
 34            response_type=AgentHealthAction,
 35        )
 36
 37    async def verify(self, health_action: str) -> AgentHealthAction:
 38        """
 39        Verify a health action
 40        Synchronously re-runs the verifier for the specified health action and
 41        returns the updated health action object. Use this endpoint to power
 42        operator-facing "Verify" buttons that let users confirm a setup step is
 43        complete (for example, after setting an environment variable or
 44        completing an OAuth install).
 45        The verifier transitions the action's `status` field according to the
 46        following rules: a `pending` action that passes becomes `completed`; one
 47        that fails stays `pending`. A `completed` action that passes stays
 48        `completed`; one that fails becomes `degraded`. A `degraded` action that
 49        passes returns to `completed`; one that fails stays `degraded`. Actions
 50        in `skipped` status are never transitioned the call returns the
 51        unchanged record.
 52        This endpoint runs the verifier synchronously and blocks until the check
 53        finishes. For background or probe-driven verification sweeps, use the
 54        platform's internal debounced trigger instead of calling this endpoint
 55        in a tight loop. Returns 422 if the verifier itself encounters an
 56        unrecoverable error.
 57
 58        Args:
 59            health_action: Health action ID (`aha_...`) to verify.
 60
 61        Returns:
 62            The health action object with its `status` and `last_verified_at` updated to reflect the result of the verification run.
 63        """
 64        return await self._http.request(
 65            f"/api/v1/agent_health_actions/{health_action}/verify",
 66            method="POST",
 67            response_type=AgentHealthAction,
 68        )
 69
 70
 71class AgentHealthActionResource:
 72    def __init__(self, http: SyncHttpClient):
 73        self._http = http
 74
 75    def get(self, health_action: str) -> AgentHealthAction:
 76        """
 77        Retrieve a health action
 78        Returns a single agent health action by its ID. Use this endpoint to
 79        fetch the current state of a specific health action for example, to
 80        refresh a checklist item after the user completes a setup step or after
 81        polling for status changes.
 82        The caller must be authenticated and scoped to the app that owns the
 83        health action. Returns 404 if the health action does not exist or is not
 84        accessible within the current app scope.
 85
 86        Args:
 87            health_action: Health action ID (`aha_...`) to retrieve.
 88
 89        Returns:
 90            The requested health action object.
 91        """
 92        return self._http.request(
 93            f"/api/v1/agent_health_actions/{health_action}",
 94            response_type=AgentHealthAction,
 95        )
 96
 97    def verify(self, health_action: str) -> AgentHealthAction:
 98        """
 99        Verify a health action
100        Synchronously re-runs the verifier for the specified health action and
101        returns the updated health action object. Use this endpoint to power
102        operator-facing "Verify" buttons that let users confirm a setup step is
103        complete (for example, after setting an environment variable or
104        completing an OAuth install).
105        The verifier transitions the action's `status` field according to the
106        following rules: a `pending` action that passes becomes `completed`; one
107        that fails stays `pending`. A `completed` action that passes stays
108        `completed`; one that fails becomes `degraded`. A `degraded` action that
109        passes returns to `completed`; one that fails stays `degraded`. Actions
110        in `skipped` status are never transitioned the call returns the
111        unchanged record.
112        This endpoint runs the verifier synchronously and blocks until the check
113        finishes. For background or probe-driven verification sweeps, use the
114        platform's internal debounced trigger instead of calling this endpoint
115        in a tight loop. Returns 422 if the verifier itself encounters an
116        unrecoverable error.
117
118        Args:
119            health_action: Health action ID (`aha_...`) to verify.
120
121        Returns:
122            The health action object with its `status` and `last_verified_at` updated to reflect the result of the verification run.
123        """
124        return self._http.request(
125            f"/api/v1/agent_health_actions/{health_action}/verify",
126            method="POST",
127            response_type=AgentHealthAction,
128        )
class AsyncAgentHealthActionResource: 
12class AsyncAgentHealthActionResource:
13    def __init__(self, http: HttpClient):
14        self._http = http
15
16    async def get(self, health_action: str) -> AgentHealthAction:
17        """
18        Retrieve a health action
19        Returns a single agent health action by its ID. Use this endpoint to
20        fetch the current state of a specific health action for example, to
21        refresh a checklist item after the user completes a setup step or after
22        polling for status changes.
23        The caller must be authenticated and scoped to the app that owns the
24        health action. Returns 404 if the health action does not exist or is not
25        accessible within the current app scope.
26
27        Args:
28            health_action: Health action ID (`aha_...`) to retrieve.
29
30        Returns:
31            The requested health action object.
32        """
33        return await self._http.request(
34            f"/api/v1/agent_health_actions/{health_action}",
35            response_type=AgentHealthAction,
36        )
37
38    async def verify(self, health_action: str) -> AgentHealthAction:
39        """
40        Verify a health action
41        Synchronously re-runs the verifier for the specified health action and
42        returns the updated health action object. Use this endpoint to power
43        operator-facing "Verify" buttons that let users confirm a setup step is
44        complete (for example, after setting an environment variable or
45        completing an OAuth install).
46        The verifier transitions the action's `status` field according to the
47        following rules: a `pending` action that passes becomes `completed`; one
48        that fails stays `pending`. A `completed` action that passes stays
49        `completed`; one that fails becomes `degraded`. A `degraded` action that
50        passes returns to `completed`; one that fails stays `degraded`. Actions
51        in `skipped` status are never transitioned the call returns the
52        unchanged record.
53        This endpoint runs the verifier synchronously and blocks until the check
54        finishes. For background or probe-driven verification sweeps, use the
55        platform's internal debounced trigger instead of calling this endpoint
56        in a tight loop. Returns 422 if the verifier itself encounters an
57        unrecoverable error.
58
59        Args:
60            health_action: Health action ID (`aha_...`) to verify.
61
62        Returns:
63            The health action object with its `status` and `last_verified_at` updated to reflect the result of the verification run.
64        """
65        return await self._http.request(
66            f"/api/v1/agent_health_actions/{health_action}/verify",
67            method="POST",
68            response_type=AgentHealthAction,
69        )
AsyncAgentHealthActionResource(http: archastro.platform.runtime.http_client.HttpClient) 
13    def __init__(self, http: HttpClient):
14        self._http = http
async def get( self, health_action: str) -> archastro.platform.types.common.AgentHealthAction: 
16    async def get(self, health_action: str) -> AgentHealthAction:
17        """
18        Retrieve a health action
19        Returns a single agent health action by its ID. Use this endpoint to
20        fetch the current state of a specific health action for example, to
21        refresh a checklist item after the user completes a setup step or after
22        polling for status changes.
23        The caller must be authenticated and scoped to the app that owns the
24        health action. Returns 404 if the health action does not exist or is not
25        accessible within the current app scope.
26
27        Args:
28            health_action: Health action ID (`aha_...`) to retrieve.
29
30        Returns:
31            The requested health action object.
32        """
33        return await self._http.request(
34            f"/api/v1/agent_health_actions/{health_action}",
35            response_type=AgentHealthAction,
36        )

Retrieve a health action Returns a single agent health action by its ID. Use this endpoint to fetch the current state of a specific health action for example, to refresh a checklist item after the user completes a setup step or after polling for status changes. The caller must be authenticated and scoped to the app that owns the health action. Returns 404 if the health action does not exist or is not accessible within the current app scope.

Arguments:
  • health_action: Health action ID (aha_...) to retrieve.
Returns:

The requested health action object.

async def verify( self, health_action: str) -> archastro.platform.types.common.AgentHealthAction: 
38    async def verify(self, health_action: str) -> AgentHealthAction:
39        """
40        Verify a health action
41        Synchronously re-runs the verifier for the specified health action and
42        returns the updated health action object. Use this endpoint to power
43        operator-facing "Verify" buttons that let users confirm a setup step is
44        complete (for example, after setting an environment variable or
45        completing an OAuth install).
46        The verifier transitions the action's `status` field according to the
47        following rules: a `pending` action that passes becomes `completed`; one
48        that fails stays `pending`. A `completed` action that passes stays
49        `completed`; one that fails becomes `degraded`. A `degraded` action that
50        passes returns to `completed`; one that fails stays `degraded`. Actions
51        in `skipped` status are never transitioned the call returns the
52        unchanged record.
53        This endpoint runs the verifier synchronously and blocks until the check
54        finishes. For background or probe-driven verification sweeps, use the
55        platform's internal debounced trigger instead of calling this endpoint
56        in a tight loop. Returns 422 if the verifier itself encounters an
57        unrecoverable error.
58
59        Args:
60            health_action: Health action ID (`aha_...`) to verify.
61
62        Returns:
63            The health action object with its `status` and `last_verified_at` updated to reflect the result of the verification run.
64        """
65        return await self._http.request(
66            f"/api/v1/agent_health_actions/{health_action}/verify",
67            method="POST",
68            response_type=AgentHealthAction,
69        )

Verify a health action Synchronously re-runs the verifier for the specified health action and returns the updated health action object. Use this endpoint to power operator-facing "Verify" buttons that let users confirm a setup step is complete (for example, after setting an environment variable or completing an OAuth install). The verifier transitions the action's status field according to the following rules: a pending action that passes becomes completed; one that fails stays pending. A completed action that passes stays completed; one that fails becomes degraded. A degraded action that passes returns to completed; one that fails stays degraded. Actions in skipped status are never transitioned the call returns the unchanged record. This endpoint runs the verifier synchronously and blocks until the check finishes. For background or probe-driven verification sweeps, use the platform's internal debounced trigger instead of calling this endpoint in a tight loop. Returns 422 if the verifier itself encounters an unrecoverable error.

Arguments:
  • health_action: Health action ID (aha_...) to verify.
Returns:

The health action object with its status and last_verified_at updated to reflect the result of the verification run.

class AgentHealthActionResource: 
 72class AgentHealthActionResource:
 73    def __init__(self, http: SyncHttpClient):
 74        self._http = http
 75
 76    def get(self, health_action: str) -> AgentHealthAction:
 77        """
 78        Retrieve a health action
 79        Returns a single agent health action by its ID. Use this endpoint to
 80        fetch the current state of a specific health action for example, to
 81        refresh a checklist item after the user completes a setup step or after
 82        polling for status changes.
 83        The caller must be authenticated and scoped to the app that owns the
 84        health action. Returns 404 if the health action does not exist or is not
 85        accessible within the current app scope.
 86
 87        Args:
 88            health_action: Health action ID (`aha_...`) to retrieve.
 89
 90        Returns:
 91            The requested health action object.
 92        """
 93        return self._http.request(
 94            f"/api/v1/agent_health_actions/{health_action}",
 95            response_type=AgentHealthAction,
 96        )
 97
 98    def verify(self, health_action: str) -> AgentHealthAction:
 99        """
100        Verify a health action
101        Synchronously re-runs the verifier for the specified health action and
102        returns the updated health action object. Use this endpoint to power
103        operator-facing "Verify" buttons that let users confirm a setup step is
104        complete (for example, after setting an environment variable or
105        completing an OAuth install).
106        The verifier transitions the action's `status` field according to the
107        following rules: a `pending` action that passes becomes `completed`; one
108        that fails stays `pending`. A `completed` action that passes stays
109        `completed`; one that fails becomes `degraded`. A `degraded` action that
110        passes returns to `completed`; one that fails stays `degraded`. Actions
111        in `skipped` status are never transitioned the call returns the
112        unchanged record.
113        This endpoint runs the verifier synchronously and blocks until the check
114        finishes. For background or probe-driven verification sweeps, use the
115        platform's internal debounced trigger instead of calling this endpoint
116        in a tight loop. Returns 422 if the verifier itself encounters an
117        unrecoverable error.
118
119        Args:
120            health_action: Health action ID (`aha_...`) to verify.
121
122        Returns:
123            The health action object with its `status` and `last_verified_at` updated to reflect the result of the verification run.
124        """
125        return self._http.request(
126            f"/api/v1/agent_health_actions/{health_action}/verify",
127            method="POST",
128            response_type=AgentHealthAction,
129        )
AgentHealthActionResource(http: archastro.platform.runtime.http_client.SyncHttpClient) 
73    def __init__(self, http: SyncHttpClient):
74        self._http = http
def get( self, health_action: str) -> archastro.platform.types.common.AgentHealthAction: 
76    def get(self, health_action: str) -> AgentHealthAction:
77        """
78        Retrieve a health action
79        Returns a single agent health action by its ID. Use this endpoint to
80        fetch the current state of a specific health action for example, to
81        refresh a checklist item after the user completes a setup step or after
82        polling for status changes.
83        The caller must be authenticated and scoped to the app that owns the
84        health action. Returns 404 if the health action does not exist or is not
85        accessible within the current app scope.
86
87        Args:
88            health_action: Health action ID (`aha_...`) to retrieve.
89
90        Returns:
91            The requested health action object.
92        """
93        return self._http.request(
94            f"/api/v1/agent_health_actions/{health_action}",
95            response_type=AgentHealthAction,
96        )

Retrieve a health action Returns a single agent health action by its ID. Use this endpoint to fetch the current state of a specific health action for example, to refresh a checklist item after the user completes a setup step or after polling for status changes. The caller must be authenticated and scoped to the app that owns the health action. Returns 404 if the health action does not exist or is not accessible within the current app scope.

Arguments:
  • health_action: Health action ID (aha_...) to retrieve.
Returns:

The requested health action object.

def verify( self, health_action: str) -> archastro.platform.types.common.AgentHealthAction: 
 98    def verify(self, health_action: str) -> AgentHealthAction:
 99        """
100        Verify a health action
101        Synchronously re-runs the verifier for the specified health action and
102        returns the updated health action object. Use this endpoint to power
103        operator-facing "Verify" buttons that let users confirm a setup step is
104        complete (for example, after setting an environment variable or
105        completing an OAuth install).
106        The verifier transitions the action's `status` field according to the
107        following rules: a `pending` action that passes becomes `completed`; one
108        that fails stays `pending`. A `completed` action that passes stays
109        `completed`; one that fails becomes `degraded`. A `degraded` action that
110        passes returns to `completed`; one that fails stays `degraded`. Actions
111        in `skipped` status are never transitioned the call returns the
112        unchanged record.
113        This endpoint runs the verifier synchronously and blocks until the check
114        finishes. For background or probe-driven verification sweeps, use the
115        platform's internal debounced trigger instead of calling this endpoint
116        in a tight loop. Returns 422 if the verifier itself encounters an
117        unrecoverable error.
118
119        Args:
120            health_action: Health action ID (`aha_...`) to verify.
121
122        Returns:
123            The health action object with its `status` and `last_verified_at` updated to reflect the result of the verification run.
124        """
125        return self._http.request(
126            f"/api/v1/agent_health_actions/{health_action}/verify",
127            method="POST",
128            response_type=AgentHealthAction,
129        )

Verify a health action Synchronously re-runs the verifier for the specified health action and returns the updated health action object. Use this endpoint to power operator-facing "Verify" buttons that let users confirm a setup step is complete (for example, after setting an environment variable or completing an OAuth install). The verifier transitions the action's status field according to the following rules: a pending action that passes becomes completed; one that fails stays pending. A completed action that passes stays completed; one that fails becomes degraded. A degraded action that passes returns to completed; one that fails stays degraded. Actions in skipped status are never transitioned the call returns the unchanged record. This endpoint runs the verifier synchronously and blocks until the check finishes. For background or probe-driven verification sweeps, use the platform's internal debounced trigger instead of calling this endpoint in a tight loop. Returns 422 if the verifier itself encounters an unrecoverable error.

Arguments:
  • health_action: Health action ID (aha_...) to verify.
Returns:

The health action object with its status and last_verified_at updated to reflect the result of the verification run.