Skip to content

Latest commit

 

History

History
44 lines (26 loc) · 4.14 KB

File metadata and controls

44 lines (26 loc) · 4.14 KB

Onepanel.HTTPModify

Properties

Name Type Description Notes
type String The type of storage. `type = "http"` Any HTTP or HTTPS compatible server. Supported only with Readonly option enabled and in manual import mode.
endpoint String Base URL of the HTTP server, including scheme (`http` or `https`) and optional path prefix. When registering files by relative path in `storageFileId`, that path is appended to this URL. Note: A full URI supplied as `storageFileId` always takes precedence and bypasses this endpoint, allowing files from any HTTP server reachable by the Oneprovider to be registered. [optional]
verifyServerCertificate Boolean Determines whether Oneprovider should verify the certificate of the HTTP server. [optional]
credentialsType String Determines the types of credentials provided in the credentials field. [optional]
credentials String The credentials to authenticate with the HTTP server. `basic` credentials should be provided in the form `username:password`, for `token` just the token. In case of `oauth2`, this field should contain the username for the HTTP, while the token will be obtained and refreshed automatically in the background. For `none` this field is ignored. [optional]
oauth2IdP String In case `oauth2` credential type is selected and Onezone is configured with support for multiple external IdP's, this field must contain the name of the IdP which authenticates requests to the HTTP endpoint. If Onezone has only one external IdP, it will be selected automatically. [optional]
onedataAccessToken String An access token of the Onedata user in whose name IdP access tokens will be acquired. Used only with the `oauth2` credentials type, where it is effectively required - Oneprovider verifies it when the storage is created or modified and then spends it to obtain and refresh access tokens of the IdP indicated by `oauth2IdP`. It is never passed to the HTTP server. [optional]
authorizationHeader String Header format for passing the API/access token to the backend storage server. The token will be inserted in place of "{}". Use a colon to separate the header name and value, e.g. "X-API-Token: {}". [optional]
connectionPoolSize Number Defines the maximum number of parallel connections for a single HTTP storage. [optional]
maxRequestsPerSession Number Defines the maximum number of requests performed in a single HTTP session. After the limit is reached, 'Connection: close' header is sent to the server. When set to 0 (default), number of requests per session is unlimited, unless imposed by the server. [optional]
emulateRangeRead Boolean Enables fallback emulation of range reads for HTTP servers that do not support the `Range` header. When active, the full file content is downloaded and only the requested byte range is returned to the caller. Has no effect on servers that support range reads natively. Warning: Emulation causes significant performance degradation and increased memory usage; enable only as a last resort. [optional]
maxEmulatedRangeReadFileSize Number Maximum file size in bytes eligible for emulated range reads. Files exceeding this limit cannot be accessed from servers that lack native range read support. Has no effect unless `emulateRangeRead` is `true`. [optional]
fileMode String Defines the file permissions, which files imported from HTTP storage will have in Onedata. Values should be provided in octal format e.g. `0664`. [optional]

Enum: TypeEnum

  • http (value: "http")

Enum: CredentialsTypeEnum

  • none (value: "none")

  • basic (value: "basic")

  • token (value: "token")

  • oauth2 (value: "oauth2")