Docker Trusted Registry API Documentation

DTR 2.4.0 API Documentation

 2.4.0

Docker Trusted Registry has an experimental API that you can use to manage DTR repositories, permissions, and settings.

This API is experimental and subject to change, which could affect future backwards compatibility.

default

GET/api/v0/imagescan/layer/{layerid}

Get the layer info from the given sha

repositoryNamespacesRepository Namespaces

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

List teams granted 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

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

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

metaAdmin

GET/api/v0/meta/cluster_status

Get cluster status

GET/api/v0/meta/features

Get features

GET/api/v0/meta/settings

Get settings

POST/api/v0/meta/settings

Update settings

cronsCrons

GET/api/v0/crons/

List all crons

POST/api/v0/crons/

Create / update a periodic task

GET/api/v0/crons/{action}

Get info about the cron with the given action

DELETE/api/v0/crons/{action}

Delete the cron. Jobs created from it will not be canceled.

accountsAccounts

GET/api/v0/accounts/language

Get the chosen language

DELETE/api/v0/accounts/{namespace}

Removes a user or organization along with all repositories

DELETE/api/v0/accounts/{namespace}/repositories

Removes all of a user or organization's repositories

GET/api/v0/accounts/{namespace}/webhooks

List the webhook subscriptions for a namespace

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

List repository access grants for a team

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

Check a user's access to a repository

GET/api/v0/accounts/{username}/settings

Check a user's settings

PATCH/api/v0/accounts/{username}/settings

Update a user's settings

action_configsAction Configs

GET/api/v0/action_configs/

List all action configs

POST/api/v0/action_configs/

Configure actions

GET/api/v0/action_configs/{action}

Get info about the actionConfig with the given action

DELETE/api/v0/action_configs/{action}

Delete the action config. The defaults will be used.

repositoriesRepositories

GET/api/v0/repositories/

List all repositories

POST/api/v0/repositories/scan/toggle

Toggles scan on push for all repositories

GET/api/v0/repositories/{namespace}

List repositories in a namespace

POST/api/v0/repositories/{namespace}

Create repository

GET/api/v0/repositories/{namespace}/{reponame}

View details of a repository

DELETE/api/v0/repositories/{namespace}/{reponame}

Remove a repository

PATCH/api/v0/repositories/{namespace}/{reponame}

Update details of a repository

GET/api/v0/repositories/{namespace}/{reponame}/manifests

List the available manifests for a repository

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

Delete a manifest for a repository

GET/api/v0/repositories/{namespace}/{reponame}/promotionPolicies

List the promotion policies for a repository

POST/api/v0/repositories/{namespace}/{reponame}/promotionPolicies

Create a promotion policy for a repository

GET/api/v0/repositories/{namespace}/{reponame}/promotionPolicies/{promotionpolicyid}

Retrieve a specific promotion policy for a repository

PUT/api/v0/repositories/{namespace}/{reponame}/promotionPolicies/{promotionpolicyid}

Updates a specific promotion policy for a repository

DELETE/api/v0/repositories/{namespace}/{reponame}/promotionPolicies/{promotionpolicyid}

Deletes a specific promotion policy for a repository

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

List the available tags for a repository

GET/api/v0/repositories/{namespace}/{reponame}/tags/{tag}

Retrieve a specific tag for a repository

DELETE/api/v0/repositories/{namespace}/{reponame}/tags/{tag}

Delete a tag for a repository

POST/api/v0/repositories/{namespace}/{reponame}/tags/{tag}/promotion

Promotes a specific tag for a repository

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

List teams granted access to an organization-owned repository

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

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

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

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

GET/api/v0/repositories/{namespace}/{reponame}/webhooks

List the webhook subscriptions for a repository

index

GET/api/v0/index/autocomplete

Autocompletion for repositories and/or accounts

GET/api/v0/index/dockersearch

Search Docker repositories

workersWorkers

GET/api/v0/workers/

List all workers

POST/api/v0/workers/{id}/capacity

Update the capacity for a worker

jobsJobs

GET/api/v0/jobs/

List all jobs ordered by most recently scheduled

POST/api/v0/jobs/

Schedule a job to be run immediately

GET/api/v0/jobs/{jobID}

Get info about the job with the given ID

DELETE/api/v0/jobs/{jobID}

Signal this job's worker to cancel and delete the job

POST/api/v0/jobs/{jobID}/cancel

Signal this job's worker to cancel the job

GET/api/v0/jobs/{jobID}/logs

Retrieve logs for this job from its worker

content_cachesContent Caches

GET/api/v0/content_caches/

List all content caches

POST/api/v0/content_caches/

Create content cache

GET/api/v0/content_caches/{contentcacheuuid}

View details of a content cache

DELETE/api/v0/content_caches/{contentcacheuuid}

Remove a content cache

imagescanDocker Security Scanner

GET/api/v0/imagescan/repositories/{namespace}/{reponame}/{tag}

Get the summary info on a namespace/repo:tag

POST/api/v0/imagescan/scan

Do a scan or a scan/check of all layers

PUT/api/v0/imagescan/scan/update

Update the vulnerability database for security scanning

POST/api/v0/imagescan/scan/{namespace}/{reponame}/{tag}/{os}/{arch}

Do a scan or a scan/check of given image

GET/api/v0/imagescan/status

Get the status and version of scanning service

