Search API | Scaleway Developers

The Scaleway Search API enables you to locate products and resources across an organization.

Search by:

Product name or resource type
Resource ID
Resource name

Returned metadata:

Resource location
Associated project (name and ID)
Creation and last modified date

Concepts

Refer to the Organizations and Projects - GlossaryOpen in new context, or Use the Resource ExplorerOpen in new context to find definitions and information on all Search API related terminology.

Quickstart

Note that the Search is also integrated in the Scaleway CLIOpen in new context. Refer to scw searchOpen in new context in CLI documentation for more details.

Requirement

You have a Scaleway accountOpen in new context
You have created an API keyOpen in new context and that the API key has sufficient IAM permissionsOpen in new context to perform the actions described on this page
You have installed curlOpen in new context

Configure your environment variables:

Note
This is an optional step that seeks to simplify your usage of the Search API.
```
Code
export SCW_SECRET_KEY="<YOUR_API_SECRET_KEY>"
export SCW_ORGANIZATION_ID="<YOUR_ORGANIZATION_ID>"
```

Run the following command to perform a basic search query and get the list of the resources attached to your organization:

Code
curl -X GET \
    -H "X-Auth-Token: $SCW_SECRET_KEY" \
    "https://api.scaleway.com/search/v1alpha1/resources?organization_id=$SCW_ORGANIZATION_ID"

Example response:

Code
{
"resources": [
    {
    "id": "0dac255c-83e7-483a-895c-73a6e1bdaca4",
    "name": "my-cpu-instance-example",
    "organization_id": "13280ed3-afff-4abc-9a8c-eb972589c821",
    "project_id": "13270ed5-afff-4abc-8a7c-eb972389c821",
    "type": "sbs_volume",
    "zone": "fr-par-1",
    "created_at": "2026-10-09T11:54:21.593179Z",
    "updated_at": "2026-10-09T11:54:22.438089Z"
    }
],
"next_page_token": ""
}

Technical information

Availability Zones / Regions

Scaleway Search API is a global service. It can search for Scaleway products and resources on whatever locality (zone, region or global as well) they are in.

Technical limitations

Refer to the Resource explorer - Supported resource typesOpen in new context documentation for the complete list of resources supported by the Search API.

Going further

For more help using Scaleway Search API, check out the following resources:

The search CLI documentationOpen in new context
Scaleway main documentationOpen in new context
The Slack CommunityOpen in new context
The Scaleway support ticketing systemOpen in new context.