/external-connections/v1beta/organizations/{organizationId}/connections:upsert

post

https://api.cast.ai/external-connections/v1beta/organizations/{organizationId}/connections:upsert

Creates or updates a connection with the full desired state.
The connection is uniquely identified by organization_id, cloud, and scope_key.
If a connection already exists, it will be replaced with the new state.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

organizationId

string

required

The organization ID to create/update the connection for.

Body Params

Request to upsert a connection.

organizationId

string

required

The organization ID to create/update the connection for.

cloud

string

enum

required

The cloud provider for this connection.

Allowed:

scopeKey

string

required

Unique identifier for the scope (e.g., account ID, project ID, subscription ID).

connectionScope

string

enum

required

Whether this connection is at account or organization scope.

Allowed:

resourceSuffix

string

required

Suffix for generated cloud resources.

enabledFeatures

array of objects

required

Features enabled for this connection with their selected sub-features.

enabledFeatures*

metadata

object

Cloud-specific metadata for the connection. Includes the customer-side
service accounts, Azure Entra app registrations, AWS role ARN, and the
Cast-side intermediate service account emails used in the impersonation
chain. The customer sends this after provisioning and establishing trust
on their side.

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

defaultDefault error response