archastro.platform.types.status 

 1# Copyright (c) 2026 ArchAstro Inc. Licensed under the MIT License.
 2# This file is auto-generated by @archastro/sdk-generator. Do not edit.
 3# Content hash: add561c71188
 4
 5from typing import Any
 6
 7from pydantic import BaseModel, Field
 8
 9from .common import Deployment
10from .users import User
11
12
13class StatusPing(BaseModel):
14    """
15    Health check response confirming the API is reachable and indicating whether the caller's token is valid.
16    """
17
18    deployment: Deployment | None = Field(default=None, description="Deployment metadata.")
19    success: bool = Field(
20        ...,
21        description="`true` when the platform is reachable and the request was processed successfully.",
22    )
23    token: dict[str, Any] = Field(
24        ..., description="Details about the authentication token used in this request."
25    )
26    user: User | None = Field(
27        default=None,
28        description="The authenticated user associated with the token. `null` when the token is invalid or absent.",
29    )
class StatusPing(pydantic.main.BaseModel): 
14class StatusPing(BaseModel):
15    """
16    Health check response confirming the API is reachable and indicating whether the caller's token is valid.
17    """
18
19    deployment: Deployment | None = Field(default=None, description="Deployment metadata.")
20    success: bool = Field(
21        ...,
22        description="`true` when the platform is reachable and the request was processed successfully.",
23    )
24    token: dict[str, Any] = Field(
25        ..., description="Details about the authentication token used in this request."
26    )
27    user: User | None = Field(
28        default=None,
29        description="The authenticated user associated with the token. `null` when the token is invalid or absent.",
30    )

Health check response confirming the API is reachable and indicating whether the caller's token is valid.

deployment: archastro.platform.types.common.Deployment | None = None

Deployment metadata.

success: bool = PydanticUndefined

true when the platform is reachable and the request was processed successfully.

token: dict[str, typing.Any] = PydanticUndefined

Details about the authentication token used in this request.

user: archastro.platform.types.users.User | None = None

The authenticated user associated with the token. null when the token is invalid or absent.