Get a discovered resource by ID

GET

/v1/resources/{id}

curl --request GET \
  --url https://example.com/v1/resources/example \
  --header 'X-API-Key: <X-API-Key>' \
  --header 'X-Tenant-ID: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Path Parameters

id

required

string

Resource identifier (ARN, AWS account ID, bucket name, etc.)

Header Parameters

X-Tenant-ID

required

string format: uuid

Tenant identifier. Must match the tenant associated with the credential. Returns 403 tenant_mismatch if the credential and header belong to different tenants.

Responses

200

OK

Media type application/json

object

id

required

Resource identifier (ARN, account ID, etc.)

string

type

required

string

Allowed values: aws_account aws_permission_set aws_s3_bucket aws_rds_instance aws_ec2_instance aws_organizational_unit

name

required

string

account_id

AWS account ID this resource belongs to. Null for aws_account resources.

string

nullable

metadata

object

key

additional properties

any

last_synced_at

required

string format: date-time

rank

Privilege rank for sorting. Lower = less privileged. Null = unranked. Set by the Terraform provider when syncing permission sets. Unranked items sort after all ranked items, then alphabetically.

integer

nullable

Example

{
  "type": "aws_account"
}

401

Unauthenticated

Media type application/json

object

code

required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string

message

required

Human-readable description of the error.

string

details

Optional additional context about the error.

object

key

additional properties

any

notices

Policy notices from determining Cedar rules, if applicable.

Array<string>

Example ^generated

{
  "code": "example",
  "message": "example",
  "details": {},
  "notices": [
    "example"
  ]
}

403

Forbidden

Media type application/json

object

code

required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string

message

required

Human-readable description of the error.

string

details

Optional additional context about the error.

object

key

additional properties

any

notices

Policy notices from determining Cedar rules, if applicable.

Array<string>

Example ^generated

{
  "code": "example",
  "message": "example",
  "details": {},
  "notices": [
    "example"
  ]
}

404

Not found

Media type application/json

object

code

required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string

message

required

Human-readable description of the error.

string

details

Optional additional context about the error.

object

key

additional properties

any

notices

Policy notices from determining Cedar rules, if applicable.

Array<string>

Example ^generated

{
  "code": "example",
  "message": "example",
  "details": {},
  "notices": [
    "example"
  ]
}