SAP HANA Cloud, Data Lake Files REST API (v1)

Download OpenAPI specification:Download

This document specifies all operations supported by SAP HANA Cloud, Data Lake Files (HDLFS).

OPEN

Read the content of a file. The parameters length and offset control the size to read and starting position, respectively.

Note: Please note the response can be a temporary redirection to a different endpoint.

path Parameters

path

required

string <path/to/file>

The absolute path of a file.

query Parameters

offset	integer <int64> The starting byte position. If not specified, it will be set to the beginning of the file. Example: `10`
length	integer <int64> The number of bytes to be processed. If not specified, it will read until the end of the file is reached. Example: `5`
noredirect	boolean Default: false If this is set to true, even when the response is a temporary redirect, it will have HTTP status 200 OK and the redirection location will be in the response body.

header Parameters

X-SAP-FileContainer required	string This is the only REQUIRED header. This header is used to define which File Container the request should target. Any request is always in the context of one File Container.
X-SAP-Trusted-User	string This header is an optional header and requires the impersonate privilege in order to use it. This header allows you to set the user context of the request, making all outcomes of the request traceable back to the specified user. Note that if NOT used in conjunction with `X-SAP-Trusted-User-Roles`, the effective role of the request will be the `user` role as defined in your File Container.
X-SAP-Trusted-User-Encoding	string Enum: "ascii" "b64-utf-8" This header is optional and is only used in conjunction with `X-SAP-Trusted-User` and also requires the impersonate privilege. If the user you would like to send is not able to be represented using ASCII encoding, which is the default, you can specify a different encoding with this header. The only values currently supported are `ascii` and `b64-utf-8`. `b64-utf-8` will use `base64` decoding with the `utf-8` character set.
X-SAP-Trusted-User-Roles	string This header is optional, requires the authorize privilege in order to use, and must be used in conjunction with `X-SAP-Trusted-User`. It is used to specify the roles with which the request is to be authorized. The roles specified in this header must be `user`, `admin`, or any custom role defined in your File Container. The input is a comma separated list of roles.

Responses

Response samples

Content type

application/json

{"exception": "string",
"javaClassName": "string",
"message": "string",
"requestId": "string"
}

CHECKACCESS

Check if the current user has access to a given path, based on the configured access policies.

path Parameters

path	string <path/to/prefix> The path to check.

query Parameters

fsaction

string

The action to check. The supported values are --, r-, rw and -w, where r represents read permissions and w represents write permissions. The values ---, r--, rw- and -w- are also accepted.

header Parameters

X-SAP-FileContainer required	string This is the only REQUIRED header. This header is used to define which File Container the request should target. Any request is always in the context of one File Container.
X-SAP-Trusted-User	string This header is an optional header and requires the impersonate privilege in order to use it. This header allows you to set the user context of the request, making all outcomes of the request traceable back to the specified user. Note that if NOT used in conjunction with `X-SAP-Trusted-User-Roles`, the effective role of the request will be the `user` role as defined in your File Container.
X-SAP-Trusted-User-Encoding	string Enum: "ascii" "b64-utf-8" This header is optional and is only used in conjunction with `X-SAP-Trusted-User` and also requires the impersonate privilege. If the user you would like to send is not able to be represented using ASCII encoding, which is the default, you can specify a different encoding with this header. The only values currently supported are `ascii` and `b64-utf-8`. `b64-utf-8` will use `base64` decoding with the `utf-8` character set.
X-SAP-Trusted-User-Roles	string This header is optional, requires the authorize privilege in order to use, and must be used in conjunction with `X-SAP-Trusted-User`. It is used to specify the roles with which the request is to be authorized. The roles specified in this header must be `user`, `admin`, or any custom role defined in your File Container. The input is a comma separated list of roles.

Responses

Response samples

Content type

application/json

{"boolean": true
}

GETACCESSPOLICY

Return the Access Policies JSON document. This document controls the access policies of the File Container.

query Parameters

path	string <path/to/prefix> The absolute path of a prefix within the File Container. If specified, the Access Policies JSON document will be filtered to contain only the rules that start with the specified path. Note that the dynamic values %USER% and %ROLE% are only resolved if the "user" and "role" parameters are present, respectively.
user	string The name of any user to review access policies for. If this parameter is provided, the dynamic value %USER% will be resolved.
roles	string The name of any role(s) to consider when reviewing policies. If this parameter is provided, the dynamic value %ROLE% will be resolved.

header Parameters

