Add a Trusted Registry

Adds a registry hostname to the Runtime trusted-registries list so images from that host are not marked Untrusted.

Call this on the Runtime service path https://<JPD_HOST>/runtime/api/v1/trusted_registries. Do not send the request to /api/v1/ on the Artifactory base URL.

Requires a Runtime Manager, which is a platform admin or a Project Admin on the default project. Other callers receive 403.

Runtime auto-trusts only the JPD platform base URL hostname. Custom Docker CNAMEs (for example docker.corp.example.com) and external or mirror registries (for example cgr.dev) are not auto-trusted. Images from those hosts stay Untrusted until you add the hostname Runtime reports for the image.

registryUrl is the hostname only. Add stores it exactly as sent, and the duplicate check is case-sensitive, so CGR.dev and cgr.dev are different entries. Get, Update, and Delete look up that stored value exactly. Use a lowercase hostname with no trailing dot. Image integrity on the current Runtime release uses the same exact hostname.

trusted set to true treats the registry as trusted. supported set to true runs Artifactory integrity checks against this registry. Set supported to false for an external or mirror host that is not an Artifactory Docker API. If you omit supported, Runtime stores false. Images from a host with trusted set to false are marked Untrusted registry, and Xray results for those images are hidden. trusted set to true and supported set to false skips the digest check. Both set to true compares the Artifactory manifest digest with the running image. Runtime rechecks an image that is already running at most every 5 minutes by default.

This operation creates a new entry. Sending a hostname that is already registered returns 404.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Display name for the registry.

string
required

Registry hostname only, stored and matched exactly. The duplicate check is case-sensitive. Use a lowercase hostname with no trailing dot (for example docker.corp.example.com or cgr.dev).

boolean
required

Set to true to treat images from this registry as trusted. Images from an untrusted registry are marked Untrusted and Xray results for those images are hidden.

boolean

Set to true if Runtime should run Artifactory integrity checks against this registry. Set to false for an external or mirror host that is not an Artifactory Docker API. Defaults to false when omitted.

Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json