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

Download OpenAPI specification:

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

Policies

Data Lake Files Policies API operations

getPolicies

Get list of policies.

header Parameters

X-SAP-FileContainer required	string Example: 12d34ec6-6b72-4a18-ba0d-e04d62d125f4 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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.

Responses

Response samples

Content type

application/json

{"schemas": [{"id": "019a920c-ba10-7be5-8abb-c8004402736a",
"status": "ACTIVE",
"name": "policy1",
"resources": ["path:/my/path"
],
"subjects": ["user:bob"
],
"privileges": ["browse"
],
"constraints": [ ],
"createdAt": 1698777740917,
"type": "deny"
},
{"id": "b50e6be0-a8bf-4c6c-b329-b53b8060a627",
"status": "NOT_PROCESSED",
"name": "policy2",
"resources": ["path:/my/path",
"path:/my/second/path"
],
"subjects": ["role:marketing"
],
"privileges": ["browse",
"open"
],
"constraints": [ ],
"createdAt": 1698777740917,
"type": "allow"
}
]
}

getPolicy

Get a policy.

path Parameters

policyName

required

string

Policy name.

header Parameters

X-SAP-FileContainer required	string Example: 12d34ec6-6b72-4a18-ba0d-e04d62d125f4 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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.

Responses

Response samples

Content type

application/json

[{"id": "019a920c-ba10-7be5-8abb-c8004402736a",
"status": "ACTIVE",
"name": "policy1",
"resources": ["path:/path1"
],
"subjects": ["user:bob"
],
"privileges": ["browse"
],
"constraints": [ ],
"createdAt": 1698777740917,
"type": "deny"
}
]

createOrUpdatePolicy

Create or update a policy.

Note: Each policy has a limit of 8 resources, 8 subjects and 8 constraints. The following are the maximum limit to the number of policy rules:

Static Server Policies: 128

Dynamic Policies: 32

path Parameters

policyName

required

string

Policy name.

header Parameters

X-SAP-FileContainer required	string Example: 12d34ec6-6b72-4a18-ba0d-e04d62d125f4 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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.

Request Body schema: application/json
required

Policy resources, subjects and privileges.

name	string If present, it should match the URL parameter policyName.
resources required	Array of strings Resources can be of type `path` or `wildcard`. Paths must target a file prefix, e.g. `path:/mypath/myfile`. Resources can also be wildcards, e.g. `path:*`, which will apply the policy to all resources under that resource.
subjects required	Array of strings Subjects can be of type `user`, `role`, `x509`, or `` (wildcard). Type `user` refers to a user name, type `role` refers to a role name and type `x509` refers to the subject of an x509 identity. Specific subjects can be targeted, given after the `:` character, e.g. `user:bob`, `role:sales` and `x509:CN=bob`. All subjects of a type can also be targeted as a wildcard, e.g. `user:`. Using a wildcard as the subject (e.g.: `*`) will apply the policy to all subjects.
privileges required	Array of strings (Privileges) Items Enum: "browse" "open" "connect" "create" "append" "rename" "delete" "restore"
	Array of objects (Constraint)
createdAt	integer
type	string (PolicyType) Enum: "allow" "deny" Used to define the policy type.

Responses

Request samples

Payload

Content type

application/json

Example

Path Resource

A policy of type path:/my/prefix will be applied to /my/prefix. It will also act on objects created inside the prefix, for example /my/prefix/object1 and /my/prefix/inner/object2. The end slash of a prefix is ignored.

{"resources": ["path:/my/prefix"
],
"subjects": ["user:bob"
],
"privileges": ["browse",
"open"
]
}

Response samples

Content type

application/json

{"operationSequenceId": "0198a63d-687e-7465-ab13-dba03ec78143"
}

deletePolicy

Delete a policy.

path Parameters

policyName

required

string

Policy name.

header Parameters

X-SAP-FileContainer required	string Example: 12d34ec6-6b72-4a18-ba0d-e04d62d125f4 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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.

Responses

Response samples

Content type

application/json

{"operationSequenceId": "0198a63e-da15-7c3a-81a2-36e3fcc9e900"
}

getPoliciesOperationsStatus

Get the status of the policies operations.

header Parameters

X-SAP-FileContainer required	string Example: 12d34ec6-6b72-4a18-ba0d-e04d62d125f4 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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"lastOperationSequenceId": "0198a63e-da15-7c3a-81a2-36e3fcc9e900",
"lastProcessedOperationSequenceId": "0198a63d-3ffa-7390-a056-b479223ac103"
}

Trusts

Data Lake Files Trusts API operations

getTrusts

Get list of trusts.

header Parameters

X-SAP-FileContainer required	string Example: 12d34ec6-6b72-4a18-ba0d-e04d62d125f4 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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.

