Create connections

POST /api/meta/entity/bulk#createConnections

Create one or more connections.

Note that the creation relies on no matches being found for the provided qualifiedNames. If any of the qualifiedNames match any existing connection, those connections will be updated rather than created. Also be aware that the qualifiedName is case-sensitive.

For more details on the semantics and other attributes available through this interface, see the Upsert entities operation.

Body Required

List of connections to create.

  • entities array[object] Required

    Instance of a connection asset in Atlan, with only the detailed information specific to connections.

    • typeName string Required

      Should always be Connection.

    • attributes object Required

      Attributes that are needed to create a connection in Atlan.

      • qualifiedName string Required

        Unique name of the connection.

      • name string Required

        Human-readable name of the connection.

      • adminUsers array[string] | null Required

        List of users who administer the connection. There must be at least one of these or one entry in adminGroups or adminRoles for the connection in Atlan, or it will become inaccessible to everyone including all Atlan admins. Note: the usernames must match exactly the usernames in Atlan, and they are case-sensitive. The usernames are not validated, so requests may return as successful even if the username is not valid.

      • adminGroups array[string] | null Required

        List of groups who administer the connection. There must be at least one of these or one entry in adminUsers or adminRoles for the connection in Atlan, or it will become inaccessible to everyone including all Atlan admins. Note: the group names must match exactly the group names in Atlan, and they are case-sensitive. The group names are not validated, so requests may return as successful even if the group name is not valid.

      • adminRoles array[string] | null Required

        List of roles that can administer the connection. When set, any user with this role will be able to administer the connection. For example, you may want all admin users to administer connections. To do this, add the $admin role's GUID to this list. There must be at least one of these or one entry in adminGroups or adminUsers for the connection in Atlan, or it will become inaccessible to everyone including all Atlan admins. Note: the role must be specified using its GUID. You will need to look this up in your environment first, as it is different in every environment.

      • connectorName string | null Required

        Name of the connector.

      • category string | null Required

        Type of connection.

        Values are warehouse, bi, ObjectStore, or null.

      • subCategory string | null
      • host string | null

        Host name of the connection's source.

      • port integer | null

        Port number to the connection's source.

        Default value is 0.

      • allowQuery boolean | null

        When true, allow the source to be queried.

        Default value is false.

      • allowQueryPreview boolean | null

        When true, allow data previews of the source.

        Default value is false.

      • queryPreviewConfig string | null
      • queryConfig string | null
      • credentialStrategy string | null

        Default value is default.

      • rowLimit integer | null

        Maximum number of rows that can be returned for the source.

      • defaultCredentialGuid string | null
      • connectorIcon string | null
      • connectorImage string | null

