Update Source

Update an existing source.

The SourceUpdate Model is defined by the SourceUpdateGCS or SourceUpdateS3 class, based on the source type.

Parameters:

  • source_id: UUID of the source to update.

  • payload: Instance of SourceUpdate model which can be any one of the following based on source type:

    • SourceUpdateGCS
      • type: Literal, Source Type GCS.
      • params: SourceGCSParams object or None. Parameters for GCS source.
      • credentials: GCPCredentials object or None. Credentials for GCS source.
    • SourceUpdateS3
      • type: Literal, Source type S3.
      • params: SourceS3Params object or None. Parameters for S3 source.
      • credentials: AWSCredentials object or None. Credentials for AWS source.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Updates an existing source and returns it. The body's type selects the kind of source, and params and credentials hold the new settings.

When to use it

Use it to rotate a source's credentials or change its parameters without recreating it.

Required parameters

  • source_id (path): the ID of the source.
  • Request body: a source update object with type and the params or credentials to change.

Response

A successful call returns 200 OK with the source: its id, name, type, params, created_by, and timestamps.

Related: Get a source, Test a source connection, Delete a source

Path Params
uuid
required
Body Params
Responses

404

Not Found

500

Internal Server Error

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json