/users

Provides endpoints which allow the manipulation of users.

post

Create a new user.

get

Load multiple users and return a paged list response.

post

Update the user with the given uuid. The user is created if no user with the specified uuid could be found.

get

Read the user with the given uuid

delete

Deactivate the user with the given uuid. Please note that users can't be deleted since they are needed to construct creator/editor information.

get

Read the user permissions on the element that can be located by the specified path. Requires READ permission on the user.

post

Return a one time token which can be used by any user to update a user (e.g.: Reset the password). Requires CREATE permission on the user.

get

Get the permissions on the user for all roles.

post

Grant permissions on the user to multiple roles.

delete

Revoke permissions on the user from multiple roles.

post

Return API token which can be used to authenticate the user. Store the key somewhere save since you won't be able to retrieve it later on. This invalidates all tokens previously issued for this user. Requires UPDATE permission on the user.

delete

Invalidate the issued API token.

/roles

Provides endpoints which allow the manipulation of roles.

post

Create a new role.

get

Load multiple roles and return a paged list response

get

Load the role with the given uuid.

post

Update the role with the given uuid. The role is created if no role with the specified uuid could be found.

delete

Delete the role with the given uuid

post

Set the permissions between role and the targeted element.

get

Load the permissions between given role and the targeted element.

get

Get the permissions on the role for all roles.

post

Grant permissions on the role to multiple roles.

delete

Revoke permissions on the role from multiple roles.

/groups

Provides endpoints which allow the manipulation of groups.

post

Create a new group.

get

Read multiple groups and return a paged list response.

get

Read the group with the given uuid.

post

Update the group with the given uuid. The group is created if no group with the specified uuid could be found.

delete

Delete the given group.

get

Get the permissions on the group for all roles.

post

Grant permissions on the group to multiple roles.

delete

Revoke permissions on the group from multiple roles.

get

Load multiple roles that are assigned to the group. Return a paged list response.

post

Add the specified role to the group.

delete

Remove the given role from the group.

get

Load a list of users which have been assigned to the group.

post

Add the given user to the group

delete

Remove the given user from the group.

/projects

Provides endpoints which allow the manipulation of projects.

post

Create a new project.

get

Load multiple projects and return a paged response.

get

Load the project with the given uuid.

post

Update the project with the given uuid. The project is created if no project with the specified uuid could be found.

delete

Delete the project and all attached nodes, tagfamiles and branches.

post

Invoke a version purge of the project.

get

Get the permissions on the project for all roles.

post

Grant permissions on the project to multiple roles.

delete

Revoke permissions on the project from multiple roles.

/schemas

Provides endpoints which allow the manipulation of schemas.

get

Read multiple schemas and return a paged list response.

post

Create a new schema.

get

Load the schema with the given uuid.

post

Update the schema.

delete

Delete the schema with the given uuid.

post

Apply the posted changes to the schema. The schema migration will not automatically be started.

post

Compare the given schema with the stored schema and create a changeset.

get

Get the permissions on the schema for all roles.

post

Grant permissions on the schema to multiple roles.

delete

Revoke permissions on the schema from multiple roles.

/microschemas

Endpoint which provides methods to manipulate microschemas.

post

Create a new microschema.

get

Read multiple microschemas and return a paged list response.

get

Read the microschema with the given uuid.

post

Update the microschema with the given uuid.

delete

Delete the microschema with the given uuid.

post

Apply the provided changes on the latest version of the schema and migrate all nodes which are based on the schema. Please note that this operation is non-blocking and will continue to run in the background.

post

Compare the provided schema with the schema which is currently stored and generate a set of changes that have been detected.

get

Get the permissions on the microschema for all roles.

post

Grant permissions on the microschema to multiple roles.

delete

Revoke permissions on the microschema from multiple roles.

/admin

Collection of administrative endpoints which usually require admin permission

delete

Clear all internal caches (cluster wide).

get

Loads the cluster configuration.

post

Update the cluster configuration.

get

Loads the cluster status information.

get

Retrieves the currently active local configuration of this instance.

post

Sets the currently active local configuration of this instance.

get

Invokes a consistency check of the graph database without attempting to repairing the found issues. A list of found issues will be returned. When an async=true query parameter is used, a new consistency check Job is queued, and the check results should be obtained with the call to the link:#admin_jobs__jobUuid__get[corresponding job].Please note that some checks do require an async flag set.

post

Invokes a consistency check and repair of the graph database and returns a list of found issues and their state. When an async=true query parameter is used, a new consistency repair Job is queued, and the repair results should be obtained with the call to the link:#admin_jobs__jobUuid__get[corresponding job]. Please note that some repairs do require an async flag set.

