Skip to content

api.md

Latest commit

 

History

History
104 lines (78 loc) · 1.72 KB

api.md

File metadata and controls

104 lines (78 loc) · 1.72 KB
sidebar_position 3
title HTTP API
description REST API endpoints and headers

HTTP API

Pod Management

Create Pod

POST /.pods
Content-Type: application/json

{"name": "alice"}

Response:

{
  "name": "alice",
  "webId": "http://localhost:3000/alice/#me",
  "podUri": "http://localhost:3000/alice/",
  "token": "..."
}

With IdP enabled:

{"name": "alice", "email": "[email protected]", "password": "secret"}

Resource Operations

GET

GET /alice/public/data.json
Accept: application/ld+json

PUT

PUT /alice/public/data.json
Authorization: Bearer TOKEN
Content-Type: application/ld+json

{"@id": "#item", "http://schema.org/name": "Value"}

POST

POST /alice/public/
Authorization: Bearer TOKEN
Content-Type: application/ld+json
Slug: new-resource

{"@id": "#item"}

DELETE

DELETE /alice/public/data.json
Authorization: Bearer TOKEN

PATCH

PATCH /alice/public/data.json
Authorization: Bearer TOKEN
Content-Type: text/n3

@prefix solid: <http://www.w3.org/ns/solid/terms#>.
_:p a solid:InsertDeletePatch;
  solid:inserts { <#x> <#y> <#z> }.

Headers

Request Headers

Header Description
Authorization Bearer TOKEN or DPoP TOKEN
Content-Type Resource MIME type
Accept Requested response format
If-Match ETag for conditional update
If-None-Match ETag for conditional create
Slug Suggested resource name for POST

Response Headers

Header Description
ETag Resource version
Link LDP type links
Updates-Via WebSocket notification URL
WAC-Allow Permitted operations