Responses

Response samples

200
400
401
403
500

Content type

application/json

[{"name": "sap-ias-tenant-trust",
"type": "OIDC",
"createdAt": 1742928404234,
"properties": {"issuer": "https://aghxtbtw3.accounts400.ondemand.com",
"audiences": ["dbc1e595-e5db-4de6-b234-8efb0c140da3"
]
}
},
{"name": "microsoft-eid-tenant-trust",
"type": "OIDC",
"createdAt": 1742928404234,
"properties": {"issuer": "https://sts.windows.net/fdcbd6d9-cf2c-45c6-8dce-d8f5bba9b279/",
"audiences": ["12345678-1234-1234-1234-1234567890ab"
]
}
}
]

getTrust

Get a trust.

path Parameters

trustName

required

string

Trust name.

header Parameters

X-SAP-FileContainer required	string Example: 12d34ec6-6b72-4a18-ba0d-e04d62d125f4 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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.

Responses

Response samples

Content type

application/json

{"name": "sap-ias-tenant-trust",
"type": "OIDC",
"createdAt": 1742928404234,
"properties": {"issuer": "https://aghxtbtw3.accounts400.ondemand.com",
"audiences": ["dbc1e595-e5db-4de6-b234-8efb0c140da3"
]
}
}

createOrUpdateTrust

Create or update a trust.

path Parameters

trustName

required

string

Trust name.

header Parameters

X-SAP-FileContainer required	string Example: 12d34ec6-6b72-4a18-ba0d-e04d62d125f4 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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.

Request Body schema: application/json
required

Trust name, type and properties.

name	string
type required	string
	object

Responses

Request samples

Payload

Content type

application/json

{"name": "sap-ias-tenant-trust",
"type": "OIDC",
"properties": {"issuer": "https://aghxtbtw3.accounts400.ondemand.com",
"audiences": ["dbc1e595-e5db-4de6-b234-8efb0c140da3"
]
}
}

Response samples

400
401
403
404
500

Content type

application/json

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

deleteTrust

Delete a trust.

path Parameters

trustName

required

string

Trust name.

header Parameters

X-SAP-FileContainer required	string Example: 12d34ec6-6b72-4a18-ba0d-e04d62d125f4 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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.

Responses

Response samples

400
401
403
404
500

Content type

application/json

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

WebHDFS

Data Lake Files WebHDFS API operations

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 to 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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.
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 ASCII encoded, 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 and 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.
X-SAP-Accept-Direct-Access	boolean If direct access is available, the data will be transferred without going through HDL Files. If not available, the operation will fall back to the default mode.
X-SAP-Expect-Direct-Access	boolean Direct Access is a requirement. If direct access is available, the data will be transferred without going through HDL Files. If not available, the request will fail.

Responses

Response samples

200
400
401
403
503

Content type

application/octet-stream

No sample

CHECKACCESS

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

path Parameters

path

required

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

The absolute path of a file or directory.

query Parameters

fsaction

string

The action to check. The action must follow the format (r|-)(w|-)(x|-), e.g. r--, -w- or rwx.

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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.
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 ASCII encoded, 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 and 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

200
400
401
403
503

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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.
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 ASCII encoded, 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 and 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

200
400
401
403
503

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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.
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 ASCII encoded, 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 and 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

200
400
401
403
503

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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.
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 ASCII encoded, 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 and 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

200
400
401
403
503

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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.
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 ASCII encoded, 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 and 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

200
400
401
403
503

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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.
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 ASCII encoded, 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 and 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

200
400
401
403
503

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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.
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 ASCII encoded, 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 and 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

200
400
401
403
503

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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.
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 ASCII encoded, 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 and 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

200
400
401
403
503

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, home directory of the user, and options with extra information if applicable.

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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.
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 ASCII encoded, 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 and 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

200
400
401
503

Content type

application/json

