v1

latestOpenAPI 3.1.02026-08-042955230.1 KB
Resources

/resources

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

get/v1/org/{org_id}/resources

Query parameters

provider'aws' | 'azure' | 'gcp'
Example:aws

Filter by provider

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

Filter by segment ID

searchstring
Example:us-east-1

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

descboolean nullable

Sort in descending order if true

order_by'id' | 'usage_start' | 'null' nullable
Example:id

Field to order results by

pageinteger
page_sizeinteger

Response

OK

idstring required
resource_idstring uuid required

Unique identifier for the underlying resource

provider'aws' | 'azure' | 'gcp' required
provider_resource_idstring required

Provider's unique identifier (e.g., ARN for AWS)

is_spotboolean required

Whether this is a spot instance (a way to utilize unused instances)

namestring nullable
resource_groupstring nullable

Azure resource group

usage_endstring date required

Last date this resource had usage

usage_startstring date required

First date this resource had usage

tagsobject required
created_atstring date required
updated_atstring date required
instance_idstring
billing_account_idstring required

Management account ID (AWS) or billing account ID (Azure/GCP)

sub_account_idstring required

Account ID where the resource is running

management_account_idstring required

Management account ID (AWS) or billing account ID (Azure/GCP)

owner_account_idstring required

Account ID where the resource is running

sku_titlestring
sku_namestring nullable
availability_zonestring nullable
cache_enginestring nullable

Cache engine type (e.g., Redis, Memcached)

database_enginestring nullable

Database engine type (e.g., MySQL, PostgreSQL)

descriptionstring nullable
familystring nullable

Service or product family (e.g., 'Compute', 'Storage')

full_region_namestring nullable
has_ondemand_termsboolean nullable

Whether on-demand pricing is available for this SKU

instance_typestring nullable

Instance type (e.g., 'm5.large', 'Standard_D4s_v3')

instance_type_familystring nullable

Instance family (e.g., 'm5', 'Standard_D')

is_reservableboolean nullable

Whether this resource type supports reservations/commitments

license_modelstring nullable
location_typestring nullable
normalization_size_factorstring nullable
operating_systemstring nullable
pre_installed_swstring nullable
price_currencystring nullable
provider_servicestring nullable
provider_sku_idstring nullable
publication_datestring nullable
regionstring nullable
servicestring nullable

Service name (e.g., 'Amazon Elastic Compute Cloud')

tenancystring nullable
usage_typestring nullable
versionstring nullable
vpc_networking_supportboolean nullable
ondemand_usage_unitstring nullable

Example response

[
  {
    "provider_resource_id": "arn:aws:ec2:us-west-2:123456789012:instance/i-1234567890abcdef0"
  }
]