Skip to content

Commit 44b0250

Browse files
Add guide > How to retrieve Resource ID in the Guardrails console. Closes #365 (#366)
1 parent 56609bb commit 44b0250

File tree

7 files changed

+59
-2
lines changed

7 files changed

+59
-2
lines changed

docs/guides/using-guardrails/troubleshooting/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,5 @@ The following guides will assist with the self-resolution of common problems. If
1010
- [Access Control Logs](/guardrails/docs/guides/using-guardrails/troubleshooting/access-control-logs)
1111
- [Fix Invalid Controls](/guardrails/docs/guides/using-guardrails/troubleshooting/fix-invalid-controls)
1212
- [Resolve Calculated Policy Errors](/guardrails/docs/guides/using-guardrails/troubleshooting/fix-calc-policy-evaluation-errors)
13-
- [Run Controls Using Scripts](/guardrails/docs/guides/using-guardrails/troubleshooting/run-controls-using-scripts)
13+
- [Run Controls Using Scripts](/guardrails/docs/guides/using-guardrails/troubleshooting/run-controls-using-scripts)
14+
- [Retrieve Resource ID from Guardrails Console](/guardrails/docs/guides/using-guardrails/troubleshooting/retrieve-resource-id)
214 KB
Loading
131 KB
Loading
122 KB
Loading
85.4 KB
Loading
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: Retrieve Resource ID from Guardrails Console
3+
sidebar_label: Retrieve Resource ID from Guardrails Console
4+
---
5+
6+
# Retrieve a Resource ID from Guardrails Console
7+
8+
In this guide, you will:
9+
- Learn a step-by-step approach to locating the Resource ID of any managed resource within the Guardrails Console
10+
11+
In Guardrails, [resources](/guardrails/docs/reference/glossary#resource) represent real-world cloud entities like AWS S3 buckets, GCP compute instances, or Azure SQL databases. These resources are discovered, tracked, and governed by Guardrails, with their metadata and lifecycle events stored in the Guardrails [CMDB](/guardrails/docs/reference/glossary#cmdb).
12+
13+
Whether troubleshooting a policy issue, crafting GraphQL queries, or automating remediation workflows, the ResourceID serves as a vital identifier. It functions as a unique handle to query, inspect, and perform actions on specific resources through the [Guardrails Console](/guardrails/docs/reference/glossary#guardrails-console), [GraphQL](/guardrails/docs/reference/graphql#graphql), or [CLI](/guardrails/docs/reference/cli).
14+
15+
## Prerequisites
16+
17+
- **Turbot/Operator** permissions at the Turbot resource level.
18+
- Familiarity with the Guardrails console.
19+
20+
## Step 1: Locate Resources Tab
21+
22+
Log in to the Guardrails console using valid credentials and from the top navigation menu, select **Resources** to access the list of cloud resources managed by Guardrails.
23+
24+
![Guardrails Resources Navigation Menu](./guardrails-resources-tab.png)
25+
26+
## Step 2: Search for Resource
27+
28+
Use the **search bar** to locate the specific resource by name, type, or cloud provider.
29+
30+
>[!TIP] Filters can be applied to narrow down results by account, region, folder, or resource type.
31+
32+
![Locate Using Search Bar](./guardrails-search-resource.png)
33+
34+
## Step 3: Open Resource Details Page
35+
36+
Select the resource from the search results to open its resource details page.
37+
38+
![Resource Details Page](./guardrails-resource-details-page.png)
39+
40+
## Step 4: Locate Resource ID
41+
42+
From the resource details page, open the **Developers** tab to view the `Identifiers` section. The **Resource ID**, a unique numeric identifier within Guardrails, is displayed here along with a copy icon to easily copy it to the clipboard.
43+
44+
![Select Resource ID](./guardrails-resource-id.png)
45+
46+
This ID ensures precise targeting of the resource across all Guardrails tooling. The Resource ID can now be used in:
47+
- GraphQL queries
48+
- CLI commands
49+
- Logs or event history lookups
50+
- Troubleshooting invalid controls or policies
51+
52+
If you encounter any issues, please [Open a Support Ticket](https://support.turbot.com) and attach the relevant information to assist you more efficiently.
53+
54+
- A screenshot of the Resource Details page showing the Resource ID and current state.
55+
- A screenshot of any associated Control or Policy pages that appear in an error or invalid state.

docs/sidebar.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,8 @@
359359
"items": [
360360
"guides/using-guardrails/troubleshooting/fix-invalid-controls",
361361
"guides/using-guardrails/troubleshooting/access-control-logs",
362-
"guides/using-guardrails/troubleshooting/run-controls-using-scripts"
362+
"guides/using-guardrails/troubleshooting/run-controls-using-scripts",
363+
"guides/using-guardrails/troubleshooting/retrieve-resource-id"
363364
]
364365
}
365366
]

0 commit comments

Comments
 (0)