OpenProject File Links API
The File Links API from OpenProject — 14 operation(s) for file links.
The File Links API from OpenProject — 14 operation(s) for file links.
openapi: 3.1.2
info:
description: "You're looking at the current **stable** documentation of the OpenProject APIv3. If you're interested in the current\ndevelopment version, please go to [github.com/opf](https://github.com/opf/openproject/tree/dev/docs/api/apiv3).\n\n## Introduction\n\nThe documentation for the APIv3 is written according to the [OpenAPI 3.1 Specification](https://swagger.io/specification/).\nYou can either view the static version of this documentation on the [website](https://www.openproject.org/docs/api/introduction/)\nor the interactive version, rendered with [OpenAPI Explorer](https://github.com/Rhosys/openapi-explorer/blob/main/README.md),\nin your OpenProject installation under `/api/docs`.\nIn the latter you can try out the various API endpoints directly interacting with our OpenProject data.\nMoreover you can access the specification source itself under `/api/v3/spec.json` and `/api/v3/spec.yml`\n(e.g. [here](https://community.openproject.org/api/v3/spec.yml)).\n\nThe APIv3 is a hypermedia REST API, a shorthand for \"Hypermedia As The Engine Of Application State\" (HATEOAS).\nThis means that each endpoint of this API will have links to other resources or actions defined in the resulting body.\n\nThese related resources and actions for any given resource will be context sensitive. For example, only actions that the\nauthenticated user can take are being rendered. This can be used to dynamically identify actions that the user might take for any\ngiven response.\n\nAs an example, if you fetch a work package through the [Work Package endpoint](https://www.openproject.org/docs/api/endpoints/work-packages/), the `update` link will only\nbe present when the user you authenticated has been granted a permission to update the work package in the assigned project.\n\n## HAL+JSON\n\nHAL is a simple format that gives a consistent and easy way to hyperlink between resources in your API.\nRead more in the following specification: [https://tools.ietf.org/html/draft-kelly-json-hal-08](https://tools.ietf.org/html/draft-kelly-json-hal-08)\n\n**OpenProject API implementation of HAL+JSON format** enriches JSON and introduces a few meta properties:\n\n- `_type` - specifies the type of the resource (e.g.: WorkPackage, Project)\n- `_links` - contains all related resource and action links available for the resource\n- `_embedded` - contains all embedded objects\n\nHAL does not guarantee that embedded resources are embedded in their full representation, they might as well be\npartially represented (e.g. some properties can be left out).\nHowever in this API you have the guarantee that whenever a resource is **embedded**, it is embedded in its **full representation**.\n\n## API response structure\n\nAll API responses contain a single HAL+JSON object, even collections of objects are technically represented by\na single HAL+JSON object that itself contains its members. More details on collections can be found\nin the [Collections Section](https://www.openproject.org/docs/api/collections/).\n\n## Authentication\n\nThe API supports the following authentication schemes:\n\n* Session-based authentication\n* API tokens\n * passed as Bearer token\n * passed via Basic auth\n* OAuth 2.0\n * using built-in authorization server\n * using an external authorization server (RFC 9068)\n\nDepending on the settings of the OpenProject instance many resources can be accessed without being authenticated.\nIn case the instance requires authentication on all requests the client will receive an **HTTP 401** status code\nin response to any request.\n\nOtherwise unauthenticated clients have all the permissions of the anonymous user.\n\n### Session-based authentication\n\nThis means you have to login to OpenProject via the Web-Interface to be authenticated in the API.\nThis method is well-suited for clients acting within the browser, like the Angular-Client built into OpenProject.\n\nIn this case, you always need to pass the HTTP header `X-Requested-With \"XMLHttpRequest\"` for authentication.\n\n### API token as bearer token\n\nUsers can authenticate towards the API v3 using an API token as a bearer token.\n\nFor example:\n\n```shell\nAPI_KEY=opapi-2519132cdf62dcf5a66fd96394672079f9e9cad1\ncurl -H \"Authorization: Bearer $API_KEY\" https://community.openproject.org/api/v3/users/42\n```\n\nUsers can generate API tokens on their account page.\n\n### API token through Basic Auth\n\nAPI tokens can also be used with basic auth, using the user name `apikey` (NOT your login) and the API token as the password.\n\nFor example:\n\n```shell\nAPI_KEY=opapi-2519132cdf62dcf5a66fd96394672079f9e9cad1\ncurl -u apikey:$API_KEY https://community.openproject.org/api/v3/users/42\n```\n\n### OAuth 2.0 authentication\n\nOpenProject allows authentication and authorization with OAuth2 with *Authorization code flow*, as well as *Client credentials* operation modes.\n\nTo get started, you first need to register an application in the OpenProject OAuth administration section of your installation.\nThis will save an entry for your application with a client unique identifier (`client_id`) and an accompanying secret key (`client_secret`).\n\nYou can then use one the following guides to perform the supported OAuth 2.0 flows:\n\n- [Authorization code flow](https://oauth.net/2/grant-types/authorization-code)\n\n- [Authorization code flow with PKCE](https://doorkeeper.gitbook.io/guides/ruby-on-rails/pkce-flow), recommended for clients unable to keep the client_secret confidential\n\n- [Client credentials](https://oauth.net/2/grant-types/client-credentials/) - Requires an application to be bound to an impersonating user for non-public access\n\n### OAuth 2.0 using an external authorization server\n\nThere is a possibility to use JSON Web Tokens (JWT) generated by an OIDC provider configured in OpenProject as a bearer token to do authenticated requests against the API.\nThe following requirements must be met:\n\n- OIDC provider must be configured in OpenProject with **jwks_uri**\n- JWT must be signed using RSA algorithm\n- JWT **iss** claim must be equal to OIDC provider **issuer**\n- JWT **aud** claim must contain the OpenProject **client ID** used at the OIDC provider\n- JWT **scope** claim must include a valid scope to access the desired API (e.g. `api_v3` for APIv3)\n- JWT must be actual (neither expired or too early to be used)\n- JWT must be passed in Authorization header like: `Authorization: Bearer {jwt}`\n- User from **sub** claim must be linked to OpenProject before (e.g. by logging in), otherwise it will be not authenticated\n\nIn more general terms, OpenProject should be compliant to [RFC 9068](https://www.rfc-editor.org/rfc/rfc9068) when validating access tokens.\n\n### Why not username and password?\n\nThe simplest way to do basic auth would be to use a user's username and password naturally.\nHowever, OpenProject already has supported API keys in the past for the API v2, though not through basic auth.\n\nUsing **username and password** directly would have some advantages:\n\n* It is intuitive for the user who then just has to provide those just as they would when logging into OpenProject.\n\n* No extra logic for token management necessary.\n\nOn the other hand using **API keys** has some advantages too, which is why we went for that:\n\n* If compromised while saved on an insecure client the user only has to regenerate the API key instead of changing their password, too.\n\n* They are naturally long and random which makes them invulnerable to dictionary attacks and harder to crack in general.\n\nMost importantly users may not actually have a password to begin with. Specifically when they have registered\nthrough an OpenID Connect provider.\n\n## Cross-Origin Resource Sharing (CORS)\n\nBy default, the OpenProject API is _not_ responding with any CORS headers.\nIf you want to allow cross-domain AJAX calls against your OpenProject instance, you need to enable CORS headers being returned.\n\nPlease see [our API settings documentation](https://www.openproject.org/docs/system-admin-guide/api-and-webhooks/) on\nhow to selectively enable CORS.\n\n## Allowed HTTP methods\n\n- `GET` - Get a single resource or collection of resources\n\n- `POST` - Create a new resource or perform\n\n- `PATCH` - Update a resource\n\n- `DELETE` - Delete a resource\n\n## Compression\n\nResponses are compressed if requested by the client. Currently [gzip](https://www.gzip.org/) and [deflate](https://tools.ietf.org/html/rfc1951)\nare supported. The client signals the desired compression by setting the [`Accept-Encoding` header](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3).\nIf no `Accept-Encoding` header is send, `Accept-Encoding: identity` is assumed which will result in the API responding uncompressed."
title: OpenProject API V3 (Stable) Actions & Capabilities File Links API
version: '3'
servers:
- url: https://qa.openproject-edge.com
description: Edge QA instance
- url: https://qa.openproject-stage.com
description: Staging instance
- url: https://community.openproject.org
description: Community instance
security:
- BasicAuth: []
tags:
- name: File Links
paths:
/api/v3/project_storages:
get:
summary: Gets a list of project storages
operationId: list_project_storages
tags:
- File Links
description: Gets a collection of all project storages that meet the provided filters and the user has permission to see them.
parameters:
- name: filters
in: query
required: false
schema:
default: '[]'
type: string
description: 'JSON specifying filter conditions.
Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/)
endpoint. Currently supported filters are:
- project_id
- storage_id
- storage_url'
example: '[{ "project_id": { "operator": "=", "values": ["42"] }}, { "storage_id": { "operator": "=", "values": ["1337"] }}]'
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ProjectStorageCollectionModel'
'400':
description: Returned if any given filter is invalid.
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:InvalidQuery
message: The query parameter 'filters' is missing or malformed.
/api/v3/project_storages/{id}:
get:
summary: Gets a project storage
operationId: get_project_storage
tags:
- File Links
description: 'Gets a project storage resource. This resource contains all data that is applicable on the relation between a
storage and a project.'
parameters:
- name: id
description: Project storage id
in: path
required: true
schema:
type: integer
example: 1337
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ProjectStorageModel'
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The requested resource could not be found.
description: 'Returned if the project storage does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view file links'
/api/v3/project_storages/{id}/open:
get:
summary: Open the project storage
operationId: open_project_storage
tags:
- File Links
description: 'Gets a redirect to the location of the project storage''s remote origin. If the project storage has a project
folder, it is opened at this location. If not, the storage root is opened.'
parameters:
- name: id
description: Project storage id
in: path
required: true
schema:
type: integer
example: 1337
responses:
'303':
description: Redirect
headers:
Location:
schema:
type: string
format: uri
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:Unauthenticated
message: You are not authorized to access this resource.
description: Returned if the authorization token of the current user grants no permission to access the remote storage.
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The requested resource could not be found.
description: 'Returned if the project storage does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view file links'
/api/v3/storages/{id}/open:
get:
summary: Open the storage
operationId: open_storage
tags:
- File Links
description: 'Gets a redirect to the location of the storage''s remote origin. The storage''s files root should be the target
location.'
parameters:
- name: id
description: Storage id
in: path
required: true
schema:
type: integer
example: 1337
responses:
'303':
description: Redirect
headers:
Location:
schema:
type: string
format: uri
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The requested resource could not be found.
description: 'Returned if the storage does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view file links'
/api/v3/file_links/{id}:
get:
summary: Gets a file link.
operationId: view_file_link
tags:
- File Links
description: Gets a single file link resource of a work package.
parameters:
- name: id
description: File link id
in: path
required: true
schema:
type: integer
example: 42
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/FileLinkReadModel'
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The requested resource could not be found.
description: 'Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package, view file links'
delete:
summary: Removes a file link.
operationId: delete_file_link
tags:
- File Links
description: 'Removes a file link on a work package.
The request contains only the file link identifier as a path parameter. No request body is needed.'
parameters:
- name: id
description: File link id
in: path
required: true
schema:
type: integer
example: 42
responses:
'200':
description: OK
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not authorized to access this resource.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** manage file links
*Note that you will only receive this error, if you are at least allowed to see the corresponding work package.*'
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The requested resource could not be found.
description: 'Returned if the work package or the file link does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view work package, view file links'
/api/v3/file_links/{id}/open:
get:
summary: Creates an opening uri of the linked file.
operationId: open_file_link
tags:
- File Links
description: 'Creates a uri to open the origin file linked by the given file link. This uri depends on the storage type and
is always located on the origin storage itself.'
parameters:
- name: id
description: File link id
in: path
required: true
schema:
type: integer
example: 42
- name: location
description: Boolean flag indicating, if the file should be opened directly or rather the directory location.
in: query
required: false
schema:
type: boolean
example: true
responses:
'303':
headers:
Location:
schema:
type: string
format: uri
description: 'Returned if the request was successful. In the `Location` header is the uri where the client can open the origin
file on the storage.'
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The requested resource could not be found.
description: 'Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package, view file links'
/api/v3/file_links/{id}/download:
get:
summary: Creates a download uri of the linked file.
operationId: download_file_link
tags:
- File Links
description: 'Creates a uri to download the origin file linked by the given file link. This uri depends on the storage type and
is always located on the origin storage itself.'
parameters:
- name: id
description: File link id
in: path
required: true
schema:
type: integer
example: 42
responses:
'303':
headers:
Location:
schema:
type: string
format: uri
description: 'Returned if the request was successful. In the `Location` header is the uri where the client can download the
origin file from the storage.'
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The requested resource could not be found.
description: 'Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package, view file links'
/api/v3/storages:
get:
summary: Get Storages
operationId: list_storages
tags:
- File Links
description: Returns a collection of storages.
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/StorageCollectionModel'
examples:
Simple storage collection:
$ref: '#/components/examples/StoragesSimpleCollectionModel'
'400':
description: Returned if the client sends invalid request parameters e.g. filters
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:InvalidQuery
message: Filters Invalid filter does not exist.
post:
summary: Creates a storage.
operationId: create_storage
tags:
- File Links
description: 'Creates a storage resource. When creating a storage, a confidential OAuth 2 provider application is created
automatically. The oauth client id and secret of the created OAuth application are returned in the response.
**IMPORTANT:** This is the only time, the oauth client secret is visible to the consumer. After that, the secret is
hidden.
To update the storage with OAuth client credentials, which enable the storage resource to behave as an OAuth 2
client against an external OAuth 2 provider application, another request must be made to create those, see
`POST /api/v3/storages/{id}/oauth_client_credentials`.'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StorageWriteModel'
responses:
'201':
description: Created
content:
application/hal+json:
schema:
$ref: '#/components/schemas/StorageReadModel'
'400':
$ref: '#/components/responses/InvalidRequestBody'
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not authorized to access this resource.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** Depends on the page the grid is defined for.'
'406':
$ref: '#/components/responses/MissingContentType'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
'422':
description: 'Returned if:
* a constraint for a property was violated (`PropertyConstraintViolation`)'
/api/v3/storages/{id}:
get:
summary: Get a storage
operationId: get_storage
tags:
- File Links
description: 'Gets a storage resource. As a side effect, a live connection to the storages origin is established to retrieve
connection state data.'
parameters:
- name: id
description: Storage id
in: path
required: true
schema:
type: integer
example: 1337
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/StorageReadModel'
examples:
Nextcloud storage:
$ref: '#/components/examples/StorageNextcloudResponse'
Freshly created Nextcloud storage:
$ref: '#/components/examples/StorageNextcloudResponseForCreation'
OneDrive storage:
$ref: '#/components/examples/StorageOneDriveResponse'
Incomplete OneDrive storage:
$ref: '#/components/examples/StorageOneDriveIncompleteResponse'
Unauthorized Nextcloud storage:
$ref: '#/components/examples/StorageNextcloudUnauthorizedResponse'
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The requested resource could not be found.
description: 'Returned if the storage does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view file links'
patch:
summary: Update a storage
operationId: update_storage
tags:
- File Links
description: 'Updates a storage resource. Only data that is not generated by the server can be updated. This excludes the OAuth 2
application data.'
parameters:
- name: id
description: Storage id
in: path
required: true
schema:
type: integer
example: 1337
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StorageWriteModel'
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/StorageReadModel'
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not authorized to access this resource.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** admin'
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The requested resource could not be found.
description: 'Returned if the storage does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view file links'
delete:
summary: Delete a storage
operationId: delete_storage
tags:
- File Links
description: 'Deletes a storage resource. This also deletes all related records, like the created oauth application, client, and
any file links created within this storage.'
parameters:
- name: id
description: Storage id
in: path
required: true
schema:
type: integer
example: 1337
responses:
'204':
description: No content
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not authorized to access this resource.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** admin'
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The requested resource could not be found.
description: 'Returned if the storage does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view file links'
/api/v3/storages/{id}/files:
get:
summary: Gets files of a storage.
operationId: get_storage_files
tags:
- File Links
description: 'Gets a collection of files from a storage.
If no `parent` context is given, the result is the content of the document root. With `parent` context given, the
result contains the collections of files/directories from within the given parent file id.
If given `parent` context is no directory, `400 Bad Request` is returned.'
parameters:
- name: id
description: Storage id
in: path
required: true
schema:
type: integer
example: 1337
- name: parent
description: Parent file identification
in: query
required: false
schema:
type: string
example: /my/data
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/StorageFilesModel'
'400':
description: Returned if the given parent parameter value does not refer to a directory.
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:InvalidQuery
message: The given parent is not a directory.
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The requested resource could not be found.
description: "Returned in either of those cases:\n- if the storage does not exist or the client does not have sufficient permissions to see it\n\n **Required permission:** view file links\n- if the document root file identification does not exist on the storage"
/api/v3/storages/{id}/files/prepare_upload:
post:
summary: Preparation of a direct upload of a file to the given storage.
operationId: prepare_storage_file_upload
tags:
- File Links
description: 'Executes a request that prepares a link for a direct upload to the storage.
The background here is, that the client needs to make a direct request to the storage instance for file uploading,
but should not get access to the credentials, which are stored in the backend. The response contains a link object,
that enables the client to execute a file upload without the real credentials.'
parameters:
- name: id
description: Storage id
in: path
required: true
schema:
type: integer
example: 1337
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StorageFileUploadPreparationModel'
responses:
'201':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/StorageFileUploadLinkModel'
'400':
description: Returned if the given parent parameter value does not refer to a directory.
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:InvalidQuery
message: The given parent is not a directory.
'403':
content:
application/hal+json:
schema:
$ref: '#/componen
# --- truncated at 32 KB (100 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openproject/refs/heads/main/openapi/openproject-file-links-api-openapi.yml