get

Returns the currently active coordination configuration.

post

Update the coordinator configuration of this instance. Note that the updated config will not be persisted.

get

Returns information on the elected coordinator master.

post

Make this instance the coordination master.

get

Downloads a zip file of various debug information files.

post

Invoke a graph database backup and dump the data to the configured backup location. Note that this operation will block all current operation. Irrelevant for non-OrientDB server.

post

Invoke a orientdb graph database export. Irrelevant for non-OrientDB server.

post

Invoke a orientdb graph database import. The latest import file from the import directory will be used for this operation. Irrelevant for non-OrientDB server.

post

Invoke a graph database restore. The latest dump from the backup directory will be inserted. Please note that this operation will block all current operation and effectively destroy all previously stored data. Irrelevant for non-OrientDB server.

get

List all currently queued jobs.

get

Load a specific job.

delete

Deletes the job. Note that it is only possible to delete failed jobs

delete

Deletes error state from the job. This will make it possible to execute the job once again.

post

Process the job. Failed jobs will be automatically reset and put in queued state.

post

Deploys the plugin using the provided deployment information.

get

Loads deployment information for all deployed plugins.

delete

Undeploys the plugin with the given uuid.

get

Loads deployment information for the plugin with the given id.

post

Invoke the processing of remaining jobs.

post

Initiates shutdown of this instance.

get

Return the Gentics Mesh server status.

/health

Endpoints for Mesh health checks

get

Returns an empty response with status code 200 if Gentics Mesh is alive.

get

Returns an empty response with status code 200 if Gentics Mesh is ready. Responds with 503 otherwise.

get

Returns an empty response with status code 200 if Gentics Mesh is writable. Responds with 503 otherwise.

Provides search endpoints which can be used to invoke global searches

post

Drops all indices and recreates them. The index sync is not invoked automatically.

post

Invoke a search query for groups and return a paged list response.

post

Invoke a search query for microschemas and return a paged list response.

post

Invoke a search query for nodes and return a paged list response.

post

Invoke a search query for projects and return a paged list response.

post

Invoke a search query for roles and return a paged list response.

post

Invoke a search query for schemas and return a paged list response.

get

Returns the search index status.

post

Invokes the manual synchronisation of the search indices. This operation may take some time to complete and is performed asynchronously. When clustering is enabled it will be executed on any free instance.

post

Invoke a search query for tagFamilies and return a paged list response.

post

Invoke a search query for tags and return a paged list response.

post

Invoke a search query for users and return a paged list response.

/rawSearch

Provides search endpoints which can be used to invoke global searches which return the unmodified Elasticsearch response.

post

Invoke a search query for groups and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

post

Invoke a search query for microschemas and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

post

Invoke a search query for nodes and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

post

Invoke a search query for projects and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

post

Invoke a search query for roles and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

post

Invoke a search query for schemas and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

post

Invoke a search query for tagFamilies and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

post

Invoke a search query for tags and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

post

Invoke a search query for users and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

/utilities

Provides endpoints for various utility actions

post

Return the posted text and resolve and replace all found mesh links. A mesh link must be in the format {{mesh.link("UUID","languageTag")}}

post

Validate the posted microschema and report errors.

post

Validate the posted schema and report errors.

/auth

Endpoint which contains login and logout methods.

get

Login via basic or bearer authentication.

post

Login via this dedicated login endpoint.

get

Logout and delete the currently active session.

get

Load your own user which is currently logged in.

/eventbus

This endpoint is a SockJS compliant websocket that creates a bridge to the mesh eventbus. It allows handling of various mesh specific events.

/

Provides endpoints that return information about the REST API.

get

Endpoint which returns version information

get

Endpoint which provides a RAML document for all registed endpoints.

get

Return the current project info.

/{project}/nodes

Provides endpoints which allow the manipulation of nodes.

post

Create a new node.

get

Read all nodes and return a paged list response.

get

Load the node with the given uuid.

post

Update or create the node with the given uuid. Mesh will automatically check for version conflicts if a version was specified in the request and return a 409 error if a conflict has been detected. Additional conflict checks for WebRoot path conflicts will also be performed. The node is created if no node with the specified uuid could be found.

delete

Delete the node with the given uuid.

post

Update the binaryfield with the given name.

get

Download the binary field with the given name. You can use image query parameters for crop and resize if the binary data represents an image.

post

Set the check status for the binaryfield with the given name.

get

Get the list of image manipulation variants of the binary, possessed by a field with the given name.

delete

Delete unused image manipulation variants of the binary, referenced by a field with the given name.

post

Add new image variants to the binary, referenced by a field with the given name.

post

