Docker Trusted Registry API Documentation

accounts : Accounts

get /api/v0/accounts/{orgname}/teams/{teamname}/repositoryAccess

List repository access grants for a team

Implementation Notes

Authorization: Client must be authenticated as a user who owns the organization the team is in or be a member of that team.

Response Class (Status 200)

string
Enum:	"read-only", "read-write", "admin"

string
Enum:	"user", "organization"

string
Enum:	"public", "private"

{
  "team": {
    "id": "string",
    "clientUserIsMember": true
  },
  "repositoryAccessList": [
    {
      "accessLevel": "read-only",
      "repository": {
        "id": "string",
        "namespace": "string",
        "namespaceType": "user",
        "name": "string",
        "shortDescription": "string",
        "longDescription": "string",
        "visibility": "public"
      }
    }
  ]
}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	(empty)	organization account name	path	string
teamname	(empty)	team name	path	string
start	(empty)	Start of page index (This can have slightly different meanings for different endpoints)	query	integer
limit	10	Maximum number of results to return	query	integer

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

the team does not belong to the organization

401

NOT_AUTHENTICATED: The client is not authenticated.

403

NOT_AUTHORIZED: The client is not authorized.

404

NO_SUCH_TEAM: A team with the given name does not exist in the organization.

get /api/v0/accounts/{username}/repositoryAccess/{namespace}/{reponame}

Check a user's access to a repository

Implementation Notes

*Authorization:* Client must be authenticated either as the user in question or be a system admin.

Response Class (Status 200)

string
Enum:	"read-only", "read-write", "admin"

string
Enum:	"user", "organization"

string
Enum:	"public", "private"

{
  "accessLevel": "read-only",
  "user": {
    "name": "string",
    "id": "string",
    "fullName": "string",
    "isOrg": true,
    "isAdmin": true,
    "isActive": true
  },
  "repository": {
    "id": "string",
    "namespace": "string",
    "namespaceType": "user",
    "name": "string",
    "shortDescription": "string",
    "longDescription": "string",
    "visibility": "public"
  }
}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
username	(empty)	user account name	path	string
namespace	(empty)	namespace of repository	path	string
reponame	(empty)	name of repository	path	string

Response Messages

HTTP Status Code

Reason

Response Model

Headers

401

NOT_AUTHENTICATED: The client is not authenticated.

403

NOT_AUTHORIZED: The client is not authorized.

404

NO_SUCH_REPOSITORY: A repository with the given name does not exist.

index : Index

get /api/v0/index/dockersearch

Search Docker repositories

Parameter	Value	Description	Parameter Type	Data Type
query	(empty)	Search query	query	string

get /api/v0/index/autocomplete

Autocompletion for repositories and/or accounts

Implementation Notes

Repository results will be filtered to only those repositories visible to the client. Account results will not be filtered.

Response Class (Status 200)

string
Enum:	"user", "organization"

string
Enum:	"public", "private"

{
  "accountResults": [
    {
      "name": "string",
      "id": "string",
      "fullName": "string",
      "isOrg": true,
      "isAdmin": true,
      "isActive": true
    }
  ],
  "repositoryResults": [
    {
      "id": "string",
      "namespace": "string",
      "namespaceType": "user",
      "name": "string",
      "shortDescription": "string",
      "longDescription": "string",
      "visibility": "public"
    }
  ]
}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
query	(empty)	Autocomplete query	query	string
includeRepositories		Whether to include repositories in the response	query	boolean
includeAccounts		Whether to include accounts in the response	query	boolean
namespace	(empty)	Exact repository namespace to limit results to.	query	string

Response Messages

HTTP Status Code

Reason

Response Model

Headers

401

NOT_AUTHENTICATED: The client is not authenticated.

meta : Admin

Parameter	Value	Description	Parameter Type	Data Type
body			body	Model Model Schema forms.Settings { dtrHost (string, optional), notaryServer (string, optional), notaryCert (string, optional), notaryVerifyCert (boolean, optional), authBypassCA (string, optional), authBypassOU (string, optional), disableUpgrades (boolean, optional), reportAnalytics (boolean, optional), releaseChannel (string, optional), webTLSCert (string, optional), webTLSKey (string, optional), webTLSCA (string, optional) } `{ "dtrHost": "string", "notaryServer": "string", "notaryCert": "string", "notaryVerifyCert": true, "authBypassCA": "string", "authBypassOU": "string", "disableUpgrades": true, "reportAnalytics": true, "releaseChannel": "string", "webTLSCert": "string", "webTLSKey": "string", "webTLSCA": "string" }` Click to set as parameter value