eventsEvents

GET/api/v0/events/

Get Events

webhooksWebhooks

GET/api/v0/webhooks/

List Webhooks

POST/api/v0/webhooks/

Create Webhook

POST/api/v0/webhooks/test

Test Webhook

POST/api/v0/webhooks/update

Update Webhook

DELETE/api/v0/webhooks/{webhook}

Delete Webhook

Models

#/definitions/forms.Accessforms.Access{...}

#/definitions/forms.CreateContentCacheforms.CreateContentCache{...}

#/definitions/forms.CreatePromotionforms.CreatePromotion{...}

#/definitions/forms.CreatePromotionPolicyforms.CreatePromotionPolicy{...}

#/definitions/forms.CreateRepoforms.CreateRepo{...}

#/definitions/forms.ScanOptionsforms.ScanOptions{...}

#/definitions/forms.Settingsforms.Settings{...}

#/definitions/forms.ToggleScanOnPushforms.ToggleScanOnPush{...}

#/definitions/forms.UpdatePromotionPolicyforms.UpdatePromotionPolicy{...}

#/definitions/forms.UpdateRepoforms.UpdateRepo{...}

#/definitions/forms.UserSettingsforms.UserSettings{...}

#/definitions/forms.Webhookforms.Webhook{...}

#/definitions/forms.WebhookTestPayloadforms.WebhookTestPayload{...}

#/definitions/forms.WebhookUpdateforms.WebhookUpdate{...}

#/definitions/responses.Accountresponses.Account{...}

#/definitions/responses.Autocompleteresponses.Autocomplete{...}

#/definitions/responses.ClusterStatusresponses.ClusterStatus{...}

#/definitions/responses.ContentCacheresponses.ContentCache{...}

#/definitions/responses.DockerRepositoryresponses.DockerRepository{...}

#/definitions/responses.DockerSearchresponses.DockerSearch{...}

#/definitions/responses.DockerfileLineresponses.DockerfileLine{...}

#/definitions/responses.Eventsresponses.Events{...}

#/definitions/responses.Featuresresponses.Features{...}

#/definitions/responses.Languageresponses.Language{...}

#/definitions/responses.ListRepoNamespaceTeamAccessresponses.ListRepoNamespaceTeamAccess{...}

#/definitions/responses.ListRepoTeamAccessresponses.ListRepoTeamAccess{...}

#/definitions/responses.ListTeamRepoAccessresponses.ListTeamRepoAccess{...}

#/definitions/responses.Manifestresponses.Manifest{...}

#/definitions/responses.NamespaceTeamAccessresponses.NamespaceTeamAccess{...}

#/definitions/responses.Promotionresponses.Promotion{...}

#/definitions/responses.PromotionPolicyresponses.PromotionPolicy{...}

#/definitions/responses.RepoAccessresponses.RepoAccess{...}

#/definitions/responses.RepoUserAccessresponses.RepoUserAccess{...}

#/definitions/responses.Repositoriesresponses.Repositories{...}

#/definitions/responses.Repositoryresponses.Repository{...}

#/definitions/responses.Settingsresponses.Settings{...}

#/definitions/responses.Tagresponses.Tag{...}

#/definitions/responses.Teamresponses.Team{...}

#/definitions/responses.TeamAccessresponses.TeamAccess{...}

#/definitions/responses.UserSettingsresponses.UserSettings{...}

#/definitions/responses.Webhookresponses.Webhook{...}

#/definitions/ruleengine.Ruleruleengine.Rule{...}

#/definitions/schema.Componentschema.Component{...}

#/definitions/schema.DetailedSummaryschema.DetailedSummary{...}

#/definitions/schema.Eventschema.Event{...}

schema.Layer{...}

#/definitions/schema.Licenseschema.License{...}

#/definitions/schema.NautilusStatusschema.NautilusStatus{...}

#/definitions/schema.Noteschema.Note{...}

#/definitions/schema.Objectschema.Object{...}

#/definitions/schema.TagScanSummaryschema.TagScanSummary{...}

#/definitions/schema.Vulnerabilityschema.Vulnerability{...}

#/definitions/schema.VulnerabilityDetailsschema.VulnerabilityDetails{...}

#/definitions/tmpforms.ActionConfigCreatetmpforms.ActionConfigCreate{...}

#/definitions/tmpforms.CronCreatetmpforms.CronCreate{...}

#/definitions/tmpforms.JobSubmissiontmpforms.JobSubmission{...}

#/definitions/tmpforms.UpdateWorkerCapacitytmpforms.UpdateWorkerCapacity{...}

#/definitions/tmpresponses.ActionConfigtmpresponses.ActionConfig{...}

#/definitions/tmpresponses.ActionConfigstmpresponses.ActionConfigs{...}

#/definitions/tmpresponses.Crontmpresponses.Cron{...}

#/definitions/tmpresponses.Cronstmpresponses.Crons{...}

#/definitions/tmpresponses.Jobtmpresponses.Job{...}

#/definitions/tmpresponses.JobLogtmpresponses.JobLog{...}

#/definitions/tmpresponses.JobLogstmpresponses.JobLogs{...}

#/definitions/tmpresponses.Jobstmpresponses.Jobs{...}

#/definitions/tmpresponses.Workertmpresponses.Worker{...}

#/definitions/tmpresponses.Workerstmpresponses.Workers{...}