Verify upload portal information
Retrieve a subset of files from the portal, to be used in the data source wizard.
Authorizations
Path parameters
organizationIdintegerRequired
Organization ID
portalIdintegerRequired
Portal ID
Responses
200
OK
application/json
Responseall of
Response object for verifying an organization's bucket connectivity.
Workflow:
- The client initiates verification by sending a GET request to /api/organizations/{organizationId}/buckets/verify with bucket and credential details.
- The server responds with this VerifyOrganizationBucketResponse object.
- The client checks the connectionStatus:
- If "connected": Verification is complete. Other properties (files, hasInfoLabelsFile, signedUrl) are available.
- If "connecting": Verification is in progress. The client should continue polling. Other properties are not yet available.
- If "error": Verification failed. Check connectionError for details. Other properties are not available.
- If connectionStatus is "connecting", the client should periodically poll the endpoint until the status changes to "connected" or "error".
get
GET /v1/api/organizations/{organizationId}/portals/{portalId}/verify HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Accept: */*
200
OK
{
"success": true,
"error": "text",
"connectionStatus": "connected",
"connectionError": "text",
"connectionStatusSince": "2025-07-05T17:48:24.361Z",
"files": [
{
"name": "text",
"size": 1,
"folderName": "text"
}
],
"hasInfoLabelsFile": true,
"signedUrl": "text",
"endpoint": "text"
}
Last updated
Was this helpful?