Resources

Resources are cloud infrastructure components (VMs, databases, clusters, etc.) discovered across your connected cloud accounts.

Overview

When you connect a cloud account, ZopNight's discoverer service scans for resources across all enabled regions. Each resource is classified by type, tagged as schedulable or inventory-only, and stored with its cloud metadata.

Resource UID

Each resource has a uid field containing the cloud provider's native resource identifier (e.g., i-0abc123def456 for AWS EC2, orprojects/my-project/zones/us-central1-a/instances/vm1 for GCP Compute). This UID is used to reference resources in schedules, actions, and other operations.

Resource Statuses

Status	Description
`running`	Resource is active and running
`stopped`	Resource has been stopped
`starting`	Resource is transitioning to running state
`stopping`	Resource is transitioning to stopped state
`pending`	Resource state is being determined

List Resources

GET

/resources

List all discovered resources with filtering and pagination.

Query Parameters

Parameter	Type	Description
`search`	string	Search by resource name or UID
`type`	string	Filter by resource type (e.g., aws-ec2, gcp-compute)
`provider`	string	Filter by cloud provider (aws, gcp, azure)
`status`	string	Filter by status (running, stopped, etc.)
`region`	string	Filter by cloud region
`schedulable`	boolean	Filter by schedulable capability
`page`	integer	Page number (default: 1)
`limit`	integer	Items per page (default: 20)
`sort_by`	string	Sort field (name, type, status, provider)
`sort_order`	string	asc or desc

Examplebash

curl "https://zopnight.com/api/resources?provider=aws&type=aws-ec2&status=running&limit=10" \
  -H "Authorization: Bearer <token>"

Responsejson

{
  "data": [
    {
      "id": "res_001",
      "name": "web-server-prod",
      "uid": "i-0abc123def456",
      "type": "aws-ec2",
      "instanceType": "t3.medium",
      "region": "us-east-1",
      "status": "running",
      "cloudAccountID": "ca_abc123",
      "cloudAccountName": "Production AWS",
      "provider": "aws",
      "schedulable": true,
      "tags": {
        "Environment": "production",
        "Team": "platform"
      },
      "createdAt": "2025-01-15T10:30:00Z",
      "updatedAt": "2025-01-20T08:00:00Z"
    }
  ]
}

Get Resource

GET

/resources/{resourceID}

Get detailed information about a specific resource.

Get Resources by IDs

GET

/resources/by-ids

Fetch multiple resources by their IDs in a single request.

Examplebash

curl "https://zopnight.com/api/resources/by-ids?ids=res_001,res_002,res_003" \
  -H "Authorization: Bearer <token>"

Get Filter Fields

GET

/resources/filter-fields

Get available filter options (distinct types, providers, regions, statuses) for building filter UIs.

Responsejson

{
  "data": {
    "types": ["aws-ec2", "aws-rds", "gcp-compute", "azure-vm"],
    "providers": ["aws", "gcp", "azure"],
    "regions": ["us-east-1", "us-west-2", "europe-west1"],
    "statuses": ["running", "stopped"]
  }
}

Refresh Discovery

Trigger an on-demand resource discovery scan for a specific cloud account. Discovery runs across all enabled regions and updates the resource inventory.

POST

/resources/refresh

Trigger a resource discovery refresh.

Requestbash

curl -X POST https://zopnight.com/api/resources/refresh \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "cloudAccountID": "ca_abc123",
    "cloudAccountName": "Production AWS",
    "provider": "aws"
  }'

Responsejson

{
  "data": {
    "refreshID": "ref_xyz789",
    "status": "queued"
  }
}

Refresh Status

GET

/resources/refresh/status

Check the status of a discovery refresh.

Responsejson

{
  "data": {
    "id": "ref_xyz789",
    "status": "success",
    "discovered": 47,
    "startedAt": "2025-01-20T08:00:00Z",
    "completedAt": "2025-01-20T08:02:15Z"
  }
}

Resource Object

Field	Type	Description
`id`	string	Unique resource ID
`name`	string	Resource display name
`uid`	string	Cloud provider native resource identifier
`type`	string	Resource type (e.g., aws-ec2, gcp-compute, azure-vm)
`instanceType`	string	Instance size/type (e.g., t3.medium)
`sizeGB`	number?	Storage size in GB (storage resources)
`unitCount`	integer?	Container/unit count (containerized resources)
`region`	string	Cloud region
`status`	string	Current status (running, stopped, etc.)
`cloudAccountID`	string	Connected cloud account ID
`cloudAccountName`	string	Cloud account display name
`provider`	string	Cloud provider (aws, gcp, azure)
`parentUID`	string	Parent resource UID (e.g., cluster for a node)
`childCount`	integer	Number of child resources
`schedulable`	boolean	Whether the resource supports start/stop scheduling
`tags`	object	Cloud provider tags as key-value pairs
`createdAt`	string	ISO 8601 creation timestamp
`updatedAt`	string	ISO 8601 last update timestamp

See Cloud Support Matrix for the full list of supported resource types per cloud provider.