Sign in

v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB
Vault Proxy Connections

Create a connection

Saves the connection data and returns connection with ID.

post/token/connections

Request body

namestring required

Name of the connection.

descriptionstring

Description of the connection.

connectionType'inbound' | 'outbound' required

Defines the category of the connection. Once a connection is created, this value is fixed and cannot be modified. You can find more information about types of connections in guide.

Response

Details about connection.

namestring required

Name of the connection.

descriptionstring

Description of the connection.

connectionType'inbound' | 'outbound' required

Defines the category of the connection. Once a connection is created, this value is fixed and cannot be modified. You can find more information about types of connections in guide.

idstring

Internal facing connection identifier.

liveVersionIdstring nullable

Each connection has multiple versions (connectionVersions) that include configurations. At any given time, only one version can be live for a connection. This field specifically stores the version that is live for a particular connection. If liveVersionId is set to null it means connection is not live.

workspaceIdstring

ID of the workspace to which the connection belongs.

updatedAtstring date-time

Date and time when the connection was last updated.

createdAtstring date-time

Date and time when the connection was created.

deletedAtstring date-time nullable

Date and time when the connection was deleted. Null if the connection is not deleted.

Example response

{
  "updatedAt": "2025-03-11T09:31:52.131176Z",
  "createdAt": "2025-03-11T09:31:52.131176Z",
  "deletedAt": "2025-03-11T09:31:52.131176Z"
}