X-SAP-FileContainer required	string This is the only REQUIRED header. This header is used to define which File Container the request should target. Any request is always in the context of one File Container.
X-SAP-Trusted-User	string This header is an optional header and requires the impersonate privilege in order to use it. This header allows you to set the user context of the request, making all outcomes of the request traceable back to the specified user. Note that if NOT used in conjunction with `X-SAP-Trusted-User-Roles`, the effective role of the request will be the `user` role as defined in your File Container.
X-SAP-Trusted-User-Encoding	string Enum: "ascii" "b64-utf-8" This header is optional and is only used in conjunction with `X-SAP-Trusted-User` and also requires the impersonate privilege. If the user you would like to send is not able to be represented using ASCII encoding, which is the default, you can specify a different encoding with this header. The only values currently supported are `ascii` and `b64-utf-8`. `b64-utf-8` will use `base64` decoding with the `utf-8` character set.
X-SAP-Trusted-User-Roles	string This header is optional, requires the authorize privilege in order to use, and must be used in conjunction with `X-SAP-Trusted-User`. It is used to specify the roles with which the request is to be authorized. The roles specified in this header must be `user`, `admin`, or any custom role defined in your File Container. The input is a comma separated list of roles.

Responses

Response samples

Content type

application/json

{"AccessPolicies": [{"path": "/example/path/prefix",
"entries": ["user:alice:r--",
"user:bob:rw-"
]
},
{"path": "/user/bob",
"entries": ["user::r--",
"user:bob:rw-"
],
"origin": {"path": "/user/%USER%",
"entries": ["user::r--",
"user:%USER%:rw-"
]
}
},
{"path": "/role/%ROLE%",
"entries": ["role::r--",
"role:%ROLE%:rw-"
]
}
]
}

GETOPERATIONSTATUS

Get the status of an async operation.

query Parameters

token

required

string

The token of the async operation whose state is being queried.

Example: aS1hbS1hLXRva2VuCg==

header Parameters

X-SAP-FileContainer required	string This is the only REQUIRED header. This header is used to define which File Container the request should target. Any request is always in the context of one File Container.
X-SAP-Trusted-User	string This header is an optional header and requires the impersonate privilege in order to use it. This header allows you to set the user context of the request, making all outcomes of the request traceable back to the specified user. Note that if NOT used in conjunction with `X-SAP-Trusted-User-Roles`, the effective role of the request will be the `user` role as defined in your File Container.
X-SAP-Trusted-User-Encoding	string Enum: "ascii" "b64-utf-8" This header is optional and is only used in conjunction with `X-SAP-Trusted-User` and also requires the impersonate privilege. If the user you would like to send is not able to be represented using ASCII encoding, which is the default, you can specify a different encoding with this header. The only values currently supported are `ascii` and `b64-utf-8`. `b64-utf-8` will use `base64` decoding with the `utf-8` character set.
X-SAP-Trusted-User-Roles	string This header is optional, requires the authorize privilege in order to use, and must be used in conjunction with `X-SAP-Trusted-User`. It is used to specify with which roles the request is to be authorized. The roles specified in this header must be `user`, `admin`, or any custom role defined in your File Container. The input is a comma separated list of roles.

Responses

Response samples

Content type

application/json

Example

GetOperationStatusSuccessfulResponse

{"State": "DONE",
"Operation": "DELETE_BATCH",
"Context": {"path": "/"
},
"SuccessfulResponse": {"boolean": true
}
}

GETRESTORESNAPSHOTSTATUS

Get the status of an active restore process.

query Parameters

token

required

string

The token of the restore process whose state is being queried.

Example: eyJyZXN0b3JlU25hcHNob3ROYW1lIjoiMjAyM.. ..C0wMi0wNlQyMDozNToyMi4wMDBaIiwicmVzdG9yZVBhdGgiOiIifQ

header Parameters

X-SAP-FileContainer required	string This is the only REQUIRED header. This header is used to define which File Container the request should target. Any request is always in the context of one File Container.
X-SAP-Trusted-User	string This header is an optional header and requires the impersonate privilege in order to use it. This header allows you to set the user context of the request, making all outcomes of the request traceable back to the specified user. Note that if NOT used in conjunction with `X-SAP-Trusted-User-Roles`, the effective role of the request will be the `user` role as defined in your File Container.
X-SAP-Trusted-User-Encoding	string Enum: "ascii" "b64-utf-8" This header is optional and is only used in conjunction with `X-SAP-Trusted-User` and also requires the impersonate privilege. If the user you would like to send is not able to be represented using ASCII encoding, which is the default, you can specify a different encoding with this header. The only values currently supported are `ascii` and `b64-utf-8`. `b64-utf-8` will use `base64` decoding with the `utf-8` character set.
X-SAP-Trusted-User-Roles	string This header is optional, requires the authorize privilege in order to use, and must be used in conjunction with `X-SAP-Trusted-User`. It is used to specify with which roles the request is to be authorized. The roles specified in this header must be `user`, `admin`, or any custom role defined in your File Container. The input is a comma separated list of roles.

