string
required
Unique identifier for a given Organization.
string
required
Unique identifier for a given TVC App.
object
required
appStatus field
Show appStatus details
Show appStatus details
curl --request POST \
--url https://api.turnkey.com/public/v1/query/get_app_status \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header "X-Stamp: <string> (see Authorizations)" \
--data '{
"organizationId": "<string>",
"appId": "<string>"
}'
import { Turnkey } from "@turnkey/sdk-server";
const turnkeyClient = new Turnkey({
apiBaseUrl: "https://api.turnkey.com",
apiPublicKey: process.env.API_PUBLIC_KEY!,
apiPrivateKey: process.env.API_PRIVATE_KEY!,
defaultOrganizationId: process.env.ORGANIZATION_ID!,
});
const response = await turnkeyClient.apiClient().getAppStatus({
organizationId: "<string> (Unique identifier for a given Organization.)",
appId: "<string> (Unique identifier for a given TVC App.)"
});
{
"appStatus": {
"appId": "<string>",
"deployments": [
{
"deploymentId": "<string>",
"readyReplicas": "<number>",
"desiredReplicas": "<number>",
"lastUpdatedTime": {
"seconds": "<string>",
"nanos": "<string>"
},
"provisioningState": "<PROVISIONING_STATE_PENDING>"
}
],
"targetedDeploymentId": "<string>"
}
}