Site Instance Databases

Retrieves database connection credentials for the specified site instance.

get/site-instances/{siteId}.{environmentId}/database/connection

Request

Base URL
https://api.acquia.com/v3
Auth
HTTP bearer
TypeScript
https://skmtc.dev/acquia/apis/acquia-cloud-platform-api/docs/site-instances/:siteId.:environmentId/database/connection/get.ts
A function with typed inputs. Its response is checked against the schema.

siteIdstring required

Unique identifier for the site.

environmentIdstring required

Unique identifier for the environment.

Database connection credential details

db_hoststring required

The database host.

namestring required

The database name.

passwordstring required

The database password.

user_namestring required

The database username.

ssh_hoststring required

The SSH host for tunneling to the database.

_embeddedobject

Embedded resources (optional)

{
  "_links": {
    "self": {
      "href": "https://api.acquia.com/v3/resources/1"
    }
  }
}

No recorded changes to this operation across all 1 revision of this API.