Skip to content
impulseDOCS
Get Started

Invoke a capability-advertised Postgres action

POST
/v1/projects/{project_id}/services/{service_id}/actions/{action}
curl --request POST \
  --url https://api-dev.impulsehosting.com/v1/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/services/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/actions/credential_connectivity \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

The request body depends on action. Use x-impulse-postgres-actions and the referenced body_schema, and treat the service capabilities response as the runtime source of truth.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
project_id
required
string format: uuid
service_id
required
string format: uuid
action
required
string
Allowed values: credential_connectivity list_backups prepare_backup_download prepare_database_export list_ip_allowlist list_extensions add_ip remove_ip reset_password kill_connections rename_database backup_now restore_backup migration_test_source migration_begin enable_extension disable_extension pg_upgrade_cancel list_version_targets shared_version_migration_request service_health list_replicas queries_running query_cancel query_terminate query_stats postgres_logs pgbouncer_enable pgbouncer_disable pool_users_list pool_user_create pool_user_rotate pool_user_delete pg_upgrade_preview pg_upgrade_request add_replica delete_replica promote_replica

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
key
additional properties
any
Examplegenerated
{}

Responses

Section titled “Responses”

200

Section titled “200”

Customer-safe action result

Media typeapplication/json
object
action
required
string
Allowed values: credential_connectivity list_backups prepare_backup_download prepare_database_export list_ip_allowlist list_extensions add_ip remove_ip reset_password kill_connections rename_database backup_now restore_backup migration_test_source migration_begin enable_extension disable_extension pg_upgrade_cancel list_version_targets shared_version_migration_request service_health list_replicas queries_running query_cancel query_terminate query_stats postgres_logs pgbouncer_enable pgbouncer_disable pool_users_list pool_user_create pool_user_rotate pool_user_delete pg_upgrade_preview pg_upgrade_request add_replica delete_replica promote_replica
status
required
string
Allowed values: ok healthy degraded unknown error
message
string
result
object
key
additional properties
any
Example
{
  "action": "credential_connectivity",
  "status": "ok"
}

400

Section titled “400”

Invalid action body

Media typeapplication/json
object
error
required
string
Examplegenerated
{
  "error": "example"
}

403

Section titled “403”

Scope or project binding denied

Media typeapplication/json
object
error
required
string
Examplegenerated
{
  "error": "example"
}

404

Section titled “404”

Resource not found

Media typeapplication/json
object
error
required
string
Examplegenerated
{
  "error": "example"
}

409

Section titled “409”

Action unavailable for current service state or plan

Media typeapplication/json
object
error
required
string
Examplegenerated
{
  "error": "example"
}