Hide

RegistryUI Documentation

Display
Print

/udr/v1api/project/create

EndpointMethodDescription
/udr/v1api/project/createPOSTCreates a new project/repository.

Authentication

Basic Authorization header required. The specified user must have administrator privileges.

Query String Arguments

ArgumentTypeDescription
repositorystringDefines the full path of the repository to be created.
titlestringOptional. Defines the title of the project.
isPublicboolOptional. Defines whether the repository is a public repository.

Repositories created using this API may need to be updated in RegistryUI to define authorized users and groups.

Response

A JSON object is returned. If an error occurs, the "error" field will contain a descriptive error message (see Standard API Response).

FieldTypeDescription
dataRepository Entry (see below)Describes the created repository.

Repository Entry

Only the fields listed here are officially supported at this time and only these should be used. All other fields are used internally by RegistryUI and may change in future releases.

FieldTypeDescription
fullPathstringThe complete path of the repository within the Docker Registry.
namestringThe name of the repository.
titlestringThe project title assigned to the repository.
description.htmlstring (HTML)The project description assigned to the repository.
isPublicboolDefines whether the repository is a public repository, i.e. accessible by anonymous users.
createddate/time (UTC)Contains the date/time the repository/project was created.
updateddate/time (UTC)Contains the date/time the repository/project was last updated. May be null.

Example

curl -u username:usertoken -d "" https://registry.yoursite.com/udr/v1api/project/create?repository=mysql&title=MySQL

Response:
{
    "error": null,
    "data": {
        "id": 1046,
        "tenantId": 1,
        "fullPath": "mysql",
        "available": true,
        "name": "mysql",
        "title": "MySQL",
        "description": {
            "text": null,
            "html": null
        },
        "level": 0,
        "isProject": true,
        "isRepository": true,
        "lowerLevelProjects": 0,
        "hasParentProject": false,
        "deletingUser": 0,
        "isPublic": false,
        "multiRepo": false,
        "updateGroupIdList": [],
        "readGroupIdList": [],
        "updateGroupIds": [
            1013
        ],
        "readGroupIds": [
            1012
        ],
        "readUsersGroupId": 1012,
        "updateUsersGroupId": 1013,
        "created": "2020-02-13T15:48:26.5879928Z",
        "updated": null
    }
}