Skip to main content
POST
/
api
/
datamirroring
Create
curl --request POST \
  --url https://aiapi.{client}.nx1cloud.com/api/datamirroring \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "job_type": "<string>",
  "job_name": "<string>",
  "dbtype": "<string>",
  "include_list": "<string>",
  "host_name": "<string>",
  "port": 123,
  "user": "<string>",
  "password": "<string>",
  "dbname": "<string>",
  "source": "<string>",
  "destination": "<string>",
  "properties_json": "<string>",
  "schedule": "<string>",
  "schemas": "<string>"
}
'
{
  "job_type": "<string>",
  "job_name": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "source": "<string>",
  "destination": "<string>",
  "properties_json": "<string>",
  "schedule": "<string>"
}

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 type of database to be mirrored. (Accepted Values: postgres, mariadb, mssql, mysql, oracle, 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 database being used.

​
source
string | null

Indicates where the data originates.

​
destination
string | null

Specifies where the data or output is sent or stored.

​
properties_json
string | null

Additional job properties in JSON format.

​
schedule
string | null

The cron expression that specifies how often the job must be executed.

​
schemas
string | null

The database schema name to be replicated. 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

Timestamp when the job was created.

​
source
string | null

Indicates where the data originates.

​
destination
string | null

Specifies where the data or output is sent or stored.

​
properties_json
string | null

Additional job properties in JSON format.

​
schedule
string | null

The cron expression that specifies how often the job must be executed.