{"user": "bob",
"privileges": ["browse",
"create",
"open"
],
"home": "/prefix/bob",
"options": [{"direct-access-type": "GCS"
}
]
}

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 to 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.
data	boolean Default: false If set to true, the operation is performed without any redirect.

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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.
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 ASCII encoded, 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 and 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.
X-SAP-Accept-Direct-Access	boolean If direct access is available, the data will be transferred without going through HDL Files. If not available, the operation will fall back to the default mode.
X-SAP-Expect-Direct-Access	boolean Direct Access is a requirement. If direct access is available, the data will be transferred without going through HDL Files. If not available, the request will fail.
X-SAP-Direct-Access-GCS-Generation-Match	integer <int64> (only applicable for `direct-access-type` = `GCS`) It is used as an override protection mechanism. If the generation provided doesn't match the current generation of the file, it won't be overwritten. Note: Header `Content-Type` must be set to `application/octet-stream`. Note: Please refer to operation `WHOAMI` to fetch the value of `direct-access-type` for your CFC. If Direct Access is available, the response of `WHOAMI` will contain the `direct-access-type` under `options`.
X-SAP-Direct-Access-GCS-Upload-Type	string Enum: "RESUMABLE" "DIRECT" (only applicable for `direct-access-type` = `GCS`) Depending on the size of the object, you can leverage each kind of upload (and even both). This is a comma-separated list input. Note: Please refer to operation `WHOAMI` to fetch the value of `direct-access-type` for your CFC. If Direct Access is available, the response of `WHOAMI` will contain the `direct-access-type` under `options`. Note 2: Output will contain extra nested fields with specific information for each type of upload requested.
X-SAP-Direct-Access-S3-Content-MD5	string (only applicable for `direct-access-type` = `S3`) When receiving this header, HDL Files will use its content to sign the `Content-MD5` header when generating the pre-signed URL, so it can then be provided by the client when using direct access for content integrity validation in S3. If the value provided is not the base64-encoded 128-bit MD5 digest of the file, the subsequent request using the generated presigned URL will fail. Note: Please refer to operation `WHOAMI` to fetch the value of `direct-access-type` for your CFC. If Direct Access is available, the response of `WHOAMI` will contain the `direct-access-type` under `options`.
X-SAP-Direct-Access-S3-If-None-Match	string (only applicable for `direct-access-type` = `S3`) When receiving this header, HDL Files will sign the `If-None-Match` header when generating a pre-signed URL, so it can then be provided by the client when using direct access as an override protection mechanism (mutual exclusion). The only accepted value is `` (wildcard). Note:* Please refer to operation `WHOAMI` to fetch the value of `direct-access-type` for your CFC. If Direct Access is available, the response of `WHOAMI` will contain the `direct-access-type` under `options`.
X-SAP-Direct-Access-WASB-If-None-Match	string (only applicable for `direct-access-type` = `WASB`) It is used as an override protection mechanism. If the e-tag provided doesn't match the current e-tag of the file, it won't be overwritten. Also accepts `` as a wildcard. Note:* Please refer to operation `WHOAMI` to fetch the value of `direct-access-type` for your CFC. If Direct Access is available, the response of `WHOAMI` will contain the `direct-access-type` under `options`.

Responses

Response samples

Content type

application/json

{"type": "GCS",
"properties": {"headers": {"Range": "bytes=0-1"
},
"endpoint": "https://storage.googleapis.com/...",
"method": "GET"
}
}

RENAME

Rename the file given by the path parameter.

path Parameters

path

required

string <path/to/file>

The absolute path to 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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.
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 ASCII encoded, 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 and 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

200
400
401
403
503

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 path/to/directory/>

The absolute path of a file or directory.

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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.
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 ASCII encoded, 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 and 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

200
400
401
403
503

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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.
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 ASCII encoded, 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 and 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.

Request Body schema: application/json
required

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

400
401
403
503

Content type

application/json

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

APPEND

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

Note: Header Content-Type must be set to application/octet-stream.

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 to 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.
data	boolean Default: false If set to true, the operation is performed without any redirect.

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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.
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 ASCII encoded, 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 and 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

400
401
403
503

Content type

application/json

