Get Connection

Endpoint

GET /apiops/projects/{projectName}/connections/{connectionName}/

Authentication

Requires a Personal API Access Token.

Header

Authorization: Bearer YOUR_TOKEN

Request

Headers

Header	Value	Required
Authorization	Bearer {token}	Yes

Path Parameters

Parameter	Type	Required	Description
projectName	string	Yes	Project name
connectionName	string	Yes	Connection name

Query Parameters

None

Response

Success Response (200 OK)

{
  "status": "SUCCESS",
  "resultList": [
    {
      "type": "email",
      "name": "my-email-connection",
      "description": "Email connection for notifications",
      "deployToWorker": true,
      "enabled": true,
      "host": "smtp.gmail.com",
      "port": 587,
      "username": "user@example.com",
      "enableStartTls": true,
      "auth": true,
      "defaultEncoding": "UTF-8",
      "addressToTest": "test@example.com",
      "from": "noreply@example.com",
      "additionalProperties": []
    }
  ],
  "resultCount": 1
}

Response Fields

Field	Type	Description
status	string	Response status: SUCCESS or FAILURE
resultList	array	List containing single connection object
resultCount	integer	Always 1 for get operation

Connection Object Fields (Common)

Field	Type	Description
type	string	Connection type discriminator field. Identifies the connection type in API responses.
name	string	Connection name
description	string	Connection description
deployToWorker	boolean	Whether to deploy to worker
enabled	boolean	Whether connection is enabled

Note: Connection-specific fields vary by connection type. Secret fields (password, passphrases, API keys, certificate/keystore files) are omitted from the response — the same masking the list endpoint applies. A stored secret is never readable back through the API; to change one, send the new value with Update Connection.

Error Response (400 Bad Request)

{
  "status": "FAILURE",
  "resultMessage": "Connection name can not be empty!"
}

Error Response (401 Unauthorized)

{
  "status": "FAILURE",
  "resultMessage": "Token is not valid!"
}

cURL Example

curl -X GET \
  "https://demo.apinizer.com/apiops/projects/MyProject/connections/my-email-connection/" \
  -H "Authorization: Bearer YOUR_TOKEN"

Full JSON Body Example

This endpoint does not require a request body.

Notes and Warnings

• Secret Fields: Secret fields are omitted from the response, exactly as in the list endpoint. Earlier releases returned the stored value here (the encrypted form, or plain text for rows created through older releases); that is no longer the case. The same masking covers a Kafka connection's propertiesMap entries and a Webhook connection's headerList headers whose key/name is sensitive (contains password, secret, token, authorization, credential, cookie, api-key/apikey, or jaas; for Kafka also the PEM private-key entries ssl.keystore.key / ssl.key, with exactly sasl.oauthbearer.token.endpoint.url and sasl.oauthbearer.jwks.endpoint.url exempt as endpoint addresses; that exemption applies to Kafka keys only, a Webhook header name has no exemption) — their value comes back null while the key/name itself is still listed.
• Round trip: Because secrets are absent from a GET response, sending that response back with Update Connection keeps the stored secrets unchanged (an absent secret field means "keep").
• Connection Types: Each connection type has different fields. See individual connection type documentation for details:
  • Email Connection
  • Kafka Connection
  • Database Connection
  • … (see Connections Index for complete list)

Related Documentation

• List Connections - List all connections (secrets masked)
• Create Connection - Create a new connection
• Update Connection - Update a connection
• Delete Connection - Delete a connection
• Email Connection - Email connection details