Resources (Beta) | API & MCP Reference | Archera

For the complete documentation index, see llms.txt. This page is also available as Markdown.

Per-customer resource inventory

• Attribute filters, free-text search, and per-resource detail.
• Cross-references catalog SKUs via (catalog_sku_org_id, catalog_sku_id).

List filterable resource SKU attributes

Endpoint

GET /beta/v1/org/{org_id}/resources/skus/attributes

Returns the fields that can be used in the 'filter' parameter of the /resources/skus list endpoint, along with their types.

Path parameters

• org_id: string · uuid Required

Responses

• 200 OK
  • application/json
    • name: string Required
    • field: string Required
    • type: string · enum Required, Possible values: boolean, integer, float, date, datetime, time, currency, percent, string, enum, uuid, tags
• 400 Bad request
• 401 Unauthorized
• 403 Forbidden
• 404 Not found
• 405 Method not allowed
• 409 Conflict
• 500 Internal server error

Get valid values for a filterable resource SKU attribute

Endpoint

GET /beta/v1/org/{org_id}/resources/skus/attributes/{field}

Returns the distinct values for a given field, scoped to the same provider/segment/filter as the list endpoint.

Path parameters

• org_id: string · uuid Required
• field: string · min: 1 Required

Query parameters

• provider: string · enum Required, Cloud provider (aws, azure, gcp)
• segment_id: string · uuid · nullable Optional
• search: string · nullable Optional
• filter: object · nullable Optional

Responses

• 200 OK
  • application/json
    • Schema defining various optional object types (BooleanAttribute, UUIDAttribute, StringAttribute, etc.)
• 400 Bad request
• 401 Unauthorized
• 403 Forbidden
• 404 Not found
• 405 Method not allowed
• 409 Conflict
• 422 Unprocessable Content
• 500 Internal server error

List resource SKU rows in the customer's environment

Endpoint

GET /beta/v1/org/{org_id}/resources/skus

Returns ResourceSKU rows (resource x SKU x time-window) scoped to the specified provider segment and the org's current attribution.

Path parameters

• org_id: string · uuid Required

Query parameters

• provider: string · enum Required, Cloud provider (aws, azure, gcp)
• segment_id: string · uuid · nullable Optional
• search: string · nullable Optional
• filter: object · nullable Optional
• order_by: string · enum Optional
• desc: boolean Optional
• page: integer · min: 1 Optional
• page_size: integer · min: 1 · max: 100 Optional

Responses

• 200 OK
  • application/json
    • Array of ResourceSKUWithMetrics objects
• 400 Bad request
• 401 Unauthorized
• 403 Forbidden
• 404 Not found
• 405 Method not allowed
• 409 Conflict
• 422 Unprocessable Content
• 500 Internal server error

Get a single resource SKU row's full detail

Endpoint

GET /beta/v1/org/{org_id}/resources/skus/{resource_sku_id}

Returns the full ResourceSKU record — list-view fields plus hardware specs, the raw catalog attribute blob, and SKU lifecycle dates.

Path parameters

• org_id: string · uuid Required
• resource_sku_id: string · min: 1 Required

Query parameters

• expand: string · enum[] Optional
• start_date: string · date · nullable Optional
• end_date: string · date · nullable Optional

Responses

• 200 OK
  • application/json
    • Object definition of ResourceSKU detail
• 400 Bad request
• 401 Unauthorized
• 403 Forbidden
• 404 Not Found
• 405 Method not allowed
• 409 Conflict
• 422 Unprocessable Content
• 500 Internal server error

Last updated 10 days ago