getApiKey
POST {{pgbc_server}}/cgi-bin/pgbc_api/get_api_key?instance={{instance_name}}&password={{instance_password}}&port={{instance_port}}&server={{instance_node}}
The endpoint {{pgbc_server}}/cgi-bin/pgbc_api/get_api_key is a POST request that is used to retrieve an API key. It requires the following query parameters:
- instance: (string) The instance name
- password: (string) The instance password
- port: (string) The instance port
- server: (string) The instance node
The response to this request is a JSON object with the following schema:
json
{
"api_key": ""
}
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
instance | string | OmniIndex PGBC instance or schema name | |
password | string | OmniIndex PGBC instance or schema password | |
port | string | OmniIndex PGBC instance port (default 5434) | |
server | string | OmniIndex PGBC instance node |
RESPONSES
status: OK
{"api_key":"UE9TVEdSRVNCQ2luc3RhbmNlPWxP62bvZ2dlckBvbW5paW5kZXguaW8m12G2ccGFzc3dvcmQ9b127B2G9nZ2VyQG9tbmlpbmRlP722eC5pbyZzZXJ2ZXI9bG9ncy5wZ2JjLmluZm8mcG9ydD01NDM0UEdCQw=="}