Responses

Response samples

Content type

application/json

{"Status": "DONE"
}

GETFILESTATUS

Get the status of a file or directory given by the path parameter.

path Parameters

path

required

string <path/to/file OR path/to/directory/>

The absolute path of a file or directory.

header Parameters

X-SAP-FileContainer required	string This is the only REQUIRED header. This header is used to define which File Container the request should target. Any request is always in the context of one File Container.
X-SAP-Trusted-User	string This header is an optional header and requires the impersonate privilege in order to use it. This header allows you to set the user context of the request, making all outcomes of the request traceable back to the specified user. Note that if NOT used in conjunction with `X-SAP-Trusted-User-Roles`, the effective role of the request will be the `user` role as defined in your File Container.
X-SAP-Trusted-User-Encoding	string Enum: "ascii" "b64-utf-8" This header is optional and is only used in conjunction with `X-SAP-Trusted-User` and also requires the impersonate privilege. If the user you would like to send is not able to be represented using ASCII encoding, which is the default, you can specify a different encoding with this header. The only values currently supported are `ascii` and `b64-utf-8`. `b64-utf-8` will use `base64` decoding with the `utf-8` character set.
X-SAP-Trusted-User-Roles	string This header is optional, requires the authorize privilege in order to use, and must be used in conjunction with `X-SAP-Trusted-User`. It is used to specify with which roles the request is to be authorized. The roles specified in this header must be `user`, `admin`, or any custom role defined in your File Container. The input is a comma separated list of roles.

Responses

Response samples

Content type

application/json

{"FileStatus": {"pathSuffix": "some-file.txt",
"type": "FILE",
"length": 37454432,
"owner": "someuser",
"group": "somegroup",
"permission": "666",
"accessTime": 0,
"modificationTime": 1557935488000,
"blockSize": 33554432,
"replication": 1,
"eTag": "RVRhZy1FeGFtcGxlCg=="
}
}

LISTSTATUS

List the status of a file or contents of a directory given by the path parameter.

path Parameters

path

required

string <path/to/file OR path/to/directory/>

The absolute path of a file or directory.

header Parameters

X-SAP-FileContainer required	string This is the only REQUIRED header. This header is used to define which File Container the request should target. Any request is always in the context of one File Container.
X-SAP-Trusted-User	string This header is an optional header and requires the impersonate privilege in order to use it. This header allows you to set the user context of the request, making all outcomes of the request traceable back to the specified user. Note that if NOT used in conjunction with `X-SAP-Trusted-User-Roles`, the effective role of the request will be the `user` role as defined in your File Container.
X-SAP-Trusted-User-Encoding	string Enum: "ascii" "b64-utf-8" This header is optional and is only used in conjunction with `X-SAP-Trusted-User` and also requires the impersonate privilege. If the user you would like to send is not able to be represented using ASCII encoding, which is the default, you can specify a different encoding with this header. The only values currently supported are `ascii` and `b64-utf-8`. `b64-utf-8` will use `base64` decoding with the `utf-8` character set.
X-SAP-Trusted-User-Roles	string This header is optional, requires the authorize privilege in order to use, and must be used in conjunction with `X-SAP-Trusted-User`. It is used to specify with which roles the request is to be authorized. The roles specified in this header must be `user`, `admin`, or any custom role defined in your File Container. The input is a comma separated list of roles.

Responses

Response samples

Content type

application/json

{"FileStatuses": {"FileStatus": [{"accessTime": 1320171722771,
"blockSize": 33554432,
"group": "somegroup",
"length": 3854432,
"modificationTime": 1320171722771,
"owner": "someuser",
"pathSuffix": "a.patch",
"permission": "666",
"replication": 1,
"type": "FILE",
"eTag": "RVRhZy1FeGFtcGxlCg=="
},
{"accessTime": 0,
"blockSize": 0,
"group": "somegroup",
"length": 0,
"modificationTime": 1320895981256,
"owner": "someuser",
"pathSuffix": "dir001",
"permission": "777",
"replication": 0,
"type": "DIRECTORY",
"eTag": "RVRhZy1FeGFtcGxlCg=="
}
]
}
}

LISTSTATUS_BATCH

List the contents of a directory given by the path parameter.

path Parameters

path

required

string <path/to/file OR path/to/directory/>

The absolute path of a file or directory.

query Parameters

startAfter

string <opaque-token>

The ID of the last listed page. If omitted, the first page is returned. The ID of the page is returned in the pageId field.

header Parameters

