Update Registry Settings
PUT/api/v32.07/settings/registry
x-prisma-cloud-target-env: {"permission":"policyContainers"}
Updates the registries to scan. The list of registries to scan is updated in a single shot.
To invoke this endpoint in the Console UI:
- Navigate to Defend > Vulnerabilities > Images > Registry settings.
- Under the Registries table, add a registry item using + Add registry
- Click the Save button.
Note: From 22.11 (Lagrange) release or later, you can add a maximum of 19,999 registry entries in Defend > Vulnerabilities > Images > Registry settings.
The API response returns an HTTP 400 error, if the number of registry specifications exceeds the maximum allowable limit of 19,999 registry entries.
General Set up and Scan Process
This endpoint works hand-in-hand with the /policies
endpoints.
To set up a registry for scanning:
Add your registry account information using this endpoint.
For example, specify the location and credentials of an ECR registry in your AWS account.
Prisma Cloud auto-discovers the images in the registries specified with this endpoint.
The list of auto-discovered images is passed to the scanner for evaluation.
The scanner uses the corresponding
/policies/vulnerability/images
and/policies/compliance/images
endpoints to assess each image.
cURL Request
Each registry to scan is specified as an item in the specifications
array.
Note: Submitting a PUT request with the specifications
array will first erase all the existing Registry entries, and then insert the new specifications
array from the PUT request.
An empty body will also erase all the existing Registry entries. For more information, see Remove a Registry.
We recommend that you send a GET scan settings request via Get Registry Settings and save the JSON response before sending a PUT API request to update the Registry Settings.
The critical fields for this endpoint are:
registry
- String specifying the registry URL.credentialID
- String specifying the registry credential.version
- String specifying the type of registry to scan and may be one of the following strings:
Version | Description |
---|---|
aws | Amazon EC2 Container Registry |
azure | Azure Container Registry |
2 | Docker Registry v2 |
dtr | Docker Trusted Registry |
gcr | Google Container Registry |
jfrog | JFrog Artifactory |
sonatype | Sonatype Nexus |
coreos | CoreOS Quay |
redhat | Red Hat OpenShift |
bluemix | IBM Cloud Container Registry |
The remaining fields in the specifications
object (e.g., repository
, exclusions
, etc.) are optional.
They let you refine the scope of what Prisma Cloud auto-discovers.
Note: An empty string in registry
implicitly refers to Docker Hub.
In repository
, use the library/
namespace to specify a Docker official image.
To see the current list of Docker official images, see here.
Set up a Private Registry for Scanning
Most registries you'll configure for scanning will be private. Prisma Cloud needs credentials to access private registries. To set this up:
- Create the credentials with the
/credentials
endpoint. - Retrieve the credential ID from the
/credentials
endpoint (_id
). - Create the registry setting with the recommended minimum required fields (
version
,registry
, andcredentialID
).
Example cURL Request
The following cURL command overwrites the current list of registries to scan with two new registries:
- The official Ubuntu 18.04 image in Docker Hub
- All repositories in a private AWS ECR registry
$ curl 'https://<CONSOLE>/api/v<VERSION>/settings/registry' \
-k \
-X PUT \
-u <USER> \
-H 'Content-Type: application/json' \
-d \
'{
"specifications": [
{
"version": "2",
"registry": "",
"repository": "library/ubuntu",
"tag": "18.04",
"os": "linux",
"cap": 5,
"credentialID": "<CREDENTIAL_ID1>",
"scanners": 2,
"collections": ["All"]
},
{
"version": "aws",
"registry": "<ACCOUNT_ID>.dkr.ecr.<REGION>.amazonaws.com",
"os": "linux",
"credentialID": "<CREDENTIAL_ID2>",
"scanners": 2,
"cap": 5,
"collections": ["All"]
}
]
}'
Note: No response will be returned upon successful execution.
Remove a Registry
To remove a registry from the list:
- Retrieve the current list using the GET method.
- Remove the entry from the
specifications
JSON array in the response. - Use the PUT method to submit the updated JSON object.
To delete all entries, submit an empty specifications
array. For example:
curl -k \
-u <USER> \
-H 'Content-Type: application/json' \
-X PUT \
-d '{"specifications":[]}' \
https://<CONSOLE>/api/v<VERSION>/settings/registry
Request
Query Parameters
ScanLater indicates to save the setting without starting a scan.
- application/json
Body
- Array [
- Array [
- ]
- ]
Relative path to the Harbor scanner endpoint.
specifications object[]
Information for connecting to the registries to be scanned.
azureCloudMetadata object
CloudMetadata is the metadata for a cloud provider managed asset (e.g., as part of AWS/GCP/Azure/OCI)
Cloud account ID.
AWS execution environment (e.g. EC2/Fargate).
The name of the image the cloud managed host or container is based on.
labels object[]
Cloud provider metadata labels.
Label key.
Source name (e.g., for a namespace, the source name can be 'twistlock').
Possible values: [namespace,deployment,aws,azure,gcp,oci
]
ExternalLabelSourceType indicates the source of the labels
Time when the label was fetched.
Value of the label.
Resource name.
Possible values: [aws,azure,gcp,alibaba,oci,others
]
CloudProvider specifies the cloud provider name
Resource's region.
Unique ID of the resource.
Server-defined URL for the resource.
Instance type.
Azure unique vm ID.
VMImageID holds the VM instance's image ID.
CACert is the Certificate Authority that signed the registry certificate.
Specifies the maximum number of images from each repo to fetch and scan, sorted by most recently modified.
Specifies the set of Defenders in-scope for working on a scan job.
credential object
Credential specifies the authentication data of an external provider
Specifies the unique ID for credential.
Specifies the unique ID for an IBM Cloud account.
Specifies the account identifier. Example: a username, access key, account GUID, and so on.
Specifies the name of the cloud account.
apiToken object
Secret Stores the plain and encrypted version of a value. The plain version is not stored in a database
Specifies an encrypted value of the secret.
Specifies the plain text value of the secret.
azureSPInfo object
AzureSPInfo contains the Azure credentials needed for certificate based authentications
ClientID is the client identifier.
Possible values: [user-assigned,system-assigned
]
SubscriptionID is a GUID that uniquely identifies the subscription to use Azure services.
TenantID is the ID of the AAD directory in which the application was created.
Specifies the CA certificate for a certificate-based authentication.
Specifies the cloud provider account ID.
Specifies the time when the credential was created (or, when the account ID was changed for AWS).
Specifies the description for a credential.
Indicates whether the credential was onboarded from the Prisma platform.
Indicates whether the credential scope is global. Available values are: true: Global false: Not Global Note: For GCP, the credential scope is the organization.
Specifies the time when the credential was last modified.
ociCred object
OCICred are additional parameters required for OCI credentials
Fingerprint is the public key signature.
TenancyID is the OCID of the tenancy.
Specifies the user who created or modified the credential.
Specifies the time when the account was last modified by Prisma Cloud Compute.
Specifies the Amazon Resource Name (ARN) of the role to be assumed.
secret object
Secret Stores the plain and encrypted version of a value. The plain version is not stored in a database
Specifies an encrypted value of the secret.
Specifies the plain text value of the secret.
Indicates whether to skip the certificate verification in TLS communication.
Specifies a list of specific endpoints for use in STS sessions in various regions.
tokens object
TemporaryToken is a temporary session token for cloud provider APIs AWS - https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html GCP - https://cloud.google.com/iam/docs/creating-short-lived-service-account-credentials Azure - https://docs.microsoft.com/en-us/azure/active-directory/manage-apps/what-is-single-sign-on
Specifies a temporary access key.
awsSecretAccessKey object
Secret Stores the plain and encrypted version of a value. The plain version is not stored in a database
Specifies an encrypted value of the secret.
Specifies the plain text value of the secret.
Specifies a duration for the token.
Specifies an expiration time for the token.
token object
Secret Stores the plain and encrypted version of a value. The plain version is not stored in a database
Specifies an encrypted value of the secret.
Specifies the plain text value of the secret.
Possible values: [aws,azure,gcp,ibmCloud,oci,apiToken,basic,dtr,kubeconfig,certificate,gitlabToken
]
Type specifies the credential type
Specifies the base server URL.
Indicates whether to authenticate using the IAM Role attached to the instance. Available values are: true: Authenticate with the attached credentials false: Don’t authenticate with the attached credentials.
Indicates whether to use the regional STS endpoint for an STS session. Available values are: true: Use the regional STS false: Don’t use the regional STS.
ID of the credentials in the credentials store to use for authenticating with the registry.
Repositories to exclude from scanning.
Tags to exclude from scanning.
gitlabRegistrySpec object
GitlabRegistrySpec represents a specification for registry scanning in GitLab
.
.
.
.
.
Indicates whether the Prisma Cloud plugin uses temporary tokens provided by Harbor to scan images in projects where Harbor's deployment security setting is enabled.
ID is a unique identifier of the registry spec.
Possible values: [local,remote,virtual
]
JFrog Artifactory repository types to scan.
LastScanStatus is the last scan status. we keep both LastScanStatus and ScanStatus in order to not lose the latest scan status when a scan starts.
LastScanTime specifies the last time a scan was completed.
IBM Bluemix namespace https://console.bluemix.net/docs/services/Registry/registry_overview.html#registry_planning.
Possible values: [linux,linuxARM64,windows
]
RegistryOSType specifies the registry images base OS type
Registry address (e.g., https://gcr.io).
Repositories to scan.
ScanError is the error received while scanning the specification.
ScanStatus is the scan status that's updated dynamically during the scan, when the scan finishes - its value is passed to the LastScanStatus field in the DB.
ScanTime specifies the time a scan was started.
ScannedImagesSuccessTotal is the total number of registry images that were scanned successfully on the last registry specification scan.
Number of Defenders that can be utilized for each scan job.
Tags to scan.
Registry type. Determines the protocol Prisma Cloud uses to communicate with the registry.
Pattern heuristic for quickly filtering images by tags without having to query all images for modification dates.
Relative path to the webhook HTTP endpoint.
Responses
- 200
- default
OK