Skip to main content
GET
/
resources
Get resources
curl --request GET \
  --url https://api.vantage.sh/v2/resources \
  --header 'Authorization: Bearer <token>'
{
  "links": {
    "self": "https://api.vantage.sh/v2/resources?resource_report_token=prvdr_rsrc_rprt_a92daa2d9d885dcc&include_cost=true",
    "first": "https://api.vantage.sh/v2/resources?resource_report_token=prvdr_rsrc_rprt_a92daa2d9d885dcc&include_cost=true&page=1",
    "next": null,
    "last": "https://api.vantage.sh/v2/resources?resource_report_token=prvdr_rsrc_rprt_a92daa2d9d885dcc&include_cost=true&page=1",
    "prev": null
  },
  "resources": [
    {
      "token": "prvdr_rsrc_4a1f4a30d86a586f",
      "uuid": "0a997b68-281b-441b-865a-1ce183ae5f51",
      "type": "aws_instance",
      "label": "Faker::Business",
      "metadata": {
        "instance_id": null,
        "image_id": null,
        "region": null,
        "vpc_id": null,
        "subnet_id": null,
        "public_ip_address": null,
        "private_ip_address": null,
        "public_dns_name": null,
        "instance_type": null,
        "platform": null,
        "spot_instance_request_id": null,
        "launch_time": 1728332095,
        "instance_lifecycle": null,
        "name": null,
        "platform_type": "Linux/UNIX",
        "spot_info": null,
        "spot_price": null,
        "datadog_agent_installed": null,
        "network_interfaces": null,
        "tags": null,
        "instance_type_name": "t2.micro",
        "lifecycle": "normal"
      },
      "account_id": "734912804094",
      "billing_account_id": "734912804094",
      "provider": "aws",
      "region": "us-east-1",
      "cost": 200,
      "created_at": "2024-10-06T20:14:55.898Z"
    },
    {
      "token": "prvdr_rsrc_21a16d1b66e134d9",
      "uuid": "0f21a7dc-a466-43fb-81e8-1cc2346482f4",
      "type": "aws_instance",
      "label": "Faker::Business",
      "metadata": {
        "instance_id": null,
        "image_id": null,
        "region": null,
        "vpc_id": null,
        "subnet_id": null,
        "public_ip_address": null,
        "private_ip_address": null,
        "public_dns_name": null,
        "instance_type": null,
        "platform": null,
        "spot_instance_request_id": null,
        "launch_time": 1728332095,
        "instance_lifecycle": null,
        "name": null,
        "platform_type": "Linux/UNIX",
        "spot_info": null,
        "spot_price": null,
        "datadog_agent_installed": null,
        "network_interfaces": null,
        "tags": null,
        "instance_type_name": "t2.micro",
        "lifecycle": "normal"
      },
      "account_id": "734912804094",
      "billing_account_id": "734912804094",
      "provider": "aws",
      "region": "us-east-1",
      "cost": 100,
      "created_at": "2024-10-07T20:14:55.898Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.vantage.sh/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

resource_report_token
string

The ResourceReport token.

filter
string

The filter query language to apply to the Resources. Additional documentation available at https://docs.vantage.sh/vql.

workspace_token
string

The Workspace in which the Resources are located.

include_cost
boolean

Include cost information in the response.

page
integer<int32>

The page number for pagination.

limit
integer<int32>

The number of resources to return per page.

Response

Resources model

resources
object[]
required