get /api/v0/meta/cluster_status

Get cluster status

openid : OpenID

repositories : Repositories

string
Enum:	"user", "organization"

string
Enum:	"public", "private"

Parameter	Value	Description	Parameter Type	Data Type
start	(empty)	Start of page index (This can have slightly different meanings for different endpoints)	query	integer
limit	10	Maximum number of results to return	query	integer

get /api/v0/repositories/{namespace}

List repositories in a namespace

Implementation Notes

Authorization: Client must be authenticated as any active user in the system. Results will be filtered to only those repositories visible to the client.

Response Class (Status 200)

string
Enum:	"user", "organization"

string
Enum:	"public", "private"

{
  "repositories": [
    {
      "id": "string",
      "namespace": "string",
      "namespaceType": "user",
      "name": "string",
      "shortDescription": "string",
      "longDescription": "string",
      "visibility": "public"
    }
  ]
}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace	(empty)	namespace of repository	path	string
start	(empty)	Start of page index (This can have slightly different meanings for different endpoints)	query	integer
limit	10	Maximum number of results to return	query	integer

Response Messages

HTTP Status Code

Reason

Response Model

Headers

401

NOT_AUTHENTICATED: The client is not authenticated.

404

NO_SUCH_ACCOUNT: An account with the given name does not exist.

post /api/v0/repositories/{namespace}

Create repository

Implementation Notes