X-SAP-FileContainer required	string This is the only REQUIRED header. This header is used to define which File Container the request should target. Any request is always in the context of one File Container.
X-SAP-Trusted-User	string This header is an optional header and requires the impersonate privilege in order to use it. This header allows you to set the user context of the request, making all outcomes of the request traceable back to the specified user. Note that if NOT used in conjunction with `X-SAP-Trusted-User-Roles`, the effective role of the request will be the `user` role as defined in your File Container.
X-SAP-Trusted-User-Encoding	string Enum: "ascii" "b64-utf-8" This header is optional and is only used in conjunction with `X-SAP-Trusted-User` and also requires the impersonate privilege. If the user you would like to send is not able to be represented using ASCII encoding, which is the default, you can specify a different encoding with this header. The only values currently supported are `ascii` and `b64-utf-8`. `b64-utf-8` will use `base64` decoding with the `utf-8` character set.
X-SAP-Trusted-User-Roles	string This header is optional, requires the authorize privilege in order to use, and must be used in conjunction with `X-SAP-Trusted-User`. It is used to specify with which roles the request is to be authorized. The roles specified in this header must be `user`, `admin`, or any custom role defined in your File Container. The input is a comma separated list of roles.

Responses

Response samples

Content type

application/json

{"DirectoryListing": {"partialListing": {"FileStatuses": {"FileStatus": [{"accessTime": 0,
"blockSize": 33554432,
"group": "somegroup",
"length": 3854432,
"modificationTime": 1320171722771,
"owner": "someuser",
"pathSuffix": "file001",
"permission": "666",
"replication": 1,
"type": "FILE",
"eTag": "RVRhZy1FeGFtcGxlCg=="
},
{"accessTime": 0,
"blockSize": 33554432,
"group": "somegroup",
"length": 15,
"modificationTime": 1623285761000,
"owner": "someuser",
"pathSuffix": "directory001",
"permission": "666",
"replication": 1,
"type": "DIRECTORY",
"eTag": "RVRhZy1FeGFtcGxlCg=="
}
]
}
},
"pageId": "cGFnZS1pZC10b2tlbgo="
}
}

LISTSTATUS_RECURSIVE

Recursively lists the contents of a directory given by the path parameter.

path Parameters

path

required

string <path/to/file OR path/to/directory/>

The absolute path of a file or directory.

query Parameters

startAfter

string <opaque-token>

The ID of the last listed page. If omitted, the first page is returned. The ID of the page is returned in the pageId field.

header Parameters

X-SAP-FileContainer required	string This is the only REQUIRED header. This header is used to define which File Container the request should target. Any request is always in the context of one File Container.
X-SAP-Trusted-User	string This header is an optional header and requires the impersonate privilege in order to use it. This header allows you to set the user context of the request, making all outcomes of the request traceable back to the specified user. Note that if NOT used in conjunction with `X-SAP-Trusted-User-Roles`, the effective role of the request will be the `user` role as defined in your File Container.
X-SAP-Trusted-User-Encoding	string Enum: "ascii" "b64-utf-8" This header is optional and is only used in conjunction with `X-SAP-Trusted-User` and also requires the impersonate privilege. If the user you would like to send is not able to be represented using ASCII encoding, which is the default, you can specify a different encoding with this header. The only values currently supported are `ascii` and `b64-utf-8`. `b64-utf-8` will use `base64` decoding with the `utf-8` character set.
X-SAP-Trusted-User-Roles	string This header is optional, requires the authorize privilege in order to use, and must be used in conjunction with `X-SAP-Trusted-User`. It is used to specify with which roles the request is to be authorized. The roles specified in this header must be `user`, `admin`, or any custom role defined in your File Container. The input is a comma separated list of roles.

Responses

Response samples

Content type

application/json

{"DirectoryListing": {"partialListing": {"FileStatuses": {"FileStatus": [{"accessTime": 0,
"blockSize": 33554432,
"group": "somegroup",
"length": 3854432,
"modificationTime": 1320171722771,
"owner": "someuser",
"pathSuffix": "file001",
"permission": "666",
"replication": 1,
"type": "FILE",
"eTag": "RVRhZy1FeGFtcGxlCg=="
},
{"accessTime": 0,
"blockSize": 33554432,
"group": "somegroup",
"length": 15,
"modificationTime": 1623285761000,
"owner": "someuser",
"pathSuffix": "prefix/file002",
"permission": "666",
"replication": 1,
"type": "FILE",
"eTag": "RVRhZy1FeGFtcGxlCg=="
}
]
}
},
"pageId": "cGFnZS1pZC10b2tlbgo="
}
}

WHOAMI

Return a JSON response with user name, effective privileges of the user's role and home directory of the user.

header Parameters

