VERIFIED SOLUTION i
X

Vault REST API properties file

UPDATED: September 7, 2017


As of Vault 7.2 these are the default settings for the Vautl REST API properties file.  A Sample file is also included at the bottom of this article

Vault REST API properties file
The Vault REST properties file defines some operational values that the Vault REST service
requires. The format of the file is:
Property_name=property_value
The following table lists the available properties and its default value:
Property Name Description Default Value
vault.hostname Host name or IP address of the Vault
connection that the Vault REST API
uses
127.0.0.1
vault.portnumber Port number that the Vault REST API
will use to connect to the Vault server.
6003
vault.rest.sslconnection SSL connection flag; true enables SSL
connection and false for non-SSL
connection.
false
vault.rest.certificate.truststoreFilePath File path to the trust store:
Default: C:/Program Files (x86)/Java/jdk1.8.0_25/jre/
lib/security/cacerts
vault.rest.certificate.truststorePw Password of Java trust store changeit
(default)
vault.rest.certificate.keystoreFilePath File path to the key store
Defaul: C:/Program Files (x86)/Java/jdk1.8.0_25/jre/
lib/security/cacerts
vault.rest.certificate.keystorePw Password of Java keystore changeit
(default)
vault.rest.certificate.keyPw Password of keys file changeit
(default)
Vault REST API installation
11
vault.defaultPageno Results page number used when a
results page number is not specified
by the requestor.
Note: this is not related to document
page number.
1
vault.defaultPagesize The number of results that will be
returned in response to a query when
a pagesize is not specified in a query.
Note: this is not related to a
document page size.
10
vault.defaultPDFPageCount The default maximum page count for
PDF files created.
1000
vault.defaultReprintStartpage The starting page in a document
reprint.
1
vault.defaultReprintTotalpages The maximum number of pages that
will be included in a document
reprint starting from the
vault.defaultReprintStartpage.
1000
vault.defaultDocumentMaxhits The maximum number of results that
will be returned from a document or
account query. This is also the
maximum number of records that will
be used for consolidating document
records into folders for folder based
queries.
1000
vault.defaultDocumentFolder
Maxhits
The maximum number of document
records that will be used when
consolidating documents records into
folders for folder based queries.
1000
vault.defaultDocumentFolder
MaxhitsOutput
This is the maximum number of
folders that will be returned in a
folder based query.
1000
vault.sortlocale This is the locale used when arranging
the display order of folders and
documents within folders.
en-CA
Vault REST API installation
12
Vault REST properties file sample lines
Sample properties entries (using all default values)
#####################################
#for Vault servers
#Vault Render IP address or host
name vault.hostname=127.0.0.1
#Vault Render port number
vault.portnumber=6003
#####################################
vault.rest.sslconnection=true
vault.rest.certificate.keystoreFilePath=C:/Program Files
(x86)/Java/jdk1.8.0_25/jre/lib/security/cacerts
vault.rest.certificate.keystorePw=changeit
vault.rest.certificate.keyPw=<password>
vault.rest.certificate.truststoreFilePath=C:/Program Files
(x86)/Java/jdk1.8.0_25/jre/lib/security/cacerts
vault.rest.certificate.truststorePw=changeit
# URL pagination control
#default URL page number vault.defaultPageno=1
#default URL page size
vault.defaultPagesize=10
######################################
#PDF rendering control :
# maximum number of pages allowed in a generated PDF file
vault.defaultPDFPageCount=1000
#############################
# reprint control
# starting page when reprinting
document
vault.defaultReprintStartpage=1
# maximum total page count when reprinting document
vault.defaultReprintTotalpages=1000
#####################
#####################################

Downloads

  • No Downloads