Resources

API for retrieving and analyzing infrastructure resources

/resources

get

Retrieves a list of infrastructure resources for the organization, including compute instances, databases, and other services with their current status and costs.

Path parameters

org_idstring · uuidRequired

Query parameters

providerstring · enumOptional

Filter by provider

Example: awsPossible values:

segment_idstring · uuidOptional

Filter by segment ID

Example: 550e8400-e29b-41d4-a716-446655440000

searchstringOptional

Text to search across multiple columns (case-insensitive partial match)

Example: us-east-1

descboolean · nullableOptional

Sort in descending order if true

Default: nullExample: true

order_bystring,null · enum · nullableOptional

Field to order results by

Default: idExample: idPossible values:

pageinteger · min: 1OptionalDefault: 1

page_sizeinteger · min: 1 · max: 100OptionalDefault: 20

Responses

200

OK

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

get/v1/org/{org_id}/resources

HTTPcURLJavaScriptPython

GET /v1/org/{org_id}/resources HTTP/1.1
Accept: */*

[
  {
    "id": "text",
    "resource_id": "123e4567-e89b-12d3-a456-426614174000",
    "provider": "aws",
    "provider_resource_id": "arn:aws:ec2:us-west-2:123456789012:instance/i-1234567890abcdef0",
    "is_spot": true,
    "name": null,
    "resource_group": null,
    "usage_end": "2026-08-08",
    "usage_start": "2026-08-08",
    "tags": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "created_at": "2026-08-08",
    "updated_at": "2026-08-08",
    "instance_id": "text",
    "billing_account_id": "text",
    "sub_account_id": "text",
    "sku_title": "text",
    "sku_name": null,
    "availability_zone": null,
    "cache_engine": null,
    "database_engine": null,
    "description": null,
    "family": null,
    "full_region_name": null,
    "has_ondemand_terms": null,
    "instance_type": null,
    "instance_type_family": null,
    "is_reservable": null,
    "license_model": null,
    "location_type": null,
    "normalization_size_factor": null,
    "operating_system": null,
    "pre_installed_sw": null,
    "price_currency": null,
    "provider_service": null,
    "provider_sku_id": null,
    "publication_date": null,
    "region": null,
    "service": null,
    "tenancy": null,
    "usage_type": null,
    "version": null,
    "vpc_networking_support": null,
    "ondemand_usage_unit": null
  }
]

/resources/{resource_id}/daily-usage

get

Retrieves daily usage data for a specific resource within the specified date range. Optionally filter by catalog_sku_id to get usage for a specific SKU. Including usage metrics, costs, and coverage information.

Path parameters

org_idstring · uuidRequired

resource_idstring · uuidRequired

Query parameters

start_datestring · dateRequired

Start date for the date range filter (inclusive)

Example: 2024-01-01

end_datestring · dateRequired

End date for the date range filter (inclusive)

Example: 2024-01-31

catalog_sku_idstring · nullableOptional

Optional catalog SKU ID to filter daily usage records for a specific SKU

Example: 550e8400-e29b-41d4-a716-446655440000

pageinteger · min: 1OptionalDefault: 1

page_sizeinteger · min: 1 · max: 10000OptionalDefault: 100

Responses

200

OK

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

get/v1/org/{org_id}/resources/{resource_id}/daily-usage

HTTPcURLJavaScriptPython

GET /v1/org/{org_id}/resources/{resource_id}/daily-usage?start_date=2024-01-01&end_date=2024-01-31 HTTP/1.1
Accept: */*

[
  {
    "date": "2026-08-08",
    "sub_account_id": "text",
    "usage": 1,
    "reservation_usage": 1,
    "free_tier_usage": 1,
    "ondemand_cost": 1,
    "reserved_cost": 1,
    "if_all_ondemand_cost": 1,
    "spot_cost": 1,
    "free_tier_savings": 1,
    "usage_type": null,
    "common_usage_type": null,
    "covered_usage": 1,
    "uptime": 1
  }
]