OutboundNetworkConnection

Represents a private connection between a Salesforce org and a third-party data service. The connection is outbound because the callouts are going out of Salesforce.Available in API version 49.0 and later.

Version 

Introduced in API version 49.0.

Supported SOAP API Calls 

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Fields 

ConnectionType 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Description: Specifies the cloud provider of the connection. The only valid value is AwsPrivateLink.

• Possible values:

  • AwsPrivateLink — AwsPrivateLink

  • DataCloudPrivateConnection — DataCloudPrivateConnection

Description 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: A description of the connection. Maximum of 255 characters.

DeveloperName 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: The developer’s internal name for the outbound network connection used in the API.

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Description: The full name of the associated type in Metadata API.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

IsActive 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Default value: false

Language 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

• Description: The language of the connection. The value for this field is the language value of the org.

• Possible values:

  • en_US — English

  • de — German

  • es — Spanish

  • fr — French

  • it — Italian

  • ja — Japanese

  • sv — Swedish

  • ko — Korean

  • zh_TW — Chinese (Traditional)

  • zh_CN — Chinese (Simplified)

  • pt_BR — Portuguese (Brazil)

  • nl_NL — Dutch

  • da — Danish

  • th — Thai

  • fi — Finnish

  • ru — Russian

  • es_MX — Spanish (Mexico)

  • no — Norwegian

ManageableState 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: Indicates the manageable state of the specified component that is contained in a package:

• beta

• deleted

• deprecated

• deprecatedEditable

• installed

• installedEditable

• released

• unmanaged

• Type: ManageableState enumerated list

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: Indicates the manageable state of the specified component that is contained in a package:

• beta

• deleted

• deprecated

• deprecatedEditable

• installed

• installedEditable

• released

• unmanaged

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

MasterLabel 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: The internal label for the connection.

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Description: Provides access to the associated type and related fields in Metadata API.

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The namespace of the connection. An outbound network connection can be in an extension namespace different than the object.

Status 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Description: Required. Connection status. The connection is initially Unprovisioned and moves through the other states automatically after an admin performs a provision, sync, or teardown action.

• Possible values:

  • Unprovisioned — Unprovisioned

  • Allocating — Allocating

  • PendingAcceptance — PendingAcceptance

  • PendingActivation — PendingActivation

  • RejectedRemotely — RejectedRemotely

  • DeletedRemotely — DeletedRemotely

  • TeardownInProgress — TeardownInProgress

  • Ready — Ready