Skip to main content

REST Configuration Parameters​

ParameterSample ValueDescription
REST Catalog URLhttp://<REST_ENDPOINT>:8181Specifies the endpoint URL for the REST catalog service that the writer will connect to.
Iceberg S3 Paths3://<BUCKET_NAME>Determines the S3 path or storage location for Iceberg data. "warehouse" represents the designated storage directory.
Iceberg Database<DATABASE_NAME>Specifies the name of the Iceberg database that will be used by the destination configuration.
S3 Endpointhttp://<S3_ENDPOINT>:9000Endpoint for the S3 service.
AWS Region<S3_REGION>Specifies the AWS region associated with the S3 bucket where the data is stored.
AWS Access Key<S3_ACCESS_KEY>AWS access key (Optional).
AWS Secret Key<S3_SECRET_KEY>AWS secret key (Optional).

Authentication Fields (optional)​

ParameterSample ValueDescription
Tokenabc...xyzSpecifies the Bearer token sent in the Authorization header for authenticating with the REST catalog service.
OAuth2 Auth URIhttps://auth.server.com/oauth/tokenOAuth2 server URI for OAuth2 authentication.
REST Auth Typeoauth2Authentication type (e.g., "oauth2").
Credential (OAuth2)your_id:your_secretSpecifies the client ID and secret for OAuth2, formatted as client_id:client_secret.
Scope (OAuth2)api.read api.writeOAuth2 scopes (space-separated).
REST Signing Names3tablesService name for AWS Signature V4 (e.g., "s3tables").
REST Signing Regionus-east-1Region for AWS Signature V4 signing.
REST Enable Signature V4trueEnable AWS Signature V4 signing (boolean).
Disable Identifier TablesfalseNeeded to set true for Databricks Unity Catalog as it doesn't support identifier fields


πŸ’‘ Join the OLake Community!

Got questions, ideas, or just want to connect with other data engineers?
πŸ‘‰ Join our Slack Community to get real-time support, share feedback, and shape the future of OLake together. πŸš€

Your success with OLake is our priority. Don’t hesitate to contact us if you need any help or further clarification!