Delete PostgreSQL user

This function deletes a PostgreSQL® user.

Important:

When you disable the PostgreSQL role, the system disables this function.

SecurityBasicAuth

Request

query Parameters

name

required

string

The PostgreSQL user's name.

Example: name=example

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/Postgresql/delete_user

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Postgresql \
  delete_user \
  name='example'

Response samples

application/json

{"apiversion": 3,
"func": "delete_user",
"module": "Postgresql",
"result": {"data": null,
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}