UNunitycatalog
External Locations

Create an external location

Changed on

Creates a new external location entry in the metastore. The caller must be a metastore admin to be able to create external locations.

post/external-locations

Request

  • Base URL
    http://localhost:8080/api/2.1/unity-catalog
  • Auth
    none declared

Request body

namestring required

Name of the external location.

urlstring required

Path URL of the external location.

credential_namestring required

Name of the storage credential used with this location.

commentstring

User-provided free-form text description.

Response

The new external location was successfully created.

namestring

Name of the external location.

idstring

Unique identifier for the external location.

urlstring

Path URL of the external location.

credential_namestring

Name of the storage credential used with this location.

commentstring

User-provided free-form text description.

ownerstring

The owner of the external location.

credential_idstring

Unique ID of the location's storage credential.

created_atinteger

Time at which this external location was created, in epoch milliseconds.

created_bystring

Username of external location creator.

updated_atinteger

Time at which external location this was last modified, in epoch milliseconds.

updated_bystring

Username of user who last modified the external location.

Changes