{"exception": "string",
"javaClassName": "string",
"message": "string",
"requestId": "string",
"timestamp": "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.

Note: Only files can be deleted, not directories. Note: Non-existent files are silently ignored, since "file not found" is not considered an error.

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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.
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 ASCII encoded, 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 and 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.

Request Body schema: application/json
required

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 OR path/to/directory/>

The absolute path of a file or directory.

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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.
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 ASCII encoded, 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 and 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.

Request Body schema: application/json
required

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

202
413

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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.
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 ASCII encoded, 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 and 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

200
400
401
403
503

Content type

application/json

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

DELETE

Delete a file.

path Parameters

path

required

string <path/to/file>

The absolute path to a file.

query Parameters

recursive

boolean

Default: false

If set to true, the path will be recursively deleted. To delete a folder recursively, the user needs authorization for all the paths inside it. If there is a file inside the folder to be deleted with a policy that disallows the user to delete it, the operation will fail with a 403 FORBIDDEN and nothing will be deleted.

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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.
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 ASCII encoded, 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 and 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

200
400
401
403
503

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-Request-ID	string Example: 5966e186-fbd9-4507-a2e7-d130da18ca1e This header is used to assign an ID to the request, which is expected to uniquely identify it. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. If it is not set, a random ID is assigned in the format of an UUID.
X-Correlation-ID	string This header is used to assign a correlation ID to the request, which is expected to be used to identify a series of related HTTP requests, or a chain of events. The ID can contain only letters (a-z, A-Z), numbers, the whitespace character, and the following special characters _:;.,\/"'?!(){}[]@<>=-+*#$&`\|~^%. This header will not be returned if not provided.
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 ASCII encoded, 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 and 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

400
401
403
503

Content type

application/json

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

Recovery

Data Lake Files Recovery API operations

List Recovery Jobs

List recovery jobs.

header Parameters

X-SAP-FileContainer

required

string

Example: 12d34ec6-6b72-4a18-ba0d-e04d62d125f4

This header is used to define which File Container the request should target. Any request is always in the context of one File Container.

Responses

Response samples

200
413
500

Content type

application/json

{"jobs": [{"id": "string",
"timestamp": "string",
"user": "string",
"status": "PENDING",
"resources": ["file-policy",
"path",
"policy",
"trust"
],
"messages": ["string"
],
"createdAt": "string"
}
]
}

Get Recovery Job

Get recovery job by given ID.

header Parameters

X-SAP-FileContainer

required

string

Example: 12d34ec6-6b72-4a18-ba0d-e04d62d125f4

This header is used to define which File Container the request should target. Any request is always in the context of one File Container.

Responses

Response samples

200
404
413
500

Content type

application/json

{"id": "string",
"timestamp": "string",
"user": "string",
"status": "PENDING",
"resources": ["file-policy",
"path",
"policy",
"trust"
],
"messages": ["string"
],
"createdAt": "string"
}

Submit Recovery Job

Submit a new recovery job to be identified by the given ID.

An asterisk (*) is a collection identifier. If an asterisk is meant to be part of the resource name (and not a collection identifier), it must be escaped using double backslashes (\\).

Asterisk as a collection identifier usage

When an asterisk is used alone and not escaped, it represents all resources of that type.

Examples:

trust:* - Recovers the collection of all trusts

Asterisk as a literal character usage

Examples:

trust:ab\\*c - Recovers the trust named ab*c

Invalid usage

If an asterisk appears inside a resource name without being escaped, it is invalid and will be rejected.

Example:

trust:a* - Invalid (the asterisk is not escaped)

header Parameters

X-SAP-FileContainer

required

string

Example: 12d34ec6-6b72-4a18-ba0d-e04d62d125f4

This header is used to define which File Container the request should target. Any request is always in the context of one File Container.

Request Body schema: application/json
required

Configuration for the recovery procedure.

timestamp

required

string <date-time>

Timestamp in ISO 8601 format representing the target snapshot.

resources

required

Array of strings

The resources to be recovered. The following resource types are supported:

file-policy:* - All legacy access policies
path:[path-prefix] - A file or path prefix
policy:[policy-name] - An access policy defined using the Policies API
trust:[trust-name] - A trust defined using the Trusts API
* - The collection of all resources

Collections of all resource types can be specified, such as path:*, policy:*, trust:* .

Resource file-policy:* must always be specified as a collection.

Responses

Request samples

Payload

Content type

application/json

Example

File Policy

{"timestamp": "2025-08-19T10:00:00.000Z",
"resources": ["file-policy:*"
]
}

Response samples

202
400
409
500

Content type

application/json

{"id": "string"
}

Cancel Recovery Job

Cancel a pending or running recovery job by given ID.

header Parameters

X-SAP-FileContainer

required

string

Example: 12d34ec6-6b72-4a18-ba0d-e04d62d125f4

This header is used to define which File Container the request should target. Any request is always in the context of one File Container.

Responses

Response samples

202
404
409
413
500

Content type

application/json

{"id": "string"
}

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

Policies

getPolicies

header Parameters

Responses

Response samples

getPolicy

path Parameters

header Parameters

Responses

Response samples

createOrUpdatePolicy

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

deletePolicy

path Parameters

header Parameters

Responses

Response samples

getPoliciesOperationsStatus

header Parameters

Responses

Response samples

Trusts

getTrusts

header Parameters

Responses

Response samples

getTrust

path Parameters

header Parameters

Responses

Response samples

createOrUpdateTrust

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

deleteTrust

path Parameters

header Parameters

Responses

Response samples

WebHDFS

OPEN

path Parameters

query Parameters

header Parameters

Responses

Response samples

CHECKACCESS

path Parameters

query Parameters

header Parameters

Responses

Response samples

GETACCESSPOLICY

query Parameters

header Parameters

Responses

Response samples

GETOPERATIONSTATUS

query Parameters

header Parameters

Responses

Response samples

GETRESTORESNAPSHOTSTATUS

query Parameters

header Parameters

Responses

Response samples

GETFILESTATUS

path Parameters

header Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required