Continuent Documentation

Manual Home
Tungsten Replicator 7.1 Manual
Page in Other Manuals
Tungsten Replicator 7.0 Manual
Tungsten Clustering (for MySQL) 6.1 Manual
Tungsten Replicator 6.1 Manual
Tungsten Clustering (for MySQL) 7.0 Manual
Tungsten Clustering (for MySQL) 8.0 Manual
Tungsten MI (TMI)
Tungsten Replicator 8.0 Manual
Tungsten Clustering (for MySQL) 7.1 Manual
Breadcrumbs
> Tungsten Replicator 7.1 Manual

       > 10. Tungsten REST APIv2

       > 10.1. Getting Started with Tungsten REST API
Chapters
Preface
1. Introduction
2. Deployment Overview
3. Deploying MySQL Extractors
4. Deploying Appliers
5. Deployment: Advanced
6. Deployment: Security
7. Operations Guide
8. Command-line Tools
9. The tpm Deployment Command
10. Tungsten REST APIv2
11. Replication Filters
12. Performance and Tuning
A. Release Notes
B. Prerequisites
C. Troubleshooting
D. Files, Directories, and Environment
E. Terminology Reference
F. Internals
G. Frequently Asked Questions (FAQ)
Navigate Up
10.1. Getting Started with Tungsten REST API
Parent Sections
10.1.2. How to Access the API
10.1.3. Data Structures
10.1.4. Summary of all API TPM options
10.1.4. Summary of all API TPM options
Prev  ^Up10.1. Getting Started with Tungsten REST API Next

10.1.4. Summary of all API TPM options

10.1.4. User Management Options
10.1.4. Replicator Options

The following is a summary of all of the tpm options for controlling the various API settings:

User Management Options

Parameter

Description

Default Value

rest-api-admin-user

Specify the initial Admin User Name for API access.

 
rest-api-admin-pass, rest-api-admin-password

Specify the initial Admin User Password for API access. rest-api-admin-password alias only available from version 7.1.2 onwards.

 

Replicator Options

Parameter

Description

Default Value

replicator-rest-api

Enable or Disable the API.

true when disable-security-controls=true or not defined.

replicator-rest-api-ssl

Enable or Disable SSL

true when disable-security-controls=true or not defined.

replicator-rest-api-address

Address for the API to bind to

127.0.0.1

replicator-rest-api-port

Port for the Replicator API

8097

replicator-rest-api-authentication

Enforce authentication for the API

true

Prev Up Next
10.1.3. Data Structures  ^Level 10.2. Replicator API Specifics
Copyright © 2025 Continuent, Ltd.1 (415) 529-4901Terms of UsePrivacy & CookiesLegal NoticeExhibits