Skip to content
PalomPalomAtlas

Register

POST
/api/v1/workspaces
curl --request POST \
  --url https://example.com/api/v1/workspaces \
  --header 'Content-Type: application/json' \
  --data '{ "bucket": "example", "create_new": false, "versioning": true, "object_lock": false }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
RegisterWorkspaceRequest
object
bucket
required
Bucket
string
create_new
Create New
boolean
versioning
Versioning
boolean
default: true
object_lock
Object Lock
boolean

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
WorkspaceSummary
object
id
required
Id
string format: uuid
bucket
required
Bucket
string
created_at
required
Created At
string format: date-time
bucket_exists
required
Bucket Exists
boolean
can_manage_members
required
Can Manage Members
boolean
Examplegenerated
{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "bucket": "example",
  "created_at": "2026-04-15T12:00:00Z",
  "bucket_exists": true,
  "can_manage_members": true
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}