From 74b0528ff033257020b57f8c594a0876083a607d Mon Sep 17 00:00:00 2001
From: divolgin <dmitriy@replicated.com>
Date: Fri, 20 Dec 2024 15:31:29 -0800
Subject: [PATCH] Docs for /api/v1/app/status API

---
 docs/reference/replicated-sdk-apis.md | 29 +++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/docs/reference/replicated-sdk-apis.md b/docs/reference/replicated-sdk-apis.md
index 95bb078c37..05fa3c2715 100644
--- a/docs/reference/replicated-sdk-apis.md
+++ b/docs/reference/replicated-sdk-apis.md
@@ -44,6 +44,35 @@ Response:
 }
 ```
 
+### GET /app/status
+
+List details about an application status, including the list of individual resource states and the overall application state. 
+
+```
+/api/v1/app/status
+```
+
+Response:
+
+```json
+{
+  "appStatus": {
+    "appSlug": "my-app",
+    "resourceStates": [
+      {
+        "kind": "deployment",
+        "name": "api",
+        "namespace": "default",
+        "state": "ready"
+      }
+    ],
+    "updatedAt": "2024-12-19T23:01:52.207162284Z",
+    "state": "ready",
+    "sequence": 268
+  }
+}
+```
+
 ### GET /app/updates
 
 List details about the releases that are available to an application instance for upgrade, including the version label, created timestamp, and release notes.