Authorization: Client must be authenticated as a user who has admin access to the repository namespace (i.e., user owns the repo or is a member of a team with "admin" level access to the organization's namespace of repositories).

Response Class (Status 201)

{
  "id": "string",
  "namespace": "string",
  "namespaceType": "user",
  "name": "string",
  "shortDescription": "string",
  "longDescription": "string",
  "visibility": "public"
}

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

namespace

(empty)

namespace of repository

path

string

body

{
  "name": "string",
  "shortDescription": "string",
  "longDescription": "string",
  "visibility": "public"
}

Click to set as parameter value

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

REPOSITORY_EXISTS: A repository with the same name already exists.

401

NOT_AUTHENTICATED: The client is not authenticated.

403

NOT_AUTHORIZED: The client is not authorized.

404

NO_SUCH_ACCOUNT: An account with the given name does not exist.

Implementation Notes

Authorization: Client must be authenticated as a user who has "admin" access to the repository (i.e., user owns the repo or is a member of a team with "admin" level access to the organization"s repository).

Note that a repository cannot be renamed this way.

Response Class (Status 200)

{
  "id": "string",
  "namespace": "string",
  "namespaceType": "user",
  "name": "string",
  "shortDescription": "string",
  "longDescription": "string",
  "visibility": "public"
}

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

namespace

(empty)

namespace of repository

path

string

reponame

(empty)

name of repository

path

string

body

{
  "shortDescription": "string",
  "longDescription": "string",
  "visibility": "public"
}

Click to set as parameter value

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

INVALID_REPOSITORY_VISIBILITY: The visibility value of the repository is invalid.

401

NOT_AUTHENTICATED: The client is not authenticated.

403

NOT_AUTHORIZED: The client is not authorized.

404

NO_SUCH_REPOSITORY: A repository with the given name does not exist.

get /api/v0/repositories/{namespace}/{reponame}/teamAccess

List teams granted access to an organization-owned repository

Implementation Notes

Authorization: Client must be authenticated as a user who has "admin" level access to the repository.

Response Class (Status 200)

{
  "repository": {
    "id": "string",
    "namespace": "string",
    "namespaceType": "user",
    "name": "string",
    "shortDescription": "string",
    "longDescription": "string",
    "visibility": "public"
  },
  "teamAccessList": [
    {
      "accessLevel": "read-only",
      "team": {
        "id": "string",
        "clientUserIsMember": true
      }
    }
  ]
}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace	(empty)	namespace of repository	path	string
reponame	(empty)	name of repository	path	string
start	(empty)	Start of page index (This can have slightly different meanings for different endpoints)	query	integer
limit	10	Maximum number of results to return	query	integer

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

the repository is not owned by an organization

401

NOT_AUTHENTICATED: The client is not authenticated.

403

NOT_AUTHORIZED: The client is not authorized.

404

NO_SUCH_REPOSITORY: A repository with the given name does not exist.

delete /api/v0/repositories/{namespace}/{reponame}/teamAccess/{teamname}

Revoke a team's acccess to an organization-owned repository

put /api/v0/repositories/{namespace}/{reponame}/teamAccess/{teamname}

Set a team's access to an orgnization-owned repository

Implementation Notes

Authorization: Client must be authenticated as a user who has "admin" level access to the repository.

Response Class (Status 200)

{
  "accessLevel": "read-only",
  "team": {
    "id": "string",
    "clientUserIsMember": true
  },
  "repository": {
    "id": "string",
    "namespace": "string",
    "namespaceType": "user",
    "name": "string",
    "shortDescription": "string",
    "longDescription": "string",
    "visibility": "public"
  }
}

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

namespace

(empty)

namespace of repository

path

string

reponame

(empty)

name of repository

path

string

teamname

(empty)

team name

path

string

body

{
  "accessLevel": "read-only"
}

Click to set as parameter value

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

the team does not belong to the organization

401

NOT_AUTHENTICATED: The client is not authenticated.

403

NOT_AUTHORIZED: The client is not authorized.

404

NO_SUCH_TEAM: A team with the given name does not exist in the organization.

get /api/v0/repositories/{namespace}/{reponame}/tags

List the available tags for a repository

get /api/v0/repositories/{namespace}/{reponame}/tags/{tag}/trust

Get Notary trust info about a specific tag

delete /api/v0/repositories/{namespace}/{reponame}/manifests/{reference}

Delete a manifest for a repository

repositoryNamespaces : Repository Namespaces

get /api/v0/repositoryNamespaces/{namespace}/teamAccess

List teams granted access to an organization-owned namespace of repositories

Implementation Notes

Authorization: Client must be authenticated as a user who has ‘admin’ level access to the namespace.

Response Class (Status 200)

{
  "namespace": "string",
  "teamAccessList": [
    {
      "accessLevel": "read-only",
      "team": {
        "id": "string",
        "clientUserIsMember": true
      }
    }
  ]
}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace	(empty)	namespace of repository	path	string
start	(empty)	Start of page index (This can have slightly different meanings for different endpoints)	query	integer
limit	10	Maximum number of results to return	query	integer

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

the namespace is not owned by an organization

401

NOT_AUTHENTICATED: The client is not authenticated.

403

NOT_AUTHORIZED: The client is not authorized.

404

NO_SUCH_ACCOUNT: An account with the given name does not exist.

delete /api/v0/repositoryNamespaces/{namespace}/teamAccess/{teamname}

Revoke a team's access to an organization-owned namespace of repositories

get /api/v0/repositoryNamespaces/{namespace}/teamAccess/{teamname}

Get a team's granted access to an organization-owned namespace of repositories

put /api/v0/repositoryNamespaces/{namespace}/teamAccess/{teamname}

Set a team's access to an organization-owned namespace of repositories

Implementation Notes

Authorization: Client must be authenticated as a user who has ‘admin’ level access to the namespace.

Response Class (Status 200)

{
  "accessLevel": "read-only",
  "team": {
    "id": "string",
    "clientUserIsMember": true
  },
  "namespace": "string"
}

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

namespace

(empty)

namespace of repository

path

string

teamname

(empty)

team name

path

string

body

{
  "accessLevel": "read-only"
}

Click to set as parameter value

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

the team does not belong to the owning organization

401

NOT_AUTHENTICATED: The client is not authenticated.

403

NOT_AUTHORIZED: The client is not authorized.

404

NO_SUCH_TEAM: A team with the given name does not exist in the organization.

accounts : Accounts

Implementation Notes

Response Class (Status 200)

Parameters

Response Messages

Curl

Request URL

Response Body

Response Code

Response Headers

Implementation Notes

Response Class (Status 200)

Parameters

Response Messages

Curl

Request URL

Response Body

Response Code

Response Headers

index : Index

Implementation Notes

Response Class (Status 200)

Parameters

Response Messages

Curl

Request URL

Response Body

Response Code

Response Headers

Implementation Notes

Response Class (Status 200)

Parameters

Response Messages

Curl

Request URL

Response Body

Response Code

Response Headers

meta : Admin

Implementation Notes

Response Class (Status 200)

Response Messages

Curl

Request URL

Response Body

Response Code

Response Headers

Implementation Notes

Parameters

Response Messages

Curl

Request URL

Response Body

Response Code

Response Headers

Implementation Notes

Response Class (Status 200)

Response Messages

Curl

Request URL

Response Body

Response Code

Response Headers

openid : OpenID

Response Messages

Curl

Request URL

Response Body

Response Code

Response Headers

Response Messages

Curl

Request URL

Response Body

Response Code

Response Headers

Response Class (Status 200)

Response Messages

Curl

Request URL