Create a Postgres peer - PeerDB Docs: Setup your ETL in minutes with SQL.

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
}'

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",
			"ssh_config": {
				"host":"1.2.3.4",
				"port":22,
				"user":"ubuntu",
				"private_key":"***"
			}
		}
	}
}'

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

{
	"status": "FAILED",
	"message": "POSTGRES peer pg_peer_via_api was invalidated: failed to create ssh tunnel: no authentication methods provided"
}

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
}'

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",
			"ssh_config": {
				"host":"1.2.3.4",
				"port":22,
				"user":"ubuntu",
				"private_key":"***"
			}
		}
	}
}'

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

{
	"status": "FAILED",
	"message": "POSTGRES peer pg_peer_via_api was invalidated: failed to create ssh tunnel: no authentication methods provided"
}

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

object

required

Configuration of the peer to be created.

Show peer

string

required

The name of the peer to be created.

required

The type of peer to be created. The value for Postgres is 3.

object

required

Postgres config

Show postgres_config

string

required

Host of the PG server.

number

required

Port on which the PG server is running. Ex: 5432

string

required

The user to connect to the PG server.

string

required

The password associated with the user.

string

required

The database to connect to.

object

Configuration for SSH tunneling

Show ssh_config

string

required

The host of the SSH server.

number

required

The port on which the SSH server is running.

string

required

The user to connect to the SSH server.

string

The password associated with the user.

string

required

The private key as a string to connect to the SSH server.

boolean

Whether you wish to update a peer with this name if it already exists. Default is false.

Response Fields

CREATED|FAILED

Whether the creation/update was successful. If yes, the value will be CREATED. Else it will be FAILED.

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
}'

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",
			"ssh_config": {
				"host":"1.2.3.4",
				"port":22,
				"user":"ubuntu",
				"private_key":"***"
			}
		}
	}
}'

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

{
	"status": "FAILED",
	"message": "POSTGRES peer pg_peer_via_api was invalidated: failed to create ssh tunnel: no authentication methods provided"
}

​Request Fields

​Response Fields

Request Fields

Response Fields