archastro.platform.v1.resources.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: 92f0176cabc8 4 5from __future__ import annotations 6 7from ...runtime.http_client import HttpClient, SyncHttpClient 8from ...types.status import StatusPing 9 10 11class AsyncStatuResource: 12 def __init__(self, http: HttpClient): 13 self._http = http 14 15 async def ping(self) -> StatusPing: 16 """ 17 Check API token status 18 Returns the validity and metadata of the bearer token supplied in the request. 19 Use this endpoint to verify that an API key or session token is present, active, 20 and unexpired before making authenticated calls. 21 No authentication is required to call this endpoint it accepts any request, 22 including those with no token at all. When a token is absent the `token.status` 23 field is `"missing"` and `token.active` is `false`. When a token is present but 24 invalid (expired, malformed, or referencing an unknown user) `token.active` is 25 `false` and `token.status` describes the failure reason. When the token is valid, 26 `token.active` is `true`, `token.status` is `"active"`, and `user` is populated 27 with the authenticated user's profile. 28 29 Returns: 30 Token validity details and, when the token is active, the authenticated user's profile. 31 """ 32 return await self._http.request("/api/v1/status/ping", response_type=StatusPing) 33 34 35class StatuResource: 36 def __init__(self, http: SyncHttpClient): 37 self._http = http 38 39 def ping(self) -> StatusPing: 40 """ 41 Check API token status 42 Returns the validity and metadata of the bearer token supplied in the request. 43 Use this endpoint to verify that an API key or session token is present, active, 44 and unexpired before making authenticated calls. 45 No authentication is required to call this endpoint it accepts any request, 46 including those with no token at all. When a token is absent the `token.status` 47 field is `"missing"` and `token.active` is `false`. When a token is present but 48 invalid (expired, malformed, or referencing an unknown user) `token.active` is 49 `false` and `token.status` describes the failure reason. When the token is valid, 50 `token.active` is `true`, `token.status` is `"active"`, and `user` is populated 51 with the authenticated user's profile. 52 53 Returns: 54 Token validity details and, when the token is active, the authenticated user's profile. 55 """ 56 return self._http.request("/api/v1/status/ping", response_type=StatusPing)
12class AsyncStatuResource: 13 def __init__(self, http: HttpClient): 14 self._http = http 15 16 async def ping(self) -> StatusPing: 17 """ 18 Check API token status 19 Returns the validity and metadata of the bearer token supplied in the request. 20 Use this endpoint to verify that an API key or session token is present, active, 21 and unexpired before making authenticated calls. 22 No authentication is required to call this endpoint it accepts any request, 23 including those with no token at all. When a token is absent the `token.status` 24 field is `"missing"` and `token.active` is `false`. When a token is present but 25 invalid (expired, malformed, or referencing an unknown user) `token.active` is 26 `false` and `token.status` describes the failure reason. When the token is valid, 27 `token.active` is `true`, `token.status` is `"active"`, and `user` is populated 28 with the authenticated user's profile. 29 30 Returns: 31 Token validity details and, when the token is active, the authenticated user's profile. 32 """ 33 return await self._http.request("/api/v1/status/ping", response_type=StatusPing)
16 async def ping(self) -> StatusPing: 17 """ 18 Check API token status 19 Returns the validity and metadata of the bearer token supplied in the request. 20 Use this endpoint to verify that an API key or session token is present, active, 21 and unexpired before making authenticated calls. 22 No authentication is required to call this endpoint it accepts any request, 23 including those with no token at all. When a token is absent the `token.status` 24 field is `"missing"` and `token.active` is `false`. When a token is present but 25 invalid (expired, malformed, or referencing an unknown user) `token.active` is 26 `false` and `token.status` describes the failure reason. When the token is valid, 27 `token.active` is `true`, `token.status` is `"active"`, and `user` is populated 28 with the authenticated user's profile. 29 30 Returns: 31 Token validity details and, when the token is active, the authenticated user's profile. 32 """ 33 return await self._http.request("/api/v1/status/ping", response_type=StatusPing)
Check API token status
Returns the validity and metadata of the bearer token supplied in the request.
Use this endpoint to verify that an API key or session token is present, active,
and unexpired before making authenticated calls.
No authentication is required to call this endpoint it accepts any request,
including those with no token at all. When a token is absent the token.status
field is "missing" and token.active is false. When a token is present but
invalid (expired, malformed, or referencing an unknown user) token.active is
false and token.status describes the failure reason. When the token is valid,
token.active is true, token.status is "active", and user is populated
with the authenticated user's profile.
Returns:
Token validity details and, when the token is active, the authenticated user's profile.
36class StatuResource: 37 def __init__(self, http: SyncHttpClient): 38 self._http = http 39 40 def ping(self) -> StatusPing: 41 """ 42 Check API token status 43 Returns the validity and metadata of the bearer token supplied in the request. 44 Use this endpoint to verify that an API key or session token is present, active, 45 and unexpired before making authenticated calls. 46 No authentication is required to call this endpoint it accepts any request, 47 including those with no token at all. When a token is absent the `token.status` 48 field is `"missing"` and `token.active` is `false`. When a token is present but 49 invalid (expired, malformed, or referencing an unknown user) `token.active` is 50 `false` and `token.status` describes the failure reason. When the token is valid, 51 `token.active` is `true`, `token.status` is `"active"`, and `user` is populated 52 with the authenticated user's profile. 53 54 Returns: 55 Token validity details and, when the token is active, the authenticated user's profile. 56 """ 57 return self._http.request("/api/v1/status/ping", response_type=StatusPing)
40 def ping(self) -> StatusPing: 41 """ 42 Check API token status 43 Returns the validity and metadata of the bearer token supplied in the request. 44 Use this endpoint to verify that an API key or session token is present, active, 45 and unexpired before making authenticated calls. 46 No authentication is required to call this endpoint it accepts any request, 47 including those with no token at all. When a token is absent the `token.status` 48 field is `"missing"` and `token.active` is `false`. When a token is present but 49 invalid (expired, malformed, or referencing an unknown user) `token.active` is 50 `false` and `token.status` describes the failure reason. When the token is valid, 51 `token.active` is `true`, `token.status` is `"active"`, and `user` is populated 52 with the authenticated user's profile. 53 54 Returns: 55 Token validity details and, when the token is active, the authenticated user's profile. 56 """ 57 return self._http.request("/api/v1/status/ping", response_type=StatusPing)
Check API token status
Returns the validity and metadata of the bearer token supplied in the request.
Use this endpoint to verify that an API key or session token is present, active,
and unexpired before making authenticated calls.
No authentication is required to call this endpoint it accepts any request,
including those with no token at all. When a token is absent the token.status
field is "missing" and token.active is false. When a token is present but
invalid (expired, malformed, or referencing an unknown user) token.active is
false and token.status describes the failure reason. When the token is valid,
token.active is true, token.status is "active", and user is populated
with the authenticated user's profile.
Returns:
Token validity details and, when the token is active, the authenticated user's profile.