From 75dbd71f493cf1d764b0cfd31959e244ba198187 Mon Sep 17 00:00:00 2001
From: Anton Tolchanov <anton@tailscale.com>
Date: Thu, 21 Sep 2023 16:16:36 -0500
Subject: [PATCH] api.md: document the `invalid` field in Get Key API response

Updates tailscale/terraform-provider-tailscale#144

Signed-off-by: Anton Tolchanov <anton@tailscale.com>
---
 api.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/api.md b/api.md
index 6edd27f03..51b75719d 100644
--- a/api.md
+++ b/api.md
@@ -1434,6 +1434,18 @@ The response is a JSON object with information about the key supplied.
 }
 ```
 
+Response for a revoked (deleted) or expired key will have an `invalid` field set to `true`:
+
+``` jsonc
+{
+  "id": "abc123456CNTRL",
+  "created": "2022-05-05T18:55:44Z",
+  "expires": "2022-08-03T18:55:44Z",
+  "revoked": "2023-04-01T20:50:00Z",
+  "invalid": true
+}
+```
+
 <a href="tailnet-keys-key-delete"></a>
 
 ## Delete key