Skip to main content
POST api/v1/peers/create
Here is the request and response format for creating a Postgres peer. SSH tunneling is optional for peer creation.

​
Request Fields

​
peer
object
required
Configuration of the peer to be created.
​
allow_update
boolean
Whether you wish to update a peer with this name if it already exists. Default is false.

​
Response Fields

​
status
CREATED|FAILED
Whether the creation/update was successful. If yes, the value will be CREATED. Else it will be FAILED.
​
message
string
Error message if any
curl --request POST \
  --url http://localhost:3000/api/v1/peers/create \
  --header 'Authorization: Basic OmJsYWNrU3dhbpEyMw==' \
  --header 'Content-Type: application/json' \
  --data '{
	"peer": {
		"name": "pg_peer_via_api",
		"type": 3,
		"postgres_config": {
			"host": "localhost",
			"port": 5432,
			"user": "postgres",
			"password": "postgres",
			"database": "postgres"
		}
	},
	"allow_update":false
}'

{
	"status": "CREATED",
	"message": ""
}