logo

Internal Connections

You can use the internal connections endpoint to send a POST request to create an internal connection between your application and database hosted on Kinsta. This request can be done from your terminal or using an automated script or CI/CD pipeline (e.g. CircleCI, Jenkins, etc.).

You can obtain the id from the applications endpoint.

Create an internal connection

SecuritybearerAuth
Request
path Parameters
id
required
string <uuid>
Example: 54fb80af-576c-4fdc-ba4f-b596c83f15a1
Request Body schema: application/json
required
target_type
required
string

type of the resource to connect to

Enum: "appResource" "dbResource" "envResource"
target_id
required
string <uuid>
Responses
200

Internal connection created successfully

401

No or invalid API key provided to the request

500

Error occurred while creating the connection

post/applications/{id}/internal-connections
Request samples
application/json
{
  • "target_type": "dbResource",
  • "target_id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1"
}
Response samples
application/json
{
  • "result": "success"
}
➔ Next to Application CDN