Scaleway logo
Search API
Search API

Resources

Download schema

Search API

GET
https://api.scaleway.com
/search/v1alpha1/resources

Search API › query Parameters

query
​string · required

Search query.

organization_id
​string · required

ID of the Organization to search in.

project_ids
​string[]

List of Project IDs to filter the resources by.

List of resource types to filter the resources by.

Enum values:
unknown_type
instance_server
instance_volume
instance_image
instance_security_group
instance_private_nic
instance_snapshot
instance_placement_group
localities
​string[]

List of scopes (zones, regions, or global) to filter the resources by.

created_after
​string · date-time

Filter resources created after this timestamp. (RFC 3339 format)

created_before
​string · date-time

Filter resources created before this timestamp. (RFC 3339 format)

modified_after
​string · date-time

Filter resources modified after this timestamp. (RFC 3339 format)

modified_before
​string · date-time

Filter resources modified before this timestamp. (RFC 3339 format)

page_token
​string

Opaque token used to retrieve the next page of results (cursor-based pagination). Leave empty or omit to fetch the first page.

page_size
​integer · uint32

Number of resources to retrieve per page.

Sort order in the response.

Enum values:
relevance
created_at_asc
created_at_desc
modified_at_asc
modified_at_desc
name_asc
name_desc
type_asc
Default: relevance

Search API › Responses

200
scaleway.search.v1alpha1.SearchResourcesResponse

Top resources found.

next_page_token
​string

Opaque token to retrieve the next page of results. If this string is empty, it means there are no more pages available.