Responses

  • • 200 object

    Connections that were created and / or updated.

    • mutatedEntities object | null

      Connections that were changed.

      • CREATE array[object]

        Instance of a connection asset in Atlan, with only the detailed information specific to connections.

        • typeName string

          Should always be Connection.

        • attributes object | null

          Attributes that can exist in connection assets in Atlan.

          • qualifiedName string

            Unique name for this connection.

          • name string

            Human-readable name of the connection.

          • displayName string | null

            Name used for display purposes (in user interfaces).

          • description string | null

            Description of the asset, as crawled from a source.

          • userDescription string | null

            Description of the asset, as provided by a user. If present, this will be used for the description in user interfaces. If not present, the description will be used.

          • tenantId string | null

            Name of the Atlan workspace in which the table exists.

          • certificateStatus string | null

            Status of the asset's certification.

            Values are VERIFIED, DRAFT, DEPRECATED, or null.

          • certificateStatusMessage string | null

            Human-readable descriptive message that can optionally be submitted when the certificateStatus is changed.

          • announcementTitle string | null

            Brief title for the announcement on this asset. Required when announcementType is specified.

          • announcementMessage string | null

            Detailed message to include in the announcement on this asset.

          • announcementType string | null

            Type of announcement on the asset.

            Values are information, warning, issue, or null.

          • ownerUsers array[string] | null

            List of users who own the asset.

          • ownerGroups array[string] | null

            List of groups who own the asset.

          • adminUsers array[string] | null

            List of users who administer the connection. There must be at least one of these or one entry in adminGroups or adminRoles for the connection in Atlan, or it will become inaccessible to everyone including all Atlan admins. Note: the usernames must match exactly the usernames in Atlan, and they are case-sensitive. The usernames are not validated, so requests may return as successful even if the username is not valid.

          • adminGroups array[string] | null

            List of groups who administer the connection. There must be at least one of these or one entry in adminUsers or adminRoles for the connection in Atlan, or it will become inaccessible to everyone including all Atlan admins. Note: the group names must match exactly the group names in Atlan, and they are case-sensitive. The group names are not validated, so requests may return as successful even if the group name is not valid.

          • viewerUsers array[string] | null
          • viewerGroups array[string] | null
          • connectorName string | null

            Name of the connector through which this asset is accessible.

          • connectionName string | null Deprecated

            Unused.

          • connectionQualifiedName string | null

            Unique name of the connection through which this asset is accessible.

          • isDiscoverable boolean | null
          • isEditable boolean | null
          • subType object | null
          • viewScore number | null
          • popularityScore number | null
          • sourceOwners array[string] | null
          • sourceURL string | null
          • lastSyncWorkflowName string | null

            Name of the crawler that last synchronized this asset.

          • lastSyncRunAt integer | null

            Time (epoch) at which the table was last crawled, in milliseconds.

          • lastSyncRun string | null

            Name of the last run of the crawler that last synchronized this asset.

          • certificateUpdatedBy string | null

            Name of the user who last updated the certificateStatus.

          • certificateUpdatedAt integer | null

            Time (epoch) at which the certificateStatus was last updated, in milliseconds.

          • announcementUpdatedAt integer | null

            Time (epoch) at which the announcement was last updated, in milliseconds.

          • announcementUpdatedBy string | null

            User who last updated the announcement.

          • sourceCreatedBy string | null
          • sourceCreatedAt integer | null
          • sourceUpdatedAt integer | null
          • sourceUpdatedBy string | null
          • adminRoles array[string] | null

            List of roles that can administer the connection. When set, any user with this role will be able to administer the connection. For example, you may want all admin users to administer connections. To do this, add the $admin role's GUID to this list. There must be at least one of these or one entry in adminGroups or adminUsers for the connection in Atlan, or it will become inaccessible to everyone including all Atlan admins. Note: the role must be specified using its GUID. You will need to look this up in your environment first, as it is different in every environment.

          • category string | null

            Type of connection

            Values are warehouse, bi, ObjectStore, or null.

          • subCategory string | null
          • host string | null

            Host name of the connection's source.

          • port integer | null

            Port number to the connection's source.

            Default value is 0.

          • allowQuery boolean | null

            When true, allow the source to be queried.

            Default value is false.

          • allowQueryPreview boolean | null

            When true, allow data previews of the source.

            Default value is false.

          • queryPreviewConfig string | null
          • queryConfig string | null
          • credentialStrategy string | null

            Default value is default.

          • rowLimit integer | null

            Maximum number of rows that can be returned for the source.

          • defaultCredentialGuid string | null
          • connectorIcon string | null
          • connectorImage string | null
        • classifications array[object] | null

          Instance of a classification in Atlan, with its detailed information.

          • typeName string

            Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.

          • entityGuid string

            Unique identifier of the entity to which this classification is attached.

          • propagate boolean | null

            Whether to propagate this classification to other entities related to the entity to which the classification is attached.

          • removePropagationsOnEntityDelete boolean | null

            Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.

          • entityStatus string | null

            Status of the entity to which this classification is attached.

            Values are ACTIVE or DELETED.

        • displayText string | null

          Human-readable name of the entity.

        • guid string

          Unique identifier of the entity instance.

        • isIncomplete boolean | null

          Default value is false.

        • createdBy string | null

          Username of the user who created the object.

        • updatedBy string | null

          Username of the user who last updated the object.

        • createTime integer | null

          Time (epoch) at which this object was created, in milliseconds.

        • updateTime integer | null

          Time (epoch) at which this object was last updated, in milliseconds.

        • version integer | null

          Version of this object.

        • classificationNames array[string] | null

          List of classifications for this entity. Note that these are the internal hashed names used in Atlan, not the displayText of the classification.

        • labels array[string] | null

          Internal use only.

        • status string

          Status of the entity, either ACTIVE or DELETED.

          Values are ACTIVE or DELETED.

        • relationshipAttributes object | null

          Map of the relationships to this asset.

          • links array[object] | null

            Details to use within an asset when referring to a link (resource).

          • readme object

            Details to use within an asset when referring to a readme.

            • typeName string

              Should always be Readme.

            • guid string | null

              Unique identifier of the related readme. If the uniqueAttributes are not provided, this must be provided.

            • uniqueAttributes object | null

              Attribute(s) that uniquely identify the related readme. If the guid is not provided, these must be provided.

          • meanings array[object] | null

            Details to use within an asset when referring to a term.

            • typeName string

              Should always be AtlasnGlossaryTerm.

            • guid string | null

              Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.

            • uniqueAttributes object | null

              Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.

              • qualifiedName string

                Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.

      • UPDATE array[object]

        Instance of a connection asset in Atlan, with only the detailed information specific to connections.

        • typeName string

          Should always be Connection.

        • attributes object | null

          Attributes that can exist in connection assets in Atlan.

          • qualifiedName string

            Unique name for this connection.

          • name string

            Human-readable name of the connection.

          • displayName string | null

            Name used for display purposes (in user interfaces).

          • description string | null

            Description of the asset, as crawled from a source.

          • userDescription string | null

            Description of the asset, as provided by a user. If present, this will be used for the description in user interfaces. If not present, the description will be used.

          • tenantId string | null

            Name of the Atlan workspace in which the table exists.

          • certificateStatus string | null

            Status of the asset's certification.

            Values are VERIFIED, DRAFT, DEPRECATED, or null.

          • certificateStatusMessage string | null

            Human-readable descriptive message that can optionally be submitted when the certificateStatus is changed.

          • announcementTitle string | null

            Brief title for the announcement on this asset. Required when announcementType is specified.

          • announcementMessage string | null

            Detailed message to include in the announcement on this asset.

          • announcementType string | null

            Type of announcement on the asset.

            Values are information, warning, issue, or null.

          • ownerUsers array[string] | null

            List of users who own the asset.

          • ownerGroups array[string] | null

            List of groups who own the asset.

          • adminUsers array[string] | null

            List of users who administer the connection. There must be at least one of these or one entry in adminGroups or adminRoles for the connection in Atlan, or it will become inaccessible to everyone including all Atlan admins. Note: the usernames must match exactly the usernames in Atlan, and they are case-sensitive. The usernames are not validated, so requests may return as successful even if the username is not valid.

          • adminGroups array[string] | null

            List of groups who administer the connection. There must be at least one of these or one entry in adminUsers or adminRoles for the connection in Atlan, or it will become inaccessible to everyone including all Atlan admins. Note: the group names must match exactly the group names in Atlan, and they are case-sensitive. The group names are not validated, so requests may return as successful even if the group name is not valid.

          • viewerUsers array[string] | null
          • viewerGroups array[string] | null
          • connectorName string | null

            Name of the connector through which this asset is accessible.

          • connectionName string | null Deprecated

            Unused.

          • connectionQualifiedName string | null

            Unique name of the connection through which this asset is accessible.

          • isDiscoverable boolean | null
          • isEditable boolean | null
          • subType object | null
          • viewScore number | null
          • popularityScore number | null
          • sourceOwners array[string] | null
          • sourceURL string | null
          • lastSyncWorkflowName string | null

            Name of the crawler that last synchronized this asset.

          • lastSyncRunAt integer | null

            Time (epoch) at which the table was last crawled, in milliseconds.

          • lastSyncRun string | null

            Name of the last run of the crawler that last synchronized this asset.

          • certificateUpdatedBy string | null

            Name of the user who last updated the certificateStatus.

          • certificateUpdatedAt integer | null

            Time (epoch) at which the certificateStatus was last updated, in milliseconds.

          • announcementUpdatedAt integer | null

            Time (epoch) at which the announcement was last updated, in milliseconds.

          • announcementUpdatedBy string | null

            User who last updated the announcement.

          • sourceCreatedBy string | null
          • sourceCreatedAt integer | null
          • sourceUpdatedAt integer | null
          • sourceUpdatedBy string | null
          • adminRoles array[string] | null

            List of roles that can administer the connection. When set, any user with this role will be able to administer the connection. For example, you may want all admin users to administer connections. To do this, add the $admin role's GUID to this list. There must be at least one of these or one entry in adminGroups or adminUsers for the connection in Atlan, or it will become inaccessible to everyone including all Atlan admins. Note: the role must be specified using its GUID. You will need to look this up in your environment first, as it is different in every environment.

          • category string | null

            Type of connection

            Values are warehouse, bi, ObjectStore, or null.

          • subCategory string | null
          • host string | null

            Host name of the connection's source.

          • port integer | null

            Port number to the connection's source.

            Default value is 0.

          • allowQuery boolean | null

            When true, allow the source to be queried.

            Default value is false.

          • allowQueryPreview boolean | null

            When true, allow data previews of the source.

            Default value is false.

          • queryPreviewConfig string | null
          • queryConfig string | null
          • credentialStrategy string | null

            Default value is default.

          • rowLimit integer | null

            Maximum number of rows that can be returned for the source.

          • defaultCredentialGuid string | null
          • connectorIcon string | null
          • connectorImage string | null
        • classifications array[object] | null

          Instance of a classification in Atlan, with its detailed information.

          • typeName string

            Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.

          • entityGuid string

            Unique identifier of the entity to which this classification is attached.

          • propagate boolean | null

            Whether to propagate this classification to other entities related to the entity to which the classification is attached.

          • removePropagationsOnEntityDelete boolean | null

            Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.

          • entityStatus string | null

            Status of the entity to which this classification is attached.

            Values are ACTIVE or DELETED.

        • displayText string | null

          Human-readable name of the entity.

        • guid string

          Unique identifier of the entity instance.

        • isIncomplete boolean | null

          Default value is false.

        • createdBy string | null

          Username of the user who created the object.

        • updatedBy string | null

          Username of the user who last updated the object.

        • createTime integer | null

          Time (epoch) at which this object was created, in milliseconds.

        • updateTime integer | null

          Time (epoch) at which this object was last updated, in milliseconds.

        • version integer | null

          Version of this object.

        • classificationNames array[string] | null

          List of classifications for this entity. Note that these are the internal hashed names used in Atlan, not the displayText of the classification.

        • labels array[string] | null

          Internal use only.

        • status string

          Status of the entity, either ACTIVE or DELETED.

          Values are ACTIVE or DELETED.

        • relationshipAttributes object | null

          Map of the relationships to this asset.

          • links array[object] | null

            Details to use within an asset when referring to a link (resource).

          • readme object

            Details to use within an asset when referring to a readme.

            • typeName string

              Should always be Readme.

            • guid string | null

              Unique identifier of the related readme. If the uniqueAttributes are not provided, this must be provided.

            • uniqueAttributes object | null

              Attribute(s) that uniquely identify the related readme. If the guid is not provided, these must be provided.

          • meanings array[object] | null

            Details to use within an asset when referring to a term.

            • typeName string

              Should always be AtlasnGlossaryTerm.

            • guid string | null

              Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.

            • uniqueAttributes object | null

              Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.

              • qualifiedName string

                Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.

    • guidAssignments object

      Map of assigned unique identifiers for the changed connections.

