---
title: "Get a resource by ksuid"
method: GET
path: "/resources/by-ksuid/{ksuid}"
tags: ["resources"]
---

# Get a resource by ksuid

`GET /resources/by-ksuid/{ksuid}`

Retrieves a single resource by its ksuid identifier.

## Path parameters

- `ksuid` string, required

## Response `200`

OK: The resource.

- ModelResource
  - `Alias` string — previous label, used to rename in place
  - `Group` string
  - `Ksuid` string
  - `Label` string
  - `Managed` boolean — Whether the resource is managed by Formae or not
  - `NativeID` string
  - `PatchDocument` integer[] — Need this for CLI patch display
  - `Properties` integer[]
  - `ReadOnlyProperties` integer[]
  - `Schema` ModelSchema
    - `Discoverable` boolean
    - `Extractable` boolean
    - `Fields` string[]
    - `Hints` object
    - `Identifier` string
    - `Parent` string — NEW: from ResourceHint.parent; "" when unset.
    - `ParentMappings` ModelParentMapping[] — NEW: from ResourceHint.parentRefs[*]; nil when unset.
      - `childProperty` string
      - `parentProperty` string
    - `Portable` boolean
  - `Stack` string
  - `Target` string
  - `Type` string

## Other responses

- `400` — Bad Request: Malformed ksuid.
- `404` — Not Found: No resource found for the given ksuid.
- `500` — Internal Server Error.

## Changes

- **2026-08-16** `17a8f5fd7318` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/platform-engineering-labs/apis/formae-rest-api/changes/resources/by-ksuid/:ksuid/get.md)

---

[API](https://skmtc.dev/platform-engineering-labs/apis/formae-rest-api.md) · [All operations](https://skmtc.dev/platform-engineering-labs/apis/formae-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/platform-engineering-labs/formae-rest-api/revisions/3172614a653b/schema)
