10.1.4. Summary of all API TPM options

10.1.4. Summary of all API TPM options
Prev	^Up	10.1. Getting Started with Tungsten REST API	Next

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

Parameter	Description	Default Value
`rest-api-admin-user`	Specify the initial Admin User Name for API access. This property is mandatory, and failure to supply will cause tpm install to fail with a warning.
`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. This property is mandatory, and failure to supply will cause tpm install to fail with a warning.

Parameter

Description

Default Value

rest-api-admin-user

Specify the initial Admin User Name for API access.

This property is mandatory, and failure to supply will cause tpm install to fail with a warning.

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.

This property is mandatory, and failure to supply will cause tpm install to fail with a warning.

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

Parameter	Description	Default Value
`rest-apis`	Enable or Disable the API for all components. Setting this property will have the same affect as setting `replicator-rest-api`.	true when `disable-security-controls=true` or not defined.
`rest-api-ssl`	Enable or Disable SSL for all components Setting this property will have the same affect as setting `replicator-rest-api-ssl`.	true when `disable-security-controls=true` or not defined.
`rest-api-address`	Address for the API to bind to for all components Setting this property will have the same affect as setting `replicator-rest-api-address`.	127.0.0.1
`rest-api-authentication`	Enforce authentication for the API for all comnponents Setting this property will have the same affect as setting `replicator-rest-api-authentication`.	true

Prev	Up	Next
10.1.3. Data Structures	^Level	10.2. Replicator API Specifics