X-SAP-FileContainer required	string This is the only REQUIRED header. This header is used to define which File Container the request should target. Any request is always in the context of one File Container.
X-SAP-Trusted-User	string This header is an optional header and requires the impersonate privilege in order to use it. This header allows you to set the user context of the request, making all outcomes of the request traceable back to the specified user. Note that if NOT used in conjunction with `X-SAP-Trusted-User-Roles`, the effective role of the request will be the `user` role as defined in your File Container.
X-SAP-Trusted-User-Encoding	string Enum: "ascii" "b64-utf-8" This header is optional and is only used in conjunction with `X-SAP-Trusted-User` and also requires the impersonate privilege. If the user you would like to send is not able to be represented using ASCII encoding, which is the default, you can specify a different encoding with this header. The only values currently supported are `ascii` and `b64-utf-8`. `b64-utf-8` will use `base64` decoding with the `utf-8` character set.
X-SAP-Trusted-User-Roles	string This header is optional, requires the authorize privilege in order to use, and must be used in conjunction with `X-SAP-Trusted-User`. It is used to specify with which roles the request is to be authorized. The roles specified in this header must be `user`, `admin`, or any custom role defined in your File Container. The input is a comma separated list of roles.

Responses

Response samples

Content type

application/json

{"user": "bob",
"privileges": ["browse",
"create",
"open"
],
"home": "/prefix/bob"
}

CREATE

Create a new file and write data to the created file.

Note: Please note the response can be a temporary redirection to a different endpoint.

Note: Please note the CREATE operation will always overwrite the file if it already exists.

path Parameters

path

required

string <path/to/file>

The absolute path of a file to create.

query Parameters

noredirect

boolean

Default: false

If this is set to true, even when the response is a temporary redirect, it will have HTTP status 200 OK and the redirection location will be in the response body.

header Parameters

X-SAP-FileContainer required	string This is the only REQUIRED header. This header is used to define which File Container the request should target. Any request is always in the context of one File Container.
X-SAP-Trusted-User	string This header is an optional header and requires the impersonate privilege in order to use it. This header allows you to set the user context of the request, making all outcomes of the request traceable back to the specified user. Note that if NOT used in conjunction with `X-SAP-Trusted-User-Roles`, the effective role of the request will be the `user` role as defined in your File Container.
X-SAP-Trusted-User-Encoding	string Enum: "ascii" "b64-utf-8" This header is optional and is only used in conjunction with `X-SAP-Trusted-User` and also requires the impersonate privilege. If the user you would like to send is not able to be represented using ASCII encoding, which is the default, you can specify a different encoding with this header. The only values currently supported are `ascii` and `b64-utf-8`. `b64-utf-8` will use `base64` decoding with the `utf-8` character set.
X-SAP-Trusted-User-Roles	string This header is optional, requires the authorize privilege in order to use, and must be used in conjunction with `X-SAP-Trusted-User`. It is used to specify the roles with which the request is to be authorized. The roles specified in this header must be `user`, `admin`, or any custom role defined in your File Container. The input is a comma separated list of roles.

Responses

Response samples

Content type

application/json

{"location": "string"
}

RENAME

Rename the file given by the path parameter.

path Parameters

path

required

string <path/to/file>

The absolute path of a file.

query Parameters

destination

required

string <path/to/destination/file>

An absolute path to which you want the file to be renamed.

header Parameters

X-SAP-FileContainer required	string This is the only REQUIRED header. This header is used to define which File Container the request should target. Any request is always in the context of one File Container.
X-SAP-Trusted-User	string This header is an optional header and requires the impersonate privilege in order to use it. This header allows you to set the user context of the request, making all outcomes of the request traceable back to the specified user. Note that if NOT used in conjunction with `X-SAP-Trusted-User-Roles`, the effective role of the request will be the `user` role as defined in your File Container.
X-SAP-Trusted-User-Encoding	string Enum: "ascii" "b64-utf-8" This header is optional and is only used in conjunction with `X-SAP-Trusted-User` and also requires the impersonate privilege. If the user you would like to send is not able to be represented using ASCII encoding, which is the default, you can specify a different encoding with this header. The only values currently supported are `ascii` and `b64-utf-8`. `b64-utf-8` will use `base64` decoding with the `utf-8` character set.
X-SAP-Trusted-User-Roles	string This header is optional, requires the authorize privilege in order to use, and must be used in conjunction with `X-SAP-Trusted-User`. It is used to specify the roles with which the request is to be authorized. The roles specified in this header must be `user`, `admin`, or any custom role defined in your File Container. The input is a comma separated list of roles.

Responses

Response samples

Content type

application/json

{"boolean": true
}

COPY

Copy the file or directory given by the path parameter.

path Parameters

path

required

string <path/to/file-or-directory>

The absolute path of the file or directory to be copied.

Note: The operation, if performed on the root path (/), will copy all the files and directories.

query Parameters

