---
title: "List resources"
method: GET
path: "/resources"
tags: ["resources"]
---

# List resources

`GET /resources`

Extracts and lists resources based on a provided query string.

## Query parameters

- `query` string, required

## Headers

- `Client-ID` string, required

## Response `200`

: OK: The extracted resources.

- ModelForma
  - `Description` GithubComPlatformEngineeringLabsFormaePkgModelDescription
    - `Confirm` boolean
    - `Text` string
  - `Policies` array[] — Standalone policies
    - integer[]
  - `Properties` object
  - `Resources` ModelResource[]
    - `Alias` string — RFC-0041: 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
  - `Stacks` ModelStack[]
    - `CreatedAt` string
    - `Description` string
    - `ID` string
    - `Label` string
    - `Policies` array[] — Inline policies from PKL
      - integer[]
  - `Targets` ModelTarget[]
    - `Config` integer[]
    - `ConfigSchema` ModelConfigSchema
      - `Hints` object
    - `Discoverable` boolean
    - `Label` string
    - `Namespace` string
    - `Version` integer

## Other responses

- `400` — Bad Request: Invalid query.
- `404` — Not Found: No resources found matching the query.
- `406` — Not Acceptable: The request is not supported.
- `500` — Internal Server Error.

---

[API](https://skmtc.net/platform-engineering-labs/apis/formae-rest-api.md) · [All operations](https://skmtc.net/platform-engineering-labs/apis/formae-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/platform-engineering-labs/formae-rest-api/versions/e4ee5fb76a4f/schema)