h3 { background-color: #eee; padding: 0.6em; }

curl -H "Accept: text/turtle" "http://localhost:8080/rest/"

Status: 200
 
Headers:
ETag: "686897696a7c876b7e"
Content-Type: text/turtle
Content-Length: 123456
Cache-Control: 
Last-Modified-At: 2013-01-01T01:23:45Z
Link: http://localhost:8080/rest/?offset=0&limit=10;rel="first"
Link: http://www.w3.org/ns/ldp/Resource;rel="type"
Accept-Patch: application/sparql-update
 
Body:
<x> <y> <z>

curl -X POST "http://localhost:8080/rest/some/path/to/a/new/resource"

Status: 201 Created

curl -X POST "http://localhost:8080/rest/this/node/already/exists"

Status: 201 Created
 
Headers:
Location: http://localhost:8080/rest/this/node/already/exists/some/generated/identifier

curl -X POST -H "Slug: new-node-name" "http://localhost:8080/rest/this/node/already/exists"

Status: 201 Created
 
Headers:
Location: http://localhost:8080/rest/this/node/already/exists/new/node/name

The slug you provide does not guarantee the location of the created node. Clients must check the Location header for the path to the created resource. For full control over the generated path, see POST Create a new node at the given path (link me!)

An RDF payload can be combined with any of the above forms.

RDF will be interpreted using the current resource as the base URI (e.g. <> will be expanded to the current URI)

curl -X POST -H "Content-Type: text/turtle" "http://localhost:8080/rest/node/to/create" -d "@body.rdf"
 
Request Body:
<> dc:title "some-resource-title"
 

Status: 201 Created
 
Headers:
Location: http://localhost:8080/rest/node/to/create

RDF will be interpreted using the current resource as the base URI (e.g. <> will be expanded to the current URI)

curl -X POST -H "Content-Type: application/sparql-update" "http://localhost:8080/rest/node/to/create" -d "@body.rdf"
 
Request Body:
 
INSERT {   
  <> dc:title "some-resource-title" .
}
WHERE { }
 

Status: 201 Created
 
Headers:
Location: http://localhost:8080/rest/node/to/create

If the binary content is RDF or a SPARQL-Update query, see Binary Content for an alternative way to create content

curl -X POST "http://localhost:8080/rest/binary/resource/to/create" -d "@picture.jpg"

Status: 201 Created
 
Headers:
Location: http://localhost:8080/rest/binary/resource/to/create/fcr:content

By convention, binary content is accessed using the REST endpoint path/to/resource/fcr:content.

Some resource properties are repository managed and cannot be removed or modified. Any attempt to do so may result in a 4xx error.

RDF will be interpreted using the current resource as the base URI (e.g. <> will be expanded to the current URI)

curl -X PATCH -H "Content-Type: application/sparql-update" "http://localhost:8080/rest/node/to/update" -d "@body.rdf"
 
Request Body:
 
INSERT {   
  <> dc:title "some-resource-title" .
}
WHERE { }
 

Status: 204 No Content

curl -X DELETE "http://localhost:8080/rest/node/to/delete"

Status: 204 No Content

curl -X MOVE -H "Destination: http://localhost:8080/rest/new/path/to/node" "http://localhost:8080/rest/path/to/node"

Status: 201 Created
 
Headers:
Location: http://localhost:8080/rest/new/path/to/node

curl -X COPY -H "Destination: http://localhost:8080/rest/new/path/to/node" "http://localhost:8080/rest/path/to/node"

Status: 201 Created
 
Headers:
Location: http://localhost:8080/rest/new/path/to/node

curl "http://localhost:8080/rest/path/to/some/resource/fcr:content"

Status: 200
 
Headers:
ETag: "686897696a7c876b7e"
Content-Type: image/jpeg
Content-Length: 123456
Cache-Control: 
Last-Modified-At: 2013-01-01T01:23:45Z
Link: http://localhost:8080/rest/path/to/some/resource;rel="meta"
Accept-Ranges: bytes
 
Body:
<binary content>

curl -X POST -d "@image.jpg" "http://localhost:8080/rest/path/to/new/resource/fcr:content" 
Body:
<binary content>

Status: 201 Created
 
Headers:
Location: http://localhost:8080/rest/path/to/new/resource/fcr:content

curl -X POST -d "@image.jpg" "http://localhost:8080/rest/path/to/some/existing/resource/fcr:content" 
Body:
<binary content>

Status: 204 No Content

An HTTP method returning multipart/form-data is non-standard and a little unusual, but it seems to work well enough.

curl "http://localhost:8080/rest/path/to/some/resource/fcr:datastreams?dsid=content&dsid=thumbnail"

Status: 200 OK
 
Headers:
ETag: "686897696a7c876b7e"
Content-Type: multipart/form-data; boundary=AaB03x
Content-Length: 123456
Cache-Control: 
Last-Modified-At: 2013-01-01T01:23:45Z
 
Body:
--AaB03x
Content-Disposition: attachment; filename="content"
Content-Type: image/tiff
<binary content>
--AaB03x
Content-Disposition: attachment; filename="thumbnail"
Content-Type: image/jpeg
<binary content>

curl "http://localhost:8080/rest/path/to/some/resource/fcr:export"

Status: 200
 
Headers:
Content-Type: application/xml
Body:
<jcrxml:jcrxml xmlns:jcrxml="" /> 

curl -X POST -d "@export.xml" "http://localhost:8080/rest/path/to/some/resource/fcr:import?format=jcr/xml"
 
Body:
<jcrxml:jcrxml xmlns:jcrxml="" /> 

Status: 201 Created
 
Headers:
Location: http://localhost:8080/rest/path/to/some/resource/

Versioning is not fully implemented in Fedora 4 alpha

The backup will be stored in a temporary directory on the server. As yet, there is not a REST API method for retrieving the content of the backup.

curl -X POST "http://localhost:8080/rest/fcr:backup"

Status: 200

 
Body:
/tmp/fcrepo4-data/path/to/backup/directory

Does this overwrite existing data? Merge data with the backup?

curl -X POST -d "@backup.xml" "http://localhost:8080/rest/fcr:restore"
 
Body:
<binary content>

Status: 204 No Content

curl -X POST "http://localhost:8080/rest/fcr:identifier"

Status: 200 OK
 
Headers:
Content-Type: text/turtle
 
Body:
 
<http://localhost:8080/rest/fcr:identifier> <http://fedora.info/definitions/v4/repository#hasMember> <<http://localhost:8080/rest/newly-minted-identifier>

curl -X POST "http://localhost:8080/rest/fcr:identifier?numPids=3"

Status: 200 OK
 
Headers:
Content-Type: text/turtle
 
Body:
 
<http://localhost:8080/rest/fcr:identifier> <http://fedora.info/definitions/v4/repository#hasMember> <http://localhost:8080/rest/newly-minted-identifier><http://localhost:8080/rest/fcr:identifier> <http://fedora.info/definitions/v4/repository#hasMember> <http://localhost:8080/rest/another-newly-minted-identifier><http://localhost:8080/rest/fcr:identifier> <http://fedora.info/definitions/v4/repository#hasMember> <http://localhost:8080/rest/yet-another-minted-identifier>

curl -X POST "http://localhost:8080/rest/path/to/some/resource/fcr:identifier"

Status: 200 OK
 
Headers:
Content-Type: text/turtle
 
Body:
 
<http://localhost:8080/rest/path/to/some/resource/fcr:identifier> <http://fedora.info/definitions/v4/repository#hasMember> <http://localhost:8080/rest/path/to/some/resource/newly-minted-identifier>
<http://localhost:8080/rest/path/to/some/resource/fcr:identifier> <http://fedora.info/definitions/v4/repository#hasMember> <http://localhost:8080/rest/path/to/some/resource/another-newly-minted-identifier>
<http://localhost:8080/rest/path/to/some/resource/fcr:identifier> <http://fedora.info/definitions/v4/repository#hasMember> <http://localhost:8080/rest/path/to/some/resource/yet-another-minted-identifier>

After retrieving a transaction resource, the client can execute any REST API method prefixed by the transaction location.

curl -X POST "http://localhost:8080/rest/fcr:tx" 

Status: 201 Created
 
Headers:
Location: http://localhost:8080/rest/tx:123456789

curl -X POST "http://localhost:8080/rest/tx:123456789/path/to/object/to/create"
curl -X DELETE "http://localhost:8080/rest/tx:123456789/path/to/resource/to/delete"
curl -X POST "http://localhost:8080/rest/tx:!23456789/fcr:tx/fcr:commit

curl -X POST "http://localhost:8080/rest/tx:123456789/fcr:tx/fcr:commit" 

Status: 204 No Content

curl -X POST "http://localhost:8080/rest/tx:123456789/fcr:tx/fcr:rollback" 

Status: 204 No Content

curl -H "Accept: text/turtle" "http://localhost:8080/rest/path/to/some/binary/resource/fcr:fixity"

Status: 200
 
Headers:
Content-Type: text/turtle
 
Body:
<x> <y> <z>

curl -X POST "http://localhost:8080/rest/fcr:workspaces/abc"  # create a new workspace called "abc"

Status: 201 Created
 
Headers:
Location: http://localhost:8080/rest/workspace:abc

curl -X POST "http://localhost:8080/rest/fcr:workspaces/abc"
curl -X POST "http://localhost:8080/rest/workspace:abc/path/to/some/new/resource

curl "http://localhost:8080/rest/fcr:nodetypes"

Status: 200 OK
 
Headers:
Content-Type: text/turtle
Body:
<x> <y> <z> 

The request body format for updating nodetypes is in flux. For now, and in the immediate future, it uses  JCR's CND syntax , but we'd prefer a provider-independent format.

curl -X POST -H "Content-Type: text/cnd" -d "@cnd.txt" "http://localhost:8080/rest/fcr:nodetypes"
 
Body:
 
[fedora:custom-node-type] > [fedora:resource]
    - fedora:thumbnail (string)
 

Status: 204 No Content

curl "http://localhost:8080/rest/fcr:namespaces"

Status: 200 OK
 
Headers:
Content-Type: text/turtle
Body:
<x> <y> <z> 

curl -X POST -H "Content-Type: application/sparql-update" -d "@namespaces.rdf" "http://localhost:8080/rest/fcr:namespaces"
 
Body:
# Register the namespace 'info:some-namespace' with the prefix 'some'
INSERT { 
    <info:some-namespace> <http://purl.org/vocab/vann/preferredNamespacePrefix> "some" 
} WHERE { 
 
}

Status: 204 No Content

curl "http://localhost:8080/rest/sitemap"

Status: 200 OK
 
Headers:
Content-Type: text/xml
Body:
<sitemap>
 ...
</sitemap>

curl -H "Accept: text/turtle" "http://localhost:8080/rest/fcr:search"

Status: 200
 
Headers:
 
Body:
<x> <y> <z>