Transform the image with the given field name and overwrite the stored image with the transformation result.

get

Load all child nodes and return a paged list response.

delete

Delete the language specific content of the node.

get

Return the publish status for the given language of the node.

post

Publish the language of the node. This will automatically assign a new major version to the node and update the draft version to the published version.

delete

Take the language of the node offline.

post

Move the node into the target node.

get

Returns a navigation object for the provided node.

get

Return the published status of the node.

post

Publish all language specific contents of the node with the given uuid.

delete

Unpublish the given node.

get

Get the permissions on the node for all roles.

post

Grant permissions on the node to multiple roles.

delete

Revoke permissions on the node from multiple roles.

post

Create the s3 binaryfield with the given name.

post

Set the check status for the binaryfield with the given name.

post

Parse metadata of s3 binaryfield with the given name.

get

Return a list of all tags which tag the node.

post

Update the list of assigned tags

post

Assign the given tag to the node.

delete

Remove the given tag from the node.

get

Returns a list of versions.

/{project}/tagFamilies

Provides endpoints which allow the manipulation of tag families and tags.

get

Load multiple tag families and return a paged list response.

post

Create a new tag family.

get

Read the tag family with the given uuid.

post

Update the tag family with the given uuid. The tag family will be created if it can't be found for the given uuid.

delete

Delete the tag family.

get

Get the permissions on the tag family for all roles.

post

Grant permissions on the tag family to multiple roles.

delete

Revoke permissions on the tag family from multiple roles.

post

Create a new tag within the tag family.

get

Load tags which were assigned to this tag family and return a paged list response.

get

Read the specified tag from the tag family.

post

Update the specified tag. The tag is created if no tag with the specified uuid could be found.

delete

Remove the tag from the tag family.

get

Load all nodes that have been tagged with the tag and return a paged list response.

get

Get the permissions on the tag for all roles.

post

Grant permissions on the tag to multiple roles.

delete

Revoke permissions on the tag from multiple roles.

/{project}/navroot

Provides an endpoint which can be used to retrieve a navigation response

get

Return a navigation for the node which is located using the given path.

/{project}/webroot

Provides endpoints which allow loading nodes via a webroot path.

get

Load the node or the node's binary data which is located using the provided path.

post

Update or create a node for the given path.

/{project}/webrootfield

Provides endpoint which allow viewing the requested field for the node loaded via a webroot path.

get

Download the field with the given name from the given path. You can use image query parameters for crop and resize if the binary data represents an image.

post

Update the field variants with the given name from the given path.

/{project}/branches

Provides endpoints which allow the manipulation of branches.

post

Create a new branch and automatically invoke a node migration.

get

Load multiple branches and return a paged list response.

get

Load the branch with the given uuid.

post

Update the branch with the given uuid. The branch is created if no branch with the specified uuid could be found.

post

Set the branch with the given uuid as 'latest' branch of the project.

get

Load microschemas that are assigned to the branch and return a paged list response.

post

Assign a microschema version to the branch.

post

Invoked the micronode migration for not yet migrated micronodes of microschemas that are assigned to the branch.

post

Invoked the node migration for not yet migrated nodes of schemas that are assigned to the branch.

get

Get the permissions on the branch for all roles.

post

Grant permissions on the branch to multiple roles.

delete

Revoke permissions on the branch from multiple roles.

get

Load schemas that are assigned to the branch and return a paged list response.

post

Assign a schema version to the branch.

get

Return a list of all tags which tag the branch.

post

Update the list of assigned tags

post

Assign the given tag to the branch.

delete

Remove the given tag from the branch.

/{project}/graphql

GraphQL endpoint

post

Endpoint which accepts GraphQL queries.

Provides endpoints which allow project wide search.

post

Invoke a search query for nodes and return a paged list response.

post

Invoke a search query for tagFamilies and return a paged list response.

post

Invoke a search query for tags and return a paged list response.

/{project}/rawSearch

Provides endpoints which allow project wide search which return the unmodified Elasticsearch response.

post

Invoke a search query for nodes and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

post

Invoke a search query for tagFamilies and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

post

Invoke a search query for tags and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

/{project}/schemas

Provides endpoints which can be used to assign schemas to projects.

get

Read multiple schemas and return a paged list response.

get

Load the schema with the given uuid.

post

Assign the schema to the project. This will automatically assign the latest schema version to all branches of the project.

delete

Remove the schema with the given uuid from the project. This will automatically remove all schema versions of the given schema from all branches of the project.

/{project}/microschemas

Contains endpoints which allow microschemas to be assigned to projects.

get

Read all microschemas which are assigned to the project.

post

Add the microschema to the project.

delete

Remove the microschema from the project.