Sign in

v1

latestOpenAPI 3.1.02026-07-22106199311.5 KB
Connections

Retrieve a page of project connections, optionally filtered by parameters.

get/v1/projects/{projectId}/connections

Path parameters

projectIdstring required

The unique identifier of the project where the connection will be created

Query parameters

authProviderstring[]

A comma separated list of auth providers. If specified alongside 'platformConnectionType', they act as an AND filter, so only connections that match one of the specified platform connection types and one of the specified providers will be returned.

connectionNamesstring[]

Comma-separated list of connection names whose overrides are to be deleted from this environment. Its important to note that specifying too many connection names may exceed URL length limits and result in a 400 Bad Request response. Consider splitting large deletions into multiple requests.

{"stackTrail":"paths:/v1/projects/{projectId}/connections:get:parameters:3:schema","oasType":"schema","type":"unknown"}

Page number (0-indexed)

{"stackTrail":"paths:/v1/projects/{projectId}/connections:get:parameters:4:schema","oasType":"schema","type":"unknown"}

Number of records per page (from 1 to 100)

Response

Successfully retrieved connection

authProviderstring

The authentication provider

authType'GENERIC_SECRET' | 'CLOUD_PROVIDER_SECRET' | 'OAUTH_USER_TOKENS' | 'OAUTH_AUTHORIZATION_CODE' | 'OAUTH_CLIENT_CRED' | 'COMPOSITE_TOKEN' | 'OAUTH_1_0_X_ADS'

The authentication type

createdBystring

The user who created the connection

createdDatestring date-time

The date and time when the connection was created

namestring

The name of the connection

platformConnectionType'COMPONENT_BASIC' | 'CLOUD_PLATFORM_CREDENTIALS'

The different types of connection that can be created:

  • COMPONENT_BASIC — connect a component to a data source, API, or SaaS application using a secret stored in your secrets manager.
  • CLOUD_PLATFORM_CREDENTIALS — give a project access to a cloud provider (AWS, Azure, GCP) using cloud credentials stored in your secrets manager.
projectIdstring uuid

The project ID this connection belongs to

Example response

{
  "authProvider": "salesforce",
  "authType": "GENERIC_SECRET",
  "connectionDetails": {
    "connectionProperties": {
      "credentialSecretName": "aws-platform-credentials"
    }
  },
  "name": "my-secret",
  "platformConnectionType": "COMPONENT_BASIC"
}