PostgreSQL record

action={action}

(Required) Specify create, update, delete (using POST) or list (using GET or POST). See List Auth Records for type

echo_request={0|1}

(Optional) Specify 1 to view (echo) input parameters in the XML output. By default these are not included.

ids={value}

(Required to update or delete record) Record IDs to update/delete. Specify record IDs and/or ID ranges (for example, 1359-1407). Multiple entries are comma separated.

title={value}

(Required to create record) A title for the record. The title must be unique. Maximum 255 characters (ascii).

comments={value}

(Optional to create or update record) User defined comments. Maximum of 1999 characters.

PostgreSQL

pgsql_win_conf_file={value}

(Optional) The full path to the PostgreSQL configuration file on your Windows assets (IP addresses). The file must be in the same location on all assets for this record.

pgsql_unix_conf_file={value}

(Optional) The full path to the PostgreSQL configuration file on your Unix assets (IP addresses). The file must be in the same location on all assets for this record.

pgsql_db_name={value}

(Required to create record) The database instance you want to authenticate to.

port={value}

(Optional) The port where the database instance is running. Default is 5432.

ssl_verify={0|1}

(Optional) SSL verification is skipped by default. Set to 1 if you want to verify the server’s certificate is valid and trusted.

hosts={value}

(Required if ssl_verify=1) A list of FQDNs for all host IP addresses on which a custom SSL certificate signed by a trusted root CA is installed.

Login Credentials

username={value}

(Required to create record, optional to update record) The username of the account to be used for authentication. If password is specified this is the username of a PostgreSQL account. If login_type=vault is specified, this is the username of a vault account. Maximum 255 characters (ascii).

password={value}

(To create record password or login_type=vault is required) The password of the PostgreSQL account to be used for authentication. Maximum 100 characters (ascii).

login_type=vault

(To create record password or login_type=vault is required) Set to vault if a third party vault will be used to retrieve password. Vault parameters need to be provided in the record.

Click here for vault parameters

Keys, Passphrase

client_key_type={value}

(Optional) Client key type basic (default) or vault.

client_key={value}

(Optional if client_key_type=basic) Client key content, if private key not in vault.

client_key_vault_type={value}

(Required if client_key_type=vault) The third party vault to be used to retrieve the private key. Certain vaults support this capability.

client_key_vault_id={value}

(Required if client_key_type=vault) The ID of the vault to get the private key from.

Vault parameters: client_key_folder={value} and client_key_file={value} are required vault settings.

passphrase_type={value}

(Optional) Passphrase type can be basic (default) or vault.

passphrase={value}

(Optional if passphrase_type=basic) The passphrase value.

client_cert={value}

(Optional if passphrase_type=basic) The passphrase certificate content.

passphrase_vault_type={value}

(Required if passphrase_type=vault) The vault where the private key passphrase is stored. For example CA Access Control, CyberArk AIM, Thycotic Secret Server.

passphrase_vault_id={value}

(Required if passphrase_type=vault) The ID of the vault to get the passphrase from.

Target Hosts

ips={value}

(Required to create record) The IP address(es) the server will log into using the record’s credentials. Multiple entries are comma separated.

(Optional to update record) IPs specified will overwrite existing IPs in the record, and existing IPs will be removed.

This parameter and the add_ips parameter or the remove_ips parameter cannot be specified in the same request.

add_ips={value}

(Optional to update record) Add IPs and/or ranges to the IPs list for this record. Multiple IPs/ranges are comma separated.

This parameter and the ips parameter cannot be specified in the same request.

remove_ips={value}

(Optional to update record) IPs to be removed from your record. You may enter a combination of IPs and ranges. Multiple entries are comma separated.

This parameter and the ips parameter cannot be specified in the same request.

network_id={value}

(Optional to create or update record, and valid when the networks feature is enabled) The network ID for the record.