Skip to content

Read the Drive client configuration

GET
/drives/config.json
curl --request GET \
--url https://work.optidata.cloud/api/drives/config.json \
--header 'Authorization: Bearer <token>'

Bootstrap configuration for a Drive client: the numeric drive id, upload limits, the node types and permission constants the server recognises, and which Drive actions are denied to the caller by company policy.

Read drive.id from here instead of hard-coding the {drive} path parameter. The exact set of keys evolves with the product, so treat the document as an open object and read only the keys you need.

Client configuration for the calling user.

Media typeapplication/json

Open configuration document.

object
is_restricted

true when the caller’s company policy denies use of Drive altogether.

boolean
permissions
object
deny

Which Drive actions are denied to the caller, keyed by action name.

object
key
additional properties
boolean
key
additional properties
any
Examples
Exampleconfig
{
"is_restricted": false,
"permissions": {
"deny": {
"download_content": false,
"update_content": false,
"share_link": true,
"share_users_and_groups": false
}
}
}

Missing, malformed or expired authentication key.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Examplemissing

No bearer token sent

{
"error": "JWT passport exception: Missing bearer token in request"
}

Rate limit exceeded. Retry after the window resets.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Examplethrottled
{
"message": "Too Many Attempts."
}