Sign in

v1

latestOpenAPI 3.1.02026-07-22106199311.5 KB
Connections

Retrieve a page of connection overrides which apply in a specific environment.

get/v1/projects/{projectId}/connections/environment-overrides

Path parameters

projectIdstring required

The unique identifier of the project for which the connections will be listed.

Query parameters

environmentNamestring required

The name of the environment to list which connection overrides are applied in.

{"stackTrail":"paths:/v1/projects/{projectId}/connections/environment-overrides:get:parameters:2:schema","oasType":"schema","type":"unknown"}

Page number (0-indexed)

{"stackTrail":"paths:/v1/projects/{projectId}/connections/environment-overrides:get:parameters:3: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'

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'DWH' | 'COMPONENT_BASIC' | 'CLOUD_PLATFORM_CREDENTIALS'

The platform connection type

projectIdstring uuid

The project ID this connection belongs to

Example response

{
  "authProvider": "NONE",
  "authType": "GENERIC_SECRET",
  "connectionOverrides": {
    "connectionProperties": {
      "credentialSecretName": "aws-platform-credentials"
    }
  },
  "name": "my-jira-connection",
  "platformConnectionType": "COMPONENT_BASIC"
}