POST /api/meta/entity/bulk#createConnections 
curl \
 -X POST https://tenant.atlan.com/api/meta/entity/bulk#createConnections \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"entities":[{"typeName":"Connection","attributes":{"name":"mongodb.atlan.com","category":"warehouse","connectorName":"mongodb","qualifiedName":"default/mongodb/mongodb.atlan.com","adminGroups":["group2"],"adminUsers":["jsmith"],"adminRoles":["4ac34935-5fc8-4a7a-9505-ea7a530b8e89"]}}]}'
Request example 
{
  "entities": [
    {
      "typeName": "Connection",
      "attributes": {
        "name": "mongodb.atlan.com",
        "category": "warehouse",
        "connectorName": "mongodb",
        "qualifiedName": "default/mongodb/mongodb.atlan.com",
        "adminGroups": [
          "group2"
        ],
        "adminUsers": [
          "jsmith"
        ],
        "adminRoles": [
          "4ac34935-5fc8-4a7a-9505-ea7a530b8e89"
        ]
      }
    }
  ]
}
Response example (200) 
{
  "mutatedEntities": {
    "CREATE": [
      {
        "typeName": "Connection",
        "attributes": {
          "popularityScore": 1.17549435e-38,
          "sourceCreatedAt": 0,
          "viewerUsers": [],
          "viewScore": 1.17549435e-38,
          "lastSyncRunAt": 0,
          "adminRoles": [
            "4ac34935-5fc8-4a7a-9505-ea7a530b8e89"
          ],
          "adminGroups": [
            "group2"
          ],
          "qualifiedName": "default/mongodb/mongodb.atlan.com",
          "rowLimit": 0,
          "credentialStrategy": "default",
          "allowQueryPreview": false,
          "adminUsers": [
            "jsmith"
          ],
          "ownerGroups": [],
          "isEditable": true,
          "sourceUpdatedAt": 0,
          "port": 0,
          "announcementUpdatedAt": 0,
          "name": "mongodb.atlan.com",
          "certificateUpdatedAt": 0,
          "connectorName": "mongodb",
          "isDiscoverable": true,
          "category": "warehouse",
          "allowQuery": false,
          "viewerGroups": [],
          "ownerUsers": []
        },
        "guid": "e185209b-4b08-4e2f-acc7-35c47229f67f",
        "status": "ACTIVE",
        "displayText": "mongodb.atlan.com",
        "classificationNames": [],
        "classifications": [],
        "meaningNames": [],
        "meanings": [],
        "isIncomplete": false,
        "labels": [],
        "createdBy": "service-account-apikey-6f7f1591-a247-42bd-a969-11ec2e654678",
        "updatedBy": "service-account-apikey-6f7f1591-a247-42bd-a969-11ec2e654678",
        "createTime": 1652781231100,
        "updateTime": 1652781231100
      }
    ]
  },
  "guidAssignments": {
    "-8162171324767974": "e185209b-4b08-4e2f-acc7-35c47229f67f"
  }
}