Weaviate REST API

Weaviate REST API

API version: 1.37.0-dev

Auth

OAuth2

Base URL

Not specified.

Setup

1. Configure auth: OAuth2
2. GET / -- verify access
3. POST /replication/replicate -- create first replicate

Endpoints

101 endpoints across 17 groups. See references/api-spec.lap for full details.

root

.well-known

replication

users

authz

objects

batch

graphql

meta

schema

aliases

backups

export

cluster

nodes

tasks

classifications

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all live?" -> GET /.well-known/live
• "List all ready?" -> GET /.well-known/ready
• "List all openid-configuration?" -> GET /.well-known/openid-configuration
• "Create a replicate?" -> POST /replication/replicate
• "Create a force-delete?" -> POST /replication/replicate/force-delete
• "Get replicate details?" -> GET /replication/replicate/{id}
• "Delete a replicate?" -> DELETE /replication/replicate/{id}
• "List all list?" -> GET /replication/replicate/list
• "Create a cancel?" -> POST /replication/replicate/{id}/cancel
• "List all sharding-state?" -> GET /replication/sharding-state
• "List all scale?" -> GET /replication/scale
• "Create a scale?" -> POST /replication/scale
• "List all own-info?" -> GET /users/own-info
• "List all db?" -> GET /users/db
• "Get db details?" -> GET /users/db/{user_id}
• "Delete a db?" -> DELETE /users/db/{user_id}
• "Create a rotate-key?" -> POST /users/db/{user_id}/rotate-key
• "Create a activate?" -> POST /users/db/{user_id}/activate
• "Create a deactivate?" -> POST /users/db/{user_id}/deactivate
• "List all roles?" -> GET /authz/roles
• "Create a role?" -> POST /authz/roles
• "Create a add-permission?" -> POST /authz/roles/{id}/add-permissions
• "Create a remove-permission?" -> POST /authz/roles/{id}/remove-permissions
• "Get role details?" -> GET /authz/roles/{id}
• "Delete a role?" -> DELETE /authz/roles/{id}
• "Create a has-permission?" -> POST /authz/roles/{id}/has-permission
• "List all users?" -> GET /authz/roles/{id}/users
• "List all user-assignments?" -> GET /authz/roles/{id}/user-assignments
• "List all group-assignments?" -> GET /authz/roles/{id}/group-assignments
• "List all roles?" -> GET /authz/users/{id}/roles
• "Get role details?" -> GET /authz/users/{id}/roles/{userType}
• "Create a assign?" -> POST /authz/users/{id}/assign
• "Create a revoke?" -> POST /authz/users/{id}/revoke
• "Create a assign?" -> POST /authz/groups/{id}/assign
• "Create a revoke?" -> POST /authz/groups/{id}/revoke
• "Get role details?" -> GET /authz/groups/{id}/roles/{groupType}
• "Get group details?" -> GET /authz/groups/{groupType}
• "List all objects?" -> GET /objects
• "Create a object?" -> POST /objects
• "Delete a object?" -> DELETE /objects/{id}
• "Get object details?" -> GET /objects/{id}
• "Partially update a object?" -> PATCH /objects/{id}
• "Update a object?" -> PUT /objects/{id}
• "Get object details?" -> GET /objects/{className}/{id}
• "Delete a object?" -> DELETE /objects/{className}/{id}
• "Update a object?" -> PUT /objects/{className}/{id}
• "Partially update a object?" -> PATCH /objects/{className}/{id}
• "Update a reference?" -> PUT /objects/{id}/references/{propertyName}
• "Delete a reference?" -> DELETE /objects/{id}/references/{propertyName}
• "Update a reference?" -> PUT /objects/{className}/{id}/references/{propertyName}
• "Delete a reference?" -> DELETE /objects/{className}/{id}/references/{propertyName}
• "Create a validate?" -> POST /objects/validate
• "Create a object?" -> POST /batch/objects
• "Create a reference?" -> POST /batch/references
• "Create a graphql?" -> POST /graphql
• "Create a batch?" -> POST /graphql/batch
• "List all meta?" -> GET /meta
• "List all schema?" -> GET /schema
• "Create a schema?" -> POST /schema
• "Get schema details?" -> GET /schema/{className}
• "Delete a schema?" -> DELETE /schema/{className}
• "Update a schema?" -> PUT /schema/{className}
• "Create a property?" -> POST /schema/{className}/properties
• "Delete a index?" -> DELETE /schema/{className}/properties/{propertyName}/index/{indexName}
• "List all shards?" -> GET /schema/{className}/shards
• "Update a shard?" -> PUT /schema/{className}/shards/{shardName}
• "Create a tenant?" -> POST /schema/{className}/tenants
• "List all tenants?" -> GET /schema/{className}/tenants
• "Get tenant details?" -> GET /schema/{className}/tenants/{tenantName}
• "List all aliases?" -> GET /aliases
• "Create a aliase?" -> POST /aliases
• "Get aliase details?" -> GET /aliases/{aliasName}
• "Update a aliase?" -> PUT /aliases/{aliasName}
• "Delete a aliase?" -> DELETE /aliases/{aliasName}
• "Get backup details?" -> GET /backups/{backend}
• "Get backup details?" -> GET /backups/{backend}/{id}
• "Delete a backup?" -> DELETE /backups/{backend}/{id}
• "Create a restore?" -> POST /backups/{backend}/{id}/restore
• "List all restore?" -> GET /backups/{backend}/{id}/restore
• "Get export details?" -> GET /export/{backend}/{id}
• "Delete a export?" -> DELETE /export/{backend}/{id}
• "List all statistics?" -> GET /cluster/statistics
• "List all nodes?" -> GET /nodes
• "Get node details?" -> GET /nodes/{className}
• "List all tasks?" -> GET /tasks
• "Create a classification?" -> POST /classifications/
• "Get classification details?" -> GET /classifications/{id}
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP