Edit (Container Registry) | ArcGIS REST APIs

URL:: https://<root>/system/containerregistries/<registryID>/edit
Methods:: POST
Version Introduced:: 10.9.1

Access requirements

Required privileges

The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.

Default administrator role only

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.

Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generateToken operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.

Learn how to generate a token

Description

The edit operation allows certain container registry properties to be updated after your organization has been configured. Attempting to edit any other properties results in an error.

Request parameters

Parameter Details

Parameter	Details
`containerRegistryJson`	A JSON object of container registry properties. The only properties that can be updated are `username`, `password`, `registryUrl`, and `registryRepository`, with support for `registryUrl` and `registryRepository` being added at 12.0. Both the `username` and `password` property must be included in the request when updating the container registry. The password for the container registry can be entered as a plaintext value that will be encrypted once the request is complete. Warning Modifying the `registryUrl` and `registryRepository` properties will set the ArcGIS Enterprise on Kubernetes organization to read-only mode. It is recommended to make these changes during off-peak hours to avoid disrupting the organization. Ensure that both the current and new registry hosts remain accessible until the update process completes; if the update fails, the container registry will roll back to the previous `registryUrl` and `registryRepository` values. Example Use dark colors for code blocksCopy `1 2 3 4 5 6 7 8 9 10 11 containerRegistryJson={ "registryUrl": "registry-url.example.com", "registryRepository": "registry-repository", "password": "newPassWord!", "isImagePullSecretSystemManaged": true, "name": "default", "id": "enf2lr3i7g2ht43a0yja5", "authenticationType": "credential", "imagePullSecretName": "org-container-registry", "username": "newUserName" }`
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

containerRegistryJson

A JSON object of container registry properties. The only properties that can be updated are username, password, registryUrl, and registryRepository, with support for registryUrl and registryRepository being added at 12.0. Both the username and password property must be included in the request when updating the container registry. The password for the container registry can be entered as a plaintext value that will be encrypted once the request is complete.

Example
Use dark colors for code blocksCopy
containerRegistryJson={
  "registryUrl": "registry-url.example.com",
  "registryRepository": "registry-repository",
  "password": "newPassWord!",
  "isImagePullSecretSystemManaged": true,
  "name": "default",
  "id": "enf2lr3i7g2ht43a0yja5",
  "authenticationType": "credential",
  "imagePullSecretName": "org-container-registry",
  "username": "newUserName"
}

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the edit operation:

Use dark colors for code blocksCopy
POST /<context>/admin/system/containerregistries/enf2lr3i7g2ht43a0yja5/edit HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

containerRegistryJson={
  "registryUrl": "registry-url.example.com",
  "registryRepository": "registry-repository",
  "password": "newPassWord!",
  "isImagePullSecretSystemManaged": true,
  "name": "default",
  "id": "enf2lr3i7g2ht43a0yja5",
  "authenticationType": "credential",
  "imagePullSecretName": "org-container-registry",
  "username": "newUserName"
}&f=pjson&token=Mb0ORrkLObNO2Q8FZoUCHHzSMzZi0CbhLHNRYMqqa6URG_ojQJF3rNsJAfRB23MyCrLwSmuaHPUo4AEIrUuoH1-4Ot5xh4565FtlQahXAhK2C7Sy0oydZhBwD8KdFSnVlnLr-e9uI5ovSWZ2lGNn9SwoV2MPMzeAh_5r-q-wgwF8DTT_nhuCXJGkMRy-48jjGS2aN5FI18STHZ8RAuKxGasH90SI3C7njZzlGCUrY5m6BDhCMsdpZA14GwNX8Cis

JSON Response example

The following is a sample JSON response for an edit operation as of 12.0.

Use dark colors for code blocksCopy
{
  "progress": {"stages": [
    {
      "name": "validating",
      "state": "not_started"
    },
    {
      "name": "relational_store",
      "state": "not_started"
    },
    {
      "name": "object_store",
      "state": "not_started"
    },
    {
      "name": "spatio_temporal_index_store",
      "state": "not_started"
    },
    {
      "name": "queue_store",
      "state": "not_started"
    },
    {
      "name": "in_memory_store",
      "state": "not_started"
    },
    {
      "name": "key_framework_components",
      "state": "not_started"
    },
    {
      "name": "gis_services_and_other_components",
      "state": "not_started"
    }
  ]},
  "messages": [],
  "resource": {"name": "default (id: eb375m8hmnhzqf6q61yjn)"},
  "name": "editContainerRegistry",
  "updatedtime": 17589149904641,
  "jobid": "sc28aabe5-a5a5-4a3f-8fee-ccd4e3e8be4c",
  "requestID": "a8350c60-b31c-327d-20e5-1cd39d9aaa77"
  "endtime": 0,
  "starttime": 1758914989459,
  "operationURI": "/<context>/admin/system/containerregistries/<registryID>/edit",
  "result":{"credentialUpdateOnly": false},
  "status": "SUBMITTED",
  "username": "serviceAdmin"
}

The following is a sample JSON response for an edit operation before 12.0.

Use dark colors for code blocksCopy
{"status": "success"}