POST
/
v1
/
global-connections
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>",
  "metadata": {},
  "type": "SECRET_TEXT",
  "value": {
    "type": "SECRET_TEXT",
    "secret_text": "<string>"
  },
  "scope": "PLATFORM",
  "projectIds": [
    "<string>"
  ],
  "externalId": "<string>"
}'
{
  "id": "<string>",
  "created": "<string>",
  "updated": "<string>",
  "externalId": "<string>",
  "displayName": "<string>",
  "type": "OAUTH2",
  "pieceName": "<string>",
  "projectIds": [
    "<string>"
  ],
  "platformId": "<string>",
  "scope": "PROJECT",
  "status": "ACTIVE",
  "ownerId": "<string>",
  "owner": {
    "id": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "status": "ACTIVE",
    "externalId": "<string>",
    "lastChangelogDismissed": "<string>",
    "platformId": "<string>",
    "platformRole": "ADMIN",
    "lastName": "<string>",
    "created": "<string>",
    "updated": "<string>"
  },
  "metadata": {}
}

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
externalId
string

Response

201 - application/json

App connection is a connection to an external app.

id
string
required
created
string
required
updated
string
required
externalId
string
required
displayName
string
required
type
required
Available options:
OAUTH2
pieceName
string
required
projectIds
string[]
required
scope
required
Available options:
PROJECT
status
required
Available options:
ACTIVE
platformId
string | null
ownerId
string | null
owner
object | null
metadata
object | null