destination required	string <path/to/destination/file-or-directory> The absolute path to which you want the file or directory to be copied.
async	boolean Default: false This is an optional query parameter that can be specified to indicate if the operation should be performed asynchronously. If not specified, it defaults to `false`.

header Parameters

X-SAP-FileContainer required	string This is the only REQUIRED header. This header is used to define which File Container the request should target. Any request is always in the context of one File Container.
X-SAP-Trusted-User	string This header is an optional header and requires the impersonate privilege in order to use it. This header allows you to set the user context of the request, making all outcomes of the request traceable back to the specified user. Note that if NOT used in conjunction with `X-SAP-Trusted-User-Roles`, the effective role of the request will be the `user` role as defined in your File Container.
X-SAP-Trusted-User-Encoding	string Enum: "ascii" "b64-utf-8" This header is optional and is only used in conjunction with `X-SAP-Trusted-User` and also requires the impersonate privilege. If the user you would like to send is not able to be represented using ASCII encoding, which is the default, you can specify a different encoding with this header. The only values currently supported are `ascii` and `b64-utf-8`. `b64-utf-8` will use `base64` decoding with the `utf-8` character set.
X-SAP-Trusted-User-Roles	string This header is optional, requires the authorize privilege in order to use, and must be used in conjunction with `X-SAP-Trusted-User`. It is used to specify the roles with which the request is to be authorized. The roles specified in this header must be `user`, `admin`, or any custom role defined in your File Container. The input is a comma separated list of roles.

Responses

Response samples

Content type

application/json

{"boolean": true
}

SETACCESSPOLICY

Set/Replace the content of the Access Policies JSON document. This document controls the access policies of the File Container. The JSON document must be sent in the body of the request. Note that this is not an incremental update, so the complete document must always be sent.

header Parameters

X-SAP-FileContainer required	string This is the only REQUIRED header. This header is used to define which File Container the request should target. Any request is always in the context of one File Container.
X-SAP-Trusted-User	string This header is an optional header and requires the impersonate privilege in order to use it. This header allows you to set the user context of the request, making all outcomes of the request traceable back to the specified user. Note that if NOT used in conjunction with `X-SAP-Trusted-User-Roles`, the effective role of the request will be the `user` role as defined in your File Container.
X-SAP-Trusted-User-Encoding	string Enum: "ascii" "b64-utf-8" This header is optional and is only used in conjunction with `X-SAP-Trusted-User` and also requires the impersonate privilege. If the user you would like to send is not able to be represented using ASCII encoding, which is the default, you can specify a different encoding with this header. The only values currently supported are `ascii` and `b64-utf-8`. `b64-utf-8` will use `base64` decoding with the `utf-8` character set.
X-SAP-Trusted-User-Roles	string This header is optional, requires the authorize privilege in order to use, and must be used in conjunction with `X-SAP-Trusted-User`. It is used to specify the roles with which the request is to be authorized. The roles specified in this header must be `user`, `admin`, or any custom role defined in your File Container. The input is a comma separated list of roles.

Request Body schema: application/json

The complete Access Policies JSON document.

Array of objects (AccessPolicy)

Responses

Request samples

Payload

Content type

application/json

{"AccessPolicies": [{"path": "/example/path/prefix",
"entries": ["user:alice:r--",
"user:bob:rw-"
]
},
{"path": "/user/%USER%",
"entries": ["user::r--",
"user:%USER%:rw-"
]
},
{"path": "/role/%ROLE%",
"entries": ["role::r--",
"role:%ROLE%:rw-"
]
}
]
}

Response samples

Content type

application/json

{"exception": "string",
"javaClassName": "string",
"message": "string",
"requestId": "string"
}

APPEND

Append local content to the end of a remote file given by the path parameter.

Note: On remote object stores that do not support a native append operation, e.g. Amazon S3, an append operation translates into a copy of the modified file.

path Parameters

path

required

string <path/to/file>

The absolute path of a file.

query Parameters

noredirect

boolean

Default: false

If this is set to true, even when the response is a temporary redirect, it will have HTTP status 200 OK and the redirection location will be in the response body.

header Parameters

X-SAP-FileContainer required	string This is the only REQUIRED header. This header is used to define which File Container the request should target. Any request is always in the context of one File Container.
X-SAP-Trusted-User	string This header is an optional header and requires the impersonate privilege in order to use it. This header allows you to set the user context of the request, making all outcomes of the request traceable back to the specified user. Note that if NOT used in conjunction with `X-SAP-Trusted-User-Roles`, the effective role of the request will be the `user` role as defined in your File Container.
X-SAP-Trusted-User-Encoding	string Enum: "ascii" "b64-utf-8" This header is optional and is only used in conjunction with `X-SAP-Trusted-User` and also requires the impersonate privilege. If the user you would like to send is not able to be represented using ASCII encoding, which is the default, you can specify a different encoding with this header. The only values currently supported are `ascii` and `b64-utf-8`. `b64-utf-8` will use `base64` decoding with the `utf-8` character set.
X-SAP-Trusted-User-Roles	string This header is optional, requires the authorize privilege in order to use, and must be used in conjunction with `X-SAP-Trusted-User`. It is used to specify the roles with which the request is to be authorized. The roles specified in this header must be `user`, `admin`, or any custom role defined in your File Container. The input is a comma separated list of roles.

