Skip to content
Atlas
Search
Ctrl
K
Cancel
GitLab
Select theme
Dark
Light
Auto
Introduction
Alternatives
Concepts
Definition
Architecture
Installation
Quickstart
Docker
Kubernetes
Configuration
Database & Storage
CORS & Authentication
Authorization
Webhooks
Authentication
Observabilité
Logs
Metrics
Intégration
SDK Python
Guides
Connect an S3 bucket
Configure SSO with Keycloak
Create and configure a workspace
Write a webhook
API Référence
Overview
Health
Liveness
Readiness
auth
Login
Oidc Login
Oidc Callback
Logout
Me
uploads
Hooks
Document
Search
Declare
Get Document
Delete Document
Update Document
Refresh Document
Links
List Links
Link Documents
Unlink Documents
Update Link
Events
List Events
Object
Browse
Delete Object
Detail
Rename
Move
Create Folder
Delete Folder
Download Url
Preview Url
S3 Tags
Update S3 Tags
S3 Metadata
Set Legal Hold
Set Retention
List Versions
Delete Version
Version Download Url
Restore Version
Bucket
List All
Create
Detail
Set Versioning
Update Tags
Set Lifecycle
Set Encryption
Stats
Scan
Workspaces
List All
Register
Detail
Delete
Scan
List Roles
Create Role
Delete Role
Update Role
Principals
List Principals
Create
Update
Set Principal Password
Clear Principal Password
API Keys
List All
Issue
Revoke
Metrics
Metrics
GitLab
Select theme
Dark
Light
Auto
Overview
Atlas
0.1.0
Section titled “Atlas 0.1.0”
Information
OpenAPI version:
3.1.0
Operations
Section titled “Operations”
GET
/livez
GET
/readyz
POST
/api/v1/auth/login
GET
/api/v1/auth/oidc/login
GET
/api/v1/auth/oidc/callback
POST
/api/v1/auth/logout
GET
/api/v1/auth/me
POST
/api/v1/uploads/hooks
GET
/api/v1/documents
POST
/api/v1/documents
GET
/api/v1/documents/{document_id}
DELETE
/api/v1/documents/{document_id}
PATCH
/api/v1/documents/{document_id}
POST
/api/v1/documents/{document_id}/refresh
GET
/api/v1/documents/{document_id}/links
POST
/api/v1/documents/{document_id}/links
DELETE
/api/v1/documents/{document_id}/links/{link_id}
PATCH
/api/v1/documents/{document_id}/links/{link_id}
GET
/api/v1/events
GET
/api/v1/object
DELETE
/api/v1/object
GET
/api/v1/object/detail
POST
/api/v1/object/rename
POST
/api/v1/object/move
POST
/api/v1/object/folders
DELETE
/api/v1/object/folders
GET
/api/v1/object/download-url
GET
/api/v1/object/preview-url
GET
/api/v1/object/s3-tags
PATCH
/api/v1/object/s3-tags
GET
/api/v1/object/s3-metadata
PUT
/api/v1/object/legal-hold
PUT
/api/v1/object/retention
GET
/api/v1/object/versions
DELETE
/api/v1/object/versions
GET
/api/v1/object/versions/download-url
POST
/api/v1/object/versions/restore
GET
/api/v1/buckets
POST
/api/v1/buckets
GET
/api/v1/buckets/{bucket}
PUT
/api/v1/buckets/{bucket}/versioning
PATCH
/api/v1/buckets/{bucket}/tags
PUT
/api/v1/buckets/{bucket}/lifecycle
PUT
/api/v1/buckets/{bucket}/encryption
GET
/api/v1/buckets/{bucket}/stats
POST
/api/v1/buckets/{bucket}/scan
GET
/api/v1/workspaces
POST
/api/v1/workspaces
GET
/api/v1/workspaces/{bucket}
DELETE
/api/v1/workspaces/{workspace_id}
POST
/api/v1/workspaces/{workspace}/scan
GET
/api/v1/workspaces/{workspace_id}/roles
POST
/api/v1/workspaces/{workspace_id}/roles
DELETE
/api/v1/workspaces/{workspace_id}/roles/{role_id}
PATCH
/api/v1/workspaces/{workspace_id}/roles/{role_id}
GET
/api/v1/principals
POST
/api/v1/principals
PATCH
/api/v1/principals/{principal_id}
POST
/api/v1/principals/{principal_id}/password
DELETE
/api/v1/principals/{principal_id}/password
GET
/api/v1/api-keys
POST
/api/v1/api-keys
DELETE
/api/v1/api-keys/{principal_id}
GET
/api/v1/metrics