FinSpace Public API

2022/06/28 - FinSpace Public API - 1 new api methods

Changes  Release new API GetExternalDataViewAccessDetails

GetExternalDataViewAccessDetails (new) Link ΒΆ

Returns the credentials to access the external Dataview from an S3 location. To call this API:

  • You must retrieve the programmatic credentials.

  • You must be a member of a FinSpace user group, where the dataset that you want to access has Read Dataset Data permissions.

See also: AWS API Documentation

Request Syntax

type dataViewId


param dataViewId


The unique identifier for the Dataview that you want to access.

type datasetId


param datasetId


The unique identifier for the Dataset.




Response Syntax

    'credentials': {
        'accessKeyId': 'string',
        'secretAccessKey': 'string',
        'sessionToken': 'string',
        'expiration': 123
    's3Location': {
        'bucket': 'string',
        'key': 'string'

Response Structure

  • (dict) --

    • credentials (dict) --

      The credentials required to access the external Dataview from the S3 location.

      • accessKeyId (string) --

        The unique identifier for the security credentials.

      • secretAccessKey (string) --

        The secret access key that can be used to sign requests.

      • sessionToken (string) --

        The token that users must pass to use the credentials.

      • expiration (integer) --

        The Epoch time when the current credentials expire.

    • s3Location (dict) --

      The location where the external Dataview is stored.

      • bucket (string) --

        The name of the S3 bucket.

      • key (string) --

        The path of the folder, within the S3 bucket that contains the Dataset.