Resources

Tags: configuration, resources

Resource metadata and definitions

Resources

Request and response models used by the endpoints on this page.

ResourceMetadataResponse

Field	Type	Required	Description
description	String	✓
label	String	✓
requiresFeature	String	✓
scope	Literal['workspace', 'org', 'any']	✓
slug	String	✓
unit	String	✓
unitPlural	String	✓

Example:

{
  "slug": "string",
  "label": "string",
  "unit": "string",
  "unitPlural": "string",
  "description": "string",
  "requiresFeature": "string",
  "scope": "workspace"
}

ResourcesRegistryResponse

Field	Type	Required	Description
resources	Array<ResourceMetadataResponse>	✓

Example:

{
  "resources": []
}

Endpoints

• GET /api/v2/resources/registry - Registry
• GET /api/v2/resources/{slug} - Get Slug

Registry

GET /api/v2/resources/registry

Description:

Get the full resource registry with all metadata.

Returns all resource definitions including:

• Display labels for UI
• Unit names (singular and plural)
• Descriptions
• Required feature flag (if any)
• Scope (workspace, org, or any)

This endpoint is public (no auth required) as it returns static configuration.

Authentication: Public endpoint (no authentication required)

Response: See ResourcesRegistryResponse

---

Get Slug

GET /api/v2/resources/{slug}

Description:

Get a specific resource definition by slug.

Authentication: Public endpoint (no authentication required)

Parameters:

• slug (String)

Response: See ResourceMetadataResponse

---