Skip to content

Add guide > How to retrieve Resource ID in the Guardrails console. Closes #365 #366

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 9, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/guides/using-guardrails/troubleshooting/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ The following guides will assist with the self-resolution of common problems. If
- [Access Control Logs](/guardrails/docs/guides/using-guardrails/troubleshooting/access-control-logs)
- [Fix Invalid Controls](/guardrails/docs/guides/using-guardrails/troubleshooting/fix-invalid-controls)
- [Resolve Calculated Policy Errors](/guardrails/docs/guides/using-guardrails/troubleshooting/fix-calc-policy-evaluation-errors)
- [Run Controls Using Scripts](/guardrails/docs/guides/using-guardrails/troubleshooting/run-controls-using-scripts)
- [Run Controls Using Scripts](/guardrails/docs/guides/using-guardrails/troubleshooting/run-controls-using-scripts)
- [Retrieve Resource ID from Guardrails Console](/guardrails/docs/guides/using-guardrails/troubleshooting/retrieve-resource-id)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: Retrieve Resource ID from Guardrails Console
sidebar_label: Retrieve Resource ID from Guardrails Console
---

# Retrieve a Resource ID from Guardrails Console

In this guide, you will:
- Learn a step-by-step approach to locating the Resource ID of any managed resource within the Guardrails Console

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).

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).

## Prerequisites

- **Turbot/Operator** permissions at the Turbot resource level.
- Familiarity with the Guardrails console.

## Step 1: Locate Resources Tab

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.

![Guardrails Resources Navigation Menu](./guardrails-resources-tab.png)

## Step 2: Search for Resource

Use the **search bar** to locate the specific resource by name, type, or cloud provider.

>[!TIP] Filters can be applied to narrow down results by account, region, folder, or resource type.

![Locate Using Search Bar](./guardrails-search-resource.png)

## Step 3: Open Resource Details Page

Select the resource from the search results to open its resource details page.

![Resource Details Page](./guardrails-resource-details-page.png)

## Step 4: Locate Resource ID

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.

![Select Resource ID](./guardrails-resource-id.png)

This ID ensures precise targeting of the resource across all Guardrails tooling. The Resource ID can now be used in:
- GraphQL queries
- CLI commands
- Logs or event history lookups
- Troubleshooting invalid controls or policies

If you encounter any issues, please [Open a Support Ticket](https://support.turbot.com) and attach the relevant information to assist you more efficiently.

- A screenshot of the Resource Details page showing the Resource ID and current state.
- A screenshot of any associated Control or Policy pages that appear in an error or invalid state.
3 changes: 2 additions & 1 deletion docs/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,8 @@
"items": [
"guides/using-guardrails/troubleshooting/fix-invalid-controls",
"guides/using-guardrails/troubleshooting/access-control-logs",
"guides/using-guardrails/troubleshooting/run-controls-using-scripts"
"guides/using-guardrails/troubleshooting/run-controls-using-scripts",
"guides/using-guardrails/troubleshooting/retrieve-resource-id"
]
}
]
Expand Down