Get a connection’s settings
GET/
Returns a connection’s saved values that aren’t secret, and which secrets are saved.
Needs an API token with the Read permission for connections (connection:read).
Parameters
Path
idRequired · UUIDThe connection’s ID.
Who sees the values
Only a token that may also change the connection, with the Write permission for connections. Others get {"fields": {}, "savedSecrets": []}.
A secret’s value is never answered, masked or not, and neither is an address with a password in it. The read is recorded in the audit log.
Responses
- 200OK
The values and the saved secrets’ names.
idisn’t a UUID.- 403
FORBIDDENThe token lacks the Read permission for connections.
The partner manages this connection through its own API, so it can’t be changed here.
- 404
NOT_FOUNDNo connection with this ID in the token’s workspace.
The connection couldn’t be read. Try again.
Any call can also answer: 401 UNAUTHORIZED · 401 TOKEN_ENDED · 403 TOKEN_SURFACE_OFF · 403 FEATURE_OFF · 403 EMBED_NOT_ALLOWED · 403 EMBED_NOT_AVAILABLE · 403 ACCOUNT_SUSPENDED · 429 RATE_LIMITED · 503 BUSY · 503 PAUSED · 503 SERVICE_UNAVAILABLE. See Errors.
Request
GORUNNER="https://api.gorunner.io"
GORUNNER_TOKEN="grt_…" # needs Read for connections
CONNECTION_ID="your-connection-id"
curl "$GORUNNER/api/connections/$CONNECTION_ID/settings" \
-H "Authorization: Bearer $GORUNNER_TOKEN"const GORUNNER = "https://api.gorunner.io";
const TOKEN = process.env.GORUNNER_TOKEN;
const CONNECTION_ID = process.env.CONNECTION_ID;
const res = await fetch(
`${GORUNNER}/api/connections/` +
`${CONNECTION_ID}/settings`,
{
headers: { Authorization: `Bearer ${TOKEN}` },
},
);
const { data } = await res.json();import os, requests
GORUNNER = "https://api.gorunner.io"
TOKEN = os.environ["GORUNNER_TOKEN"]
CONNECTION_ID = os.environ["CONNECTION_ID"]
res = requests.get(
f"{GORUNNER}/api/connections/{CONNECTION_ID}/"
f"settings",
headers={"Authorization": f"Bearer {TOKEN}"},
)
data = res.json()["data"]Response · 200 OK
{
"data": {
"fields": {
"host": "smtp.office365.com",
"port": "587",
"email": "warehouse@bakery.example",
"tls": true
},
"savedSecrets": [
"password"
]
}
}Every field
It takes no body.
Response · 200 OK
dataobjectfieldsobjectThe stored values that are not secret, by field name.
savedSecretsarray of stringsThe keys of the secrets saved (never their values).