Skip to main content
POST
Create

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
job_type
string
required

Defines the category of job. (Valid values: airflow.dataeng, airflow.nlp, airflow.ingest, mirror).

job_name
string
required

Specifies the name of the job.

dbtype
string
required

The database type to mirror. Accepted values: postgres, mariadb, mssql, mysql, oracle, or db2.

include_list
string
required

The table name inside the schema. Format: .

(For example, public.employees).

host_name
string
required

The URL to connect to the database. Must be accessible to the rapid platform.

port
integer
required

The network port used for the connection.

user
string
required

The username for accessing the database.

password
string
required

The password corresponding to the user.

dbname
string
required

The name of the source database.

source
string | null

Indicates where the data originates.

destination
string | null

Specifies the data or output destination.

properties_json
string | null

Additional job properties in JSON format.

schedule
string | null

The cron expression that specifies how often the job runs.

schemas
string | null

The database schema name to replicate. Leave empty if dbtype is mysql or mariadb.

Response

Data Mirror submitted successfully.

job_type
string
required

Defines the category of job. (Valid values: airflow.dataeng, airflow.nlp, airflow.ingest, mirror).

job_name
string
required

Specifies the name of the job.

id
string<uuid>
required

The unique ID of the created job.

status
string
required

The current status of the job immediately after creation.

created_at
string<date-time>
required

Job creation timestamp.

source
string | null

Indicates where the data originates.

destination
string | null

Specifies the data or output destination.

properties_json
string | null

Additional job properties in JSON format.

schedule
string | null

The cron expression that specifies how often the job runs.