Responses

Response samples

Content type

application/json

{"exception": "string",
"javaClassName": "string",
"message": "string",
"requestId": "string"
}

DELETE_BATCH

This operation allows the deletion of multiple files in one request. The body contains an object with an array of the file objects (paths) to be deleted.

query Parameters

async

boolean

Default: false

This is an optional query parameter that can be specified to indicate if the operation should be performed asynchronously. If not specified, it defaults to false.

header Parameters

X-SAP-FileContainer required	string This is the only REQUIRED header. This header is used to define which File Container the request should target. Any request is always in the context of one File Container.
X-SAP-Trusted-User	string This header is an optional header and requires the impersonate privilege in order to use it. This header allows you to set the user context of the request, making all outcomes of the request traceable back to the specified user. Note that if NOT used in conjunction with `X-SAP-Trusted-User-Roles`, the effective role of the request will be the `user` role as defined in your File Container.
X-SAP-Trusted-User-Encoding	string Enum: "ascii" "b64-utf-8" This header is optional and is only used in conjunction with `X-SAP-Trusted-User` and also requires the impersonate privilege. If the user you would like to send is not able to be represented using ASCII encoding, which is the default, you can specify a different encoding with this header. The only values currently supported are `ascii` and `b64-utf-8`. `b64-utf-8` will use `base64` decoding with the `utf-8` character set.
X-SAP-Trusted-User-Roles	string This header is optional, requires the authorize privilege in order to use, and must be used in conjunction with `X-SAP-Trusted-User`. It is used to specify the roles with which the request is to be authorized. The roles specified in this header must be `user`, `admin`, or any custom role defined in your File Container. The input is a comma separated list of roles.

Request Body schema: application/json

An object containing an array of paths of the files to be deleted.

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"files": [{"path": "/folder/file1"
},
{"path": "/folder/file2"
},
{"path": "/folder/fileN"
}
]
}

Response samples

Content type

application/json

Example

DeleteBatchSuccessfulResponse

{"boolean": true
}

MERGE

This operation allows the merging of multiple files into a single file. The body contains an object with an array of the file objects (paths) to be merged.

path Parameters

path

required

string <path/to/file>

The absolute path of the target file.

query Parameters

async

boolean

Default: false

This is an optional query parameter that can be specified to indicate if the operation should be performed asynchronously. If not specified, it defaults to false.

header Parameters

X-SAP-FileContainer required	string This is the only REQUIRED header. This header is used to define which File Container the request should target. Any request is always in the context of one File Container.
X-SAP-Trusted-User	string This header is an optional header and requires the impersonate privilege in order to use it. This header allows you to set the user context of the request, making all outcomes of the request traceable back to the specified user. Note that if NOT used in conjunction with `X-SAP-Trusted-User-Roles`, the effective role of the request will be the `user` role as defined in your File Container.
X-SAP-Trusted-User-Encoding	string Enum: "ascii" "b64-utf-8" This header is optional and is only used in conjunction with `X-SAP-Trusted-User` and also requires the impersonate privilege. If the user you would like to send is not able to be represented using ASCII encoding, which is the default, you can specify a different encoding with this header. The only values currently supported are `ascii` and `b64-utf-8`. `b64-utf-8` will use `base64` decoding with the `utf-8` character set.
X-SAP-Trusted-User-Roles	string This header is optional, requires the authorize privilege in order to use, and must be used in conjunction with `X-SAP-Trusted-User`. It is used to specify the roles with which the request is to be authorized. The roles specified in this header must be `user`, `admin`, or any custom role defined in your File Container. The input is a comma separated list of roles.

Request Body schema: application/json

An object containing an array of paths to be merged.

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"sources": [{"path": "/folder/file1"
},
{"path": "/folder/file2"
},
{"path": "/folder/fileN"
}
]
}

Response samples

Content type

application/json

{"Token": {"urlString": "aS1hbS1hLXRva2VuCg=="
}
}

RESTORESNAPSHOT

Restore the state of the File Container contents to a specific timestamp. Files can be removed, modified or deleted in order to restore the state. This is an asynchronous operation, so the user must wait until the operation is finished. A token is returned in the response body to identify the restore process. The token can be used as a parameter to the operation GETRESTORESNAPSHOTSTATUS to query the process status.

