v1

latestOpenAPI 3.0.3AGPL v3.02026-07-17425785.7 KB
ExternalLocationsService

Create a new external location

post/external_locations

Request body

namestring required

Name of external location.

urlstring required

Path URL of the external location.

credentialNamestring required

Name of the storage credential used with this location.

readOnlyboolean required

Indicates whether the external location is read-only.

commentstring

User-provided free-form text description.

skipValidationboolean

Skips validation of the storage credential associated with the external location.

Response

OK

namestring

Name of the external location.

urlstring

Path URL of the external location.

credentialNamestring

Name of the storage credential used with this location.

readOnlyboolean

Indicates whether the external location is read-only.

commentstring

User-provided free-form text description.

ownerstring

The owner of the external location.

credentialIdstring

Unique ID of the location's storage credential.

createdAtstring

Time at which this catalog was created, in epoch milliseconds.

createdBystring

Username of catalog creator.

updatedAtstring

Time at which this catalog was last updated, in epoch milliseconds.

updatedBystring

Username of user who last modified catalog.

browseOnlyboolean

Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.

externalLocationIdstring