Skip to main content
POST
/
v1
/
global-connections
cURL
curl --request POST \
  --url https://cloud.activepieces.com/api/v1/global-connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "pieceName": "<string>",
  "value": {
    "secret_text": "<string>"
  },
  "projectIds": [
    "<string>"
  ],
  "metadata": {},
  "pieceVersion": "<string>",
  "externalId": "<string>",
  "preSelectForNewProjects": true
}
'
{
  "id": "<string>",
  "created": "<string>",
  "updated": "<string>",
  "externalId": "<string>",
  "displayName": "<string>",
  "pieceName": "<string>",
  "projectIds": [
    "<string>"
  ],
  "pieceVersion": "<string>",
  "preSelectForNewProjects": true,
  "usingSecretManager": true,
  "platformId": "<string>",
  "ownerId": "<string>",
  "owner": {
    "id": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "created": "<string>",
    "updated": "<string>",
    "externalId": "<string>",
    "platformId": "<string>",
    "lastActiveDate": "<string>",
    "imageUrl": "<string>"
  },
  "metadata": {},
  "flowIds": [
    "<string>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://www.activepieces.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Use your api key generated from the admin console

Body

application/json
displayName
string
required
pieceName
string
required
type
enum<string>
required
Available options:
SECRET_TEXT
value
object
required
scope
enum<string>
required
Available options:
PLATFORM
projectIds
string[]
required
metadata
object
pieceVersion
string
externalId
string
preSelectForNewProjects
boolean

Response

201 - application/json

Default Response

id
string
required
created
string
required
updated
string
required
externalId
string
required
displayName
string
required
type
enum<string>
required
Available options:
OAUTH2,
PLATFORM_OAUTH2,
CLOUD_OAUTH2,
SECRET_TEXT,
BASIC_AUTH,
CUSTOM_AUTH,
NO_AUTH
pieceName
string
required
projectIds
string[]
required
Pattern: ^[0-9a-zA-Z]{21}$
scope
enum<string>
required
Available options:
PROJECT,
PLATFORM
status
enum<string>
required
Available options:
ACTIVE,
MISSING,
ERROR
pieceVersion
string
required
preSelectForNewProjects
boolean
required
usingSecretManager
boolean
required
platformId
string | null
ownerId
string | null
owner
object
metadata
object
flowIds
string[] | null
Pattern: ^[0-9a-zA-Z]{21}$