The Open API specification for Synapse is now available for download!

Download Open API Spec



A Docker repository is a lightweight virtual machine image.

Field Type Description
name STRING The name of this entity. Must be 256 characters or less. Names may only contain: letters, numbers, spaces, underscores, hyphens, periods, plus signs, apostrophes, and parentheses
description STRING The description of this entity. Must be 1000 characters or less.
id STRING The unique immutable ID for this entity. A new ID will be generated for new Entities. Once issued, this ID is guaranteed to never change or be re-issued
etag STRING Synapse employs an Optimistic Concurrency Control (OCC) scheme to handle concurrent updates. Since the E-Tag changes every time an entity is updated it is used to detect when a client's current representation of an entity is out-of-date.
createdOn STRING The date this entity was created.
modifiedOn STRING The date this entity was last modified.
createdBy STRING The ID of the user that created this entity.
modifiedBy STRING The ID of the user that last modified this entity.
parentId STRING The ID of the Entity that is the parent of this Entity.
concreteType STRING Indicates which implementation of Entity this object represents. The value is the fully qualified class name, e.g. org.sagebionetworks.repo.model.FileEntity.
repositoryName STRING This is the repository name, [host[:port]/]path
isManaged BOOLEAN Indicates that the repository is managed by Synapse, rather than by an external registry.