Returns the list of all cloud credentials configured in the system, with support for pagination and provider filtering.
Cloud credentials are used to access external services such as AWS, Azure, GCP, etc. during Spark job execution.
/
Update a cloud credential
WebRobot ETL API (1.0.0)
API for managing projects, jobs, datasets, and ETL pipelines on WebRobot.
The API uses API Keys for authentication. Include the X-API-Key header in all requests.
Download OpenAPI description
Overview
WebRobot Support
License
Languages
Servers
Mock server
http://docs.webrobot.eu/_mock/openapi/
Production
https://api.webrobot.eu/api/
Local development
http://localhost:8020/api/
- Mock serverhttp://docs.webrobot.eu/_mock/openapi/webrobot/api/cloud-credentials
- Productionhttps://api.webrobot.eu/api/webrobot/api/cloud-credentials
- Local developmenthttp://localhost:8020/api/webrobot/api/cloud-credentials
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'http://docs.webrobot.eu/_mock/openapi/webrobot/api/cloud-credentials?provider=aws&page=0&pageSize=50' \
-H 'X-API-Key: YOUR_API_KEY_HERE'Response
application/json
[ { "id": 0, "name": "string", "description": "string", "provider": "OPENAI", "apiKey": "string", "apiSecret": "string", "organizationId": "string", "projectId": "string", "region": "string", "endpoint": "string", "accessKeyId": "string", "secretAccessKey": "string", "sessionToken": "string", "accountId": "string", "subscriptionId": "string", "resourceGroup": "string", "workspaceName": "string", "huggingFaceToken": "string", "cohereApiKey": "string", "azureAiStudioEndpoint": "string", "mosaicmlApiKey": "string", "replicateApiToken": "string", "twitterBearerToken": "string", "twitterApiKey": "string", "twitterApiSecret": "string", "redditClientId": "string", "redditClientSecret": "string", "redditUserAgent": "string", "facebookAccessToken": "string", "facebookAppId": "string", "facebookAppSecret": "string", "instagramAccessToken": "string", "linkedinAccessToken": "string", "linkedinClientId": "string", "linkedinClientSecret": "string", "tiktokClientKey": "string", "tiktokClientSecret": "string", "youtubeApiKey": "string", "databricksWorkspaceUrl": "string", "databricksAccessToken": "string", "databricksClusterId": "string", "oauthAccessToken": "string", "oauthRefreshToken": "string", "oauthTokenExpiresAt": "2019-08-24T14:15:22Z", "oauthTokenType": "string", "alphavantageApiKey": "string", "polygonApiKey": "string", "twelvedataApiKey": "string", "marketstackAccessKey": "string", "fmpApiKey": "string", "iexcloudToken": "string", "cbondApiKey": "string", "cbondClientId": "string", "cbondClientSecret": "string", "googleSearchApiKey": "string", "googleSearchEngineId": "string", "bingSearchApiKey": "string", "enabled": true } ]
Bodyapplication/jsonrequired
Cloud credential data to create
Provider
Enum"OPENAI""ANTHROPIC""HUGGING_FACE""COHERE""AZURE_AI_STUDIO""MOSAICML""REPLIC""STEEL_DEV""TOGETHERAI""AWS"
- Mock serverhttp://docs.webrobot.eu/_mock/openapi/webrobot/api/cloud-credentials
- Productionhttps://api.webrobot.eu/api/webrobot/api/cloud-credentials
- Local developmenthttp://localhost:8020/api/webrobot/api/cloud-credentials
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
http://docs.webrobot.eu/_mock/openapi/webrobot/api/cloud-credentials \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_API_KEY_HERE' \
-d '{
"id": 0,
"name": "string",
"description": "string",
"provider": "OPENAI",
"apiKey": "string",
"apiSecret": "string",
"organizationId": "string",
"projectId": "string",
"region": "string",
"endpoint": "string",
"accessKeyId": "string",
"secretAccessKey": "string",
"sessionToken": "string",
"accountId": "string",
"subscriptionId": "string",
"resourceGroup": "string",
"workspaceName": "string",
"huggingFaceToken": "string",
"cohereApiKey": "string",
"azureAiStudioEndpoint": "string",
"mosaicmlApiKey": "string",
"replicateApiToken": "string",
"twitterBearerToken": "string",
"twitterApiKey": "string",
"twitterApiSecret": "string",
"redditClientId": "string",
"redditClientSecret": "string",
"redditUserAgent": "string",
"facebookAccessToken": "string",
"facebookAppId": "string",
"facebookAppSecret": "string",
"instagramAccessToken": "string",
"linkedinAccessToken": "string",
"linkedinClientId": "string",
"linkedinClientSecret": "string",
"tiktokClientKey": "string",
"tiktokClientSecret": "string",
"youtubeApiKey": "string",
"databricksWorkspaceUrl": "string",
"databricksAccessToken": "string",
"databricksClusterId": "string",
"oauthAccessToken": "string",
"oauthRefreshToken": "string",
"oauthTokenExpiresAt": "2019-08-24T14:15:22Z",
"oauthTokenType": "string",
"alphavantageApiKey": "string",
"polygonApiKey": "string",
"twelvedataApiKey": "string",
"marketstackAccessKey": "string",
"fmpApiKey": "string",
"iexcloudToken": "string",
"cbondApiKey": "string",
"cbondClientId": "string",
"cbondClientSecret": "string",
"googleSearchApiKey": "string",
"googleSearchEngineId": "string",
"bingSearchApiKey": "string",
"enabled": true
}'Response
application/json
{ "id": 0, "name": "string", "description": "string", "provider": "OPENAI", "apiKey": "string", "apiSecret": "string", "organizationId": "string", "projectId": "string", "region": "string", "endpoint": "string", "accessKeyId": "string", "secretAccessKey": "string", "sessionToken": "string", "accountId": "string", "subscriptionId": "string", "resourceGroup": "string", "workspaceName": "string", "huggingFaceToken": "string", "cohereApiKey": "string", "azureAiStudioEndpoint": "string", "mosaicmlApiKey": "string", "replicateApiToken": "string", "twitterBearerToken": "string", "twitterApiKey": "string", "twitterApiSecret": "string", "redditClientId": "string", "redditClientSecret": "string", "redditUserAgent": "string", "facebookAccessToken": "string", "facebookAppId": "string", "facebookAppSecret": "string", "instagramAccessToken": "string", "linkedinAccessToken": "string", "linkedinClientId": "string", "linkedinClientSecret": "string", "tiktokClientKey": "string", "tiktokClientSecret": "string", "youtubeApiKey": "string", "databricksWorkspaceUrl": "string", "databricksAccessToken": "string", "databricksClusterId": "string", "oauthAccessToken": "string", "oauthRefreshToken": "string", "oauthTokenExpiresAt": "2019-08-24T14:15:22Z", "oauthTokenType": "string", "alphavantageApiKey": "string", "polygonApiKey": "string", "twelvedataApiKey": "string", "marketstackAccessKey": "string", "fmpApiKey": "string", "iexcloudToken": "string", "cbondApiKey": "string", "cbondClientId": "string", "cbondClientSecret": "string", "googleSearchApiKey": "string", "googleSearchEngineId": "string", "bingSearchApiKey": "string", "enabled": true }
- Mock serverhttp://docs.webrobot.eu/_mock/openapi/webrobot/api/cloud-credentials/id/{credentialId}
- Productionhttps://api.webrobot.eu/api/webrobot/api/cloud-credentials/id/{credentialId}
- Local developmenthttp://localhost:8020/api/webrobot/api/cloud-credentials/id/{credentialId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
http://docs.webrobot.eu/_mock/openapi/webrobot/api/cloud-credentials/id/550e8400-e29b-41d4-a716-446655440000 \
-H 'X-API-Key: YOUR_API_KEY_HERE'Response
application/json
{ "id": 0, "name": "string", "description": "string", "provider": "OPENAI", "apiKey": "string", "apiSecret": "string", "organizationId": "string", "projectId": "string", "region": "string", "endpoint": "string", "accessKeyId": "string", "secretAccessKey": "string", "sessionToken": "string", "accountId": "string", "subscriptionId": "string", "resourceGroup": "string", "workspaceName": "string", "huggingFaceToken": "string", "cohereApiKey": "string", "azureAiStudioEndpoint": "string", "mosaicmlApiKey": "string", "replicateApiToken": "string", "twitterBearerToken": "string", "twitterApiKey": "string", "twitterApiSecret": "string", "redditClientId": "string", "redditClientSecret": "string", "redditUserAgent": "string", "facebookAccessToken": "string", "facebookAppId": "string", "facebookAppSecret": "string", "instagramAccessToken": "string", "linkedinAccessToken": "string", "linkedinClientId": "string", "linkedinClientSecret": "string", "tiktokClientKey": "string", "tiktokClientSecret": "string", "youtubeApiKey": "string", "databricksWorkspaceUrl": "string", "databricksAccessToken": "string", "databricksClusterId": "string", "oauthAccessToken": "string", "oauthRefreshToken": "string", "oauthTokenExpiresAt": "2019-08-24T14:15:22Z", "oauthTokenType": "string", "alphavantageApiKey": "string", "polygonApiKey": "string", "twelvedataApiKey": "string", "marketstackAccessKey": "string", "fmpApiKey": "string", "iexcloudToken": "string", "cbondApiKey": "string", "cbondClientId": "string", "cbondClientSecret": "string", "googleSearchApiKey": "string", "googleSearchEngineId": "string", "bingSearchApiKey": "string", "enabled": true }
Bodyapplication/jsonrequired
Updated credential data
Provider
Enum"OPENAI""ANTHROPIC""HUGGING_FACE""COHERE""AZURE_AI_STUDIO""MOSAICML""REPLIC""STEEL_DEV""TOGETHERAI""AWS"
- Mock serverhttp://docs.webrobot.eu/_mock/openapi/webrobot/api/cloud-credentials/id/{credentialId}
- Productionhttps://api.webrobot.eu/api/webrobot/api/cloud-credentials/id/{credentialId}
- Local developmenthttp://localhost:8020/api/webrobot/api/cloud-credentials/id/{credentialId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
http://docs.webrobot.eu/_mock/openapi/webrobot/api/cloud-credentials/id/550e8400-e29b-41d4-a716-446655440000 \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_API_KEY_HERE' \
-d '{
"id": 0,
"name": "string",
"description": "string",
"provider": "OPENAI",
"apiKey": "string",
"apiSecret": "string",
"organizationId": "string",
"projectId": "string",
"region": "string",
"endpoint": "string",
"accessKeyId": "string",
"secretAccessKey": "string",
"sessionToken": "string",
"accountId": "string",
"subscriptionId": "string",
"resourceGroup": "string",
"workspaceName": "string",
"huggingFaceToken": "string",
"cohereApiKey": "string",
"azureAiStudioEndpoint": "string",
"mosaicmlApiKey": "string",
"replicateApiToken": "string",
"twitterBearerToken": "string",
"twitterApiKey": "string",
"twitterApiSecret": "string",
"redditClientId": "string",
"redditClientSecret": "string",
"redditUserAgent": "string",
"facebookAccessToken": "string",
"facebookAppId": "string",
"facebookAppSecret": "string",
"instagramAccessToken": "string",
"linkedinAccessToken": "string",
"linkedinClientId": "string",
"linkedinClientSecret": "string",
"tiktokClientKey": "string",
"tiktokClientSecret": "string",
"youtubeApiKey": "string",
"databricksWorkspaceUrl": "string",
"databricksAccessToken": "string",
"databricksClusterId": "string",
"oauthAccessToken": "string",
"oauthRefreshToken": "string",
"oauthTokenExpiresAt": "2019-08-24T14:15:22Z",
"oauthTokenType": "string",
"alphavantageApiKey": "string",
"polygonApiKey": "string",
"twelvedataApiKey": "string",
"marketstackAccessKey": "string",
"fmpApiKey": "string",
"iexcloudToken": "string",
"cbondApiKey": "string",
"cbondClientId": "string",
"cbondClientSecret": "string",
"googleSearchApiKey": "string",
"googleSearchEngineId": "string",
"bingSearchApiKey": "string",
"enabled": true
}'Response
application/json
{ "id": 0, "name": "string", "description": "string", "provider": "OPENAI", "apiKey": "string", "apiSecret": "string", "organizationId": "string", "projectId": "string", "region": "string", "endpoint": "string", "accessKeyId": "string", "secretAccessKey": "string", "sessionToken": "string", "accountId": "string", "subscriptionId": "string", "resourceGroup": "string", "workspaceName": "string", "huggingFaceToken": "string", "cohereApiKey": "string", "azureAiStudioEndpoint": "string", "mosaicmlApiKey": "string", "replicateApiToken": "string", "twitterBearerToken": "string", "twitterApiKey": "string", "twitterApiSecret": "string", "redditClientId": "string", "redditClientSecret": "string", "redditUserAgent": "string", "facebookAccessToken": "string", "facebookAppId": "string", "facebookAppSecret": "string", "instagramAccessToken": "string", "linkedinAccessToken": "string", "linkedinClientId": "string", "linkedinClientSecret": "string", "tiktokClientKey": "string", "tiktokClientSecret": "string", "youtubeApiKey": "string", "databricksWorkspaceUrl": "string", "databricksAccessToken": "string", "databricksClusterId": "string", "oauthAccessToken": "string", "oauthRefreshToken": "string", "oauthTokenExpiresAt": "2019-08-24T14:15:22Z", "oauthTokenType": "string", "alphavantageApiKey": "string", "polygonApiKey": "string", "twelvedataApiKey": "string", "marketstackAccessKey": "string", "fmpApiKey": "string", "iexcloudToken": "string", "cbondApiKey": "string", "cbondClientId": "string", "cbondClientSecret": "string", "googleSearchApiKey": "string", "googleSearchEngineId": "string", "bingSearchApiKey": "string", "enabled": true }
- Mock serverhttp://docs.webrobot.eu/_mock/openapi/webrobot/api/cloud-credentials/id/{credentialId}
- Productionhttps://api.webrobot.eu/api/webrobot/api/cloud-credentials/id/{credentialId}
- Local developmenthttp://localhost:8020/api/webrobot/api/cloud-credentials/id/{credentialId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
http://docs.webrobot.eu/_mock/openapi/webrobot/api/cloud-credentials/id/550e8400-e29b-41d4-a716-446655440000 \
-H 'X-API-Key: YOUR_API_KEY_HERE'- Mock serverhttp://docs.webrobot.eu/_mock/openapi/webrobot/api/cloud-credentials/provider/{provider}
- Productionhttps://api.webrobot.eu/api/webrobot/api/cloud-credentials/provider/{provider}
- Local developmenthttp://localhost:8020/api/webrobot/api/cloud-credentials/provider/{provider}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
http://docs.webrobot.eu/_mock/openapi/webrobot/api/cloud-credentials/provider/aws \
-H 'X-API-Key: YOUR_API_KEY_HERE'Response
application/json
[ { "id": 0, "name": "string", "description": "string", "provider": "OPENAI", "apiKey": "string", "apiSecret": "string", "organizationId": "string", "projectId": "string", "region": "string", "endpoint": "string", "accessKeyId": "string", "secretAccessKey": "string", "sessionToken": "string", "accountId": "string", "subscriptionId": "string", "resourceGroup": "string", "workspaceName": "string", "huggingFaceToken": "string", "cohereApiKey": "string", "azureAiStudioEndpoint": "string", "mosaicmlApiKey": "string", "replicateApiToken": "string", "twitterBearerToken": "string", "twitterApiKey": "string", "twitterApiSecret": "string", "redditClientId": "string", "redditClientSecret": "string", "redditUserAgent": "string", "facebookAccessToken": "string", "facebookAppId": "string", "facebookAppSecret": "string", "instagramAccessToken": "string", "linkedinAccessToken": "string", "linkedinClientId": "string", "linkedinClientSecret": "string", "tiktokClientKey": "string", "tiktokClientSecret": "string", "youtubeApiKey": "string", "databricksWorkspaceUrl": "string", "databricksAccessToken": "string", "databricksClusterId": "string", "oauthAccessToken": "string", "oauthRefreshToken": "string", "oauthTokenExpiresAt": "2019-08-24T14:15:22Z", "oauthTokenType": "string", "alphavantageApiKey": "string", "polygonApiKey": "string", "twelvedataApiKey": "string", "marketstackAccessKey": "string", "fmpApiKey": "string", "iexcloudToken": "string", "cbondApiKey": "string", "cbondClientId": "string", "cbondClientSecret": "string", "googleSearchApiKey": "string", "googleSearchEngineId": "string", "bingSearchApiKey": "string", "enabled": true } ]
- Mock serverhttp://docs.webrobot.eu/_mock/openapi/webrobot/api/html/{url}/{protocol}
- Productionhttps://api.webrobot.eu/api/webrobot/api/html/{url}/{protocol}
- Local developmenthttp://localhost:8020/api/webrobot/api/html/{url}/{protocol}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'http://docs.webrobot.eu/_mock/openapi/webrobot/api/html/{url}/{protocol}' \
-H 'X-API-Key: YOUR_API_KEY_HERE'- Mock serverhttp://docs.webrobot.eu/_mock/openapi/api/strapi-tables/{table}/{id}
- Productionhttps://api.webrobot.eu/api/api/strapi-tables/{table}/{id}
- Local developmenthttp://localhost:8020/api/api/strapi-tables/{table}/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'http://docs.webrobot.eu/_mock/openapi/api/strapi-tables/{table}/{id}' \
-H 'X-API-Key: YOUR_API_KEY_HERE'- Mock serverhttp://docs.webrobot.eu/_mock/openapi/api/strapi-tables/{table}/{id}
- Productionhttps://api.webrobot.eu/api/api/strapi-tables/{table}/{id}
- Local developmenthttp://localhost:8020/api/api/strapi-tables/{table}/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'http://docs.webrobot.eu/_mock/openapi/api/strapi-tables/{table}/{id}' \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_API_KEY_HERE' \
-d '{
"property1": {},
"property2": {}
}'- Mock serverhttp://docs.webrobot.eu/_mock/openapi/api/strapi-tables/{table}/{id}
- Productionhttps://api.webrobot.eu/api/api/strapi-tables/{table}/{id}
- Local developmenthttp://localhost:8020/api/api/strapi-tables/{table}/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'http://docs.webrobot.eu/_mock/openapi/api/strapi-tables/{table}/{id}' \
-H 'X-API-Key: YOUR_API_KEY_HERE'- Mock serverhttp://docs.webrobot.eu/_mock/openapi/api/strapi-tables/{table}
- Productionhttps://api.webrobot.eu/api/api/strapi-tables/{table}
- Local developmenthttp://localhost:8020/api/api/strapi-tables/{table}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'http://docs.webrobot.eu/_mock/openapi/api/strapi-tables/{table}?page=0&pageSize=50' \
-H 'X-API-Key: YOUR_API_KEY_HERE'- Mock serverhttp://docs.webrobot.eu/_mock/openapi/api/strapi-tables/{table}
- Productionhttps://api.webrobot.eu/api/api/strapi-tables/{table}
- Local developmenthttp://localhost:8020/api/api/strapi-tables/{table}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'http://docs.webrobot.eu/_mock/openapi/api/strapi-tables/{table}' \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_API_KEY_HERE' \
-d '{
"property1": {},
"property2": {}
}'- Mock serverhttp://docs.webrobot.eu/_mock/openapi/health
- Productionhttps://api.webrobot.eu/api/health
- Local developmenthttp://localhost:8020/api/health
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
http://docs.webrobot.eu/_mock/openapi/health \
-H 'X-API-Key: YOUR_API_KEY_HERE'