v1

latestOpenAPI 3.1.02026-07-261690320.7 KB

Get cloud assets

Returns cloud assets for the connected clouds in your account. Supports pagination, filtering and search parameters similar to the cloud inventory UI. Array-valued filters are passed as comma-separated values. AI cloud search through this public endpoint expects prompts to be created in the Aikido app first and reused via prompt_id.

get/clouds/assets

Query parameters

pageinteger

Pagination parameter, starts at 0.

limitinteger

Amount of assets returned.

searchstring

Optional free-text search over asset metadata. Use this for direct keyword matching rather than AI cloud search.

sortstring

Optional sort definition. Supported fields are name, asset_type, region, source_id, cloud_id. Example: asset_type:asc,region:desc.

prompt_idinteger

Optional existing prompt identifier to reuse a previous AI cloud search plan. For AI cloud search, create the prompt in the Aikido app first and then provide that prompt_id here.

include_metadataboolean

When set to true, returns the full metadata object for each asset.

metadata_fieldsstring[]

Optional comma-separated list of metadata paths to project into the selected_metadata response field. This is projection, not filtering. The fields follow the provider-specific case convention (e.g., for AWS, they are PascalCase, while for Azure/GCP they are camelCase).

asset_typestring[]

Filter assets by one or more comma-separated asset types.

regionstring[]

Filter assets by one or more comma-separated regions.

cloud_idinteger[]

Filter assets by one or more comma-separated Aikido cloud ids.

providerstring[]

Filter assets by one or more comma-separated cloud providers.

source_idstring[]

Filter assets by one or more comma-separated provider-specific source ids. This filter is request-only and is not returned in response filter buckets.

Response

A paginated list of cloud assets.

totalCountinteger

The total number of matching assets.

hasMoreboolean

Whether more assets can be fetched on a next page.

promptIdinteger

Identifier of the prompt used for the search when applicable.

Example response

{
  "assets": [
    {
      "id": 101,
      "asset_type": "AWS::EC2::Instance",
      "asset_name": "web-server-1",
      "source_id": "i-0123456789abcdef0",
      "region": "eu-west-1",
      "cloud_id": 12,
      "provider": "aws"
    }
  ],
  "totalCount": 1,
  "hasMore": false,
  "promptId": 55
}