post
https://api.superwise.ai/v1/sources
Create a new source.
The SourceCreate model is defined by either the SourceCreateGCS, SourceCreateAzure or
SourceCreateS3 classes, based on the source type.
Parameters:
- source_id: UUID of the source.
- payload: Instance of SourceCreate model which can be any one of the following based on source type:
- SourceCreateGCS
- type: Literal, Source Type GCS.
- params: SourceGCSParams object or None. Parameters for GCS source.
- credentials: GCPCredentials object or None. Credentials for GCS source.
- Validation is applied on the
credentialsfield based on the hosting type.
- SourceCreateAzure
- type: Literal, Source type AZURE_BLOB_STORAGE.
- params: SourceAzureParams object. Parameters for Azure source.
- credentials: AzureCredentials object. Credentials for Azure source.
- SourceCreateS3
- type: Literal, Source type S3.
- params: SourceS3Params object. Parameters for S3 source.
- credentials: AWSCredentials object. Credentials for AWS source.
- SourceCreateGCS
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Creates a source, the connection SUPERWISE uses to pull your data. The body's type selects the kind of source, GCS, S3, AZURE_BLOB_STORAGE, or POSTGRESQL, and params and credentials hold its settings.
When to use it
Use it to connect a bucket or database, then link it to a dataset with Create a dataset source.
Required parameters
- Request body: a source object with
name,type,params, and, depending on the type,credentials.
Response
A successful call returns 201 Created with the source: its id, name, type, params, created_by, and timestamps.
Related: Create a dataset source, Test a source connection, List sources, Update a source
Not Found
Internal Server Error