REredis
secure
sources

Upsert Source By Name

Changed on

Upserts a source in RDI settings by its name.

put/api/v1/pipelines/sources/{name}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/pipelines/sources/{name}
  • Auth
    HTTP bearer

Path parameters

namestring required

Request body

object required

Example request

{
  "type": "cdc",
  "logging": {
    "level": "debug"
  },
  "connection": {
    "type": "mysql",
    "host": "${HOST_IP}",
    "port": 3306,
    "database": "new_schema",
    "user": "${secret:local-vault:credentials:user}",
    "password": "${secret:local-vault:credentials:password}"
  }
}

Response

Successful Response

action_idstring nullable

Example response

{
  "action_id": "1234567890"
}

Changes

  • 38675c1371b2Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      removed from the response body anyOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

  • f0a3d26cc0c6Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      removed the non-success response with the status