path Parameters

path

required

string <path/to/directory/>

The absolute path of the directory that should be restored. All files inside this path will be recursively restored.

query Parameters

snapshotname

required

string

An ISO 8601 timestamp to indicate the target timestamp. The timezone considered is UTC.

Example: 2019-01-01T00:00:00.000Z

header Parameters

X-SAP-FileContainer required	string This is the only REQUIRED header. This header is used to define which File Container the request should target. Any request is always in the context of one File Container.
X-SAP-Trusted-User	string This header is an optional header and requires the impersonate privilege in order to use it. This header allows you to set the user context of the request, making all outcomes of the request traceable back to the specified user. Note that if NOT used in conjunction with `X-SAP-Trusted-User-Roles`, the effective role of the request will be the `user` role as defined in your File Container.
X-SAP-Trusted-User-Encoding	string Enum: "ascii" "b64-utf-8" This header is optional and is only used in conjunction with `X-SAP-Trusted-User` and also requires the impersonate privilege. If the user you would like to send is not able to be represented using ASCII encoding, which is the default, you can specify a different encoding with this header. The only values currently supported are `ascii` and `b64-utf-8`. `b64-utf-8` will use `base64` decoding with the `utf-8` character set.
X-SAP-Trusted-User-Roles	string This header is optional, requires the authorize privilege in order to use, and must be used in conjunction with `X-SAP-Trusted-User`. It is used to specify the roles with which the request is to be authorized. The roles specified in this header must be `user`, `admin`, or any custom role defined in your File Container. The input is a comma separated list of roles.

Responses

Response samples

Content type

application/json

{"Token": {"urlString": "aS1hbS1hLXRva2VuCg=="
}
}

DELETE

Delete a file.

path Parameters

path

required

string <path/to/file>

The absolute path of a file.

header Parameters

X-SAP-FileContainer required	string This is the only REQUIRED header. This header is used to define which File Container the request should target. Any request is always in the context of one File Container.
X-SAP-Trusted-User	string This header is an optional header and requires the impersonate privilege in order to use it. This header allows you to set the user context of the request, making all outcomes of the request traceable back to the specified user. Note that if NOT used in conjunction with `X-SAP-Trusted-User-Roles`, the effective role of the request will be the `user` role as defined in your File Container.
X-SAP-Trusted-User-Encoding	string Enum: "ascii" "b64-utf-8" This header is optional and is only used in conjunction with `X-SAP-Trusted-User` and also requires the impersonate privilege. If the user you would like to send is not able to be represented using ASCII encoding, which is the default, you can specify a different encoding with this header. The only values currently supported are `ascii` and `b64-utf-8`. `b64-utf-8` will use `base64` decoding with the `utf-8` character set.
X-SAP-Trusted-User-Roles	string This header is optional, requires the authorize privilege in order to use, and must be used in conjunction with `X-SAP-Trusted-User`. It is used to specify the roles with which the request is to be authorized. The roles specified in this header must be `user`, `admin`, or any custom role defined in your File Container. The input is a comma separated list of roles.

Responses

Response samples

Content type

application/json

{"boolean": true
}

REMOVEACCESSPOLICY

Unset/Remove all access policies, effectively emptying the Access Policies JSON document.

header Parameters

X-SAP-FileContainer required	string This is the only REQUIRED header. This header is used to define which File Container the request should target. Any request is always in the context of one File Container.
X-SAP-Trusted-User	string This header is an optional header and requires the impersonate privilege in order to use it. This header allows you to set the user context of the request, making all outcomes of the request traceable back to the specified user. Note that if NOT used in conjunction with `X-SAP-Trusted-User-Roles`, the effective role of the request will be the `user` role as defined in your File Container.
X-SAP-Trusted-User-Encoding	string Enum: "ascii" "b64-utf-8" This header is optional and is only used in conjunction with `X-SAP-Trusted-User` and also requires the impersonate privilege. If the user you would like to send is not able to be represented using ASCII encoding, which is the default, you can specify a different encoding with this header. The only values currently supported are `ascii` and `b64-utf-8`. `b64-utf-8` will use `base64` decoding with the `utf-8` character set.
X-SAP-Trusted-User-Roles	string This header is optional, requires the authorize privilege in order to use, and must be used in conjunction with `X-SAP-Trusted-User`. It is used to specify the roles with which the request is to be authorized. The roles specified in this header must be `user`, `admin`, or any custom role defined in your File Container. The input is a comma separated list of roles.

Responses

Response samples

Content type

application/json

{"exception": "string",
"javaClassName": "string",
"message": "string",
"requestId": "string"
}