Vault Proxy Connections

Delete a connection

Soft-delete a connection by marking it as deleted. Only connections without an active (live) version can be deleted.

delete/token/connections/{connectionId}

Request

Base URL
https://api.staging.payrails.io
Auth
HTTP bearer
TypeScript
https://skmtc.dev/payrails/apis/payrails-api-reference/docs/token/connections/:connectionId/delete.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

connectionIdstring uuid required

Identifier of the resource in Payrails.

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"
}

Changes

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