Skip to content
impulseDOCS
Get Started

Get Postgres service metadata and capabilities

GET
/v1/projects/{project_id}/services/{service_id}
curl --request GET \
  --url 'https://api-dev.impulsehosting.com/v1/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/services/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0?live=false' \
  --header 'Authorization: Bearer <token>'

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

Query Parameters

Section titled “Query Parameters”
live
boolean

Include the safe live health projection.

Responses

Section titled “Responses”

200

Section titled “200”

Service

Media typeapplication/json
object
id
required
string format: uuid
project_id
required
string format: uuid
type
required
string
Allowed value: postgres
plan
required
string
name
required
string
status
required
string
endpoint
string
capabilities
object
live
object
enabled
boolean
reveal_credential
object
enabled
boolean
actions
Array<object>
object
name
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
label
required
string
enabled
required
boolean
scopes
Array<string>
reason
string
live
object
key
additional properties
any
Example
{
  "type": "postgres",
  "capabilities": {
    "actions": [
      {
        "name": "credential_connectivity"
      }
    ]
  }
}

404

Section titled “404”

Resource not found

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