Connections

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

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

Request

  • Base URL
    https://eu1.api.matillion.com/dpc
  • URL
    https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/connections/environment-overrides
  • Auth
    HTTP bearer

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.

pageunknown

Page number (0-indexed)

sizeunknown

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

Changes

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