Jump to

• Request
• Response
• Examples

Update a specific registry entry

put

/api/v2/registries/{registry_id}

Updates a specific registry. You identify the registry using the registry_id parameter.

Request

Supported Media Types

• application/json

Path Parameters

• registry_id: string
  registry_id

Body ()

Body parameters

Root Schema : schema

Type: object

Show Source

• description: string
• email: string
• password: string
• url: string
• username: string

{
    "properties":{
        "description":{
            "type":"string"
        },
        "email":{
            "type":"string"
        },
        "password":{
            "type":"string"
        },
        "url":{
            "type":"string"
        },
        "username":{
            "type":"string"
        }
    },
    "required":[
        "description",
        "email",
        "password",
        "url",
        "username"
    ],
    "type":"object"
}

Security

• Authorization: apiKey
  Type: apiKey

Back to Top

Response

Supported Media Types

• application/json

200 Response

200 Response

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object items

{
    "items":{
        "properties":{
            "elapsed_time":{
                "type":"number"
            },
            "registry":{
                "properties":{
                    "description":{
                        "type":"string"
                    },
                    "email":{
                        "type":"string"
                    },
                    "password":{
                        "type":"string"
                    },
                    "registry_id":{
                        "type":"string"
                    },
                    "url":{
                        "type":"string"
                    },
                    "username":{
                        "type":"string"
                    }
                },
                "required":[
                    "description",
                    "email",
                    "password",
                    "registry_id",
                    "url",
                    "username"
                ],
                "type":"object"
            },
            "total_results":{
                "type":"integer"
            }
        },
        "required":[
            "elapsed_time",
            "registry",
            "total_results"
        ],
        "type":"object"
    }
}

Nested Schema : items

Type: object

Show Source

• elapsed_time: number
• registry: object registry
• total_results: integer

{
    "properties":{
        "elapsed_time":{
            "type":"number"
        },
        "registry":{
            "properties":{
                "description":{
                    "type":"string"
                },
                "email":{
                    "type":"string"
                },
                "password":{
                    "type":"string"
                },
                "registry_id":{
                    "type":"string"
                },
                "url":{
                    "type":"string"
                },
                "username":{
                    "type":"string"
                }
            },
            "required":[
                "description",
                "email",
                "password",
                "registry_id",
                "url",
                "username"
            ],
            "type":"object"
        },
        "total_results":{
            "type":"integer"
        }
    },
    "required":[
        "elapsed_time",
        "registry",
        "total_results"
    ],
    "type":"object"
}

Nested Schema : registry

Type: object

Show Source

• description: string
• email: string
• password: string
• registry_id: string
• url: string
• username: string

{
    "properties":{
        "description":{
            "type":"string"
        },
        "email":{
            "type":"string"
        },
        "password":{
            "type":"string"
        },
        "registry_id":{
            "type":"string"
        },
        "url":{
            "type":"string"
        },
        "username":{
            "type":"string"
        }
    },
    "required":[
        "description",
        "email",
        "password",
        "registry_id",
        "url",
        "username"
    ],
    "type":"object"
}

Default Response

Error Payload

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    }
}

Back to Top

Examples

The following example shows how to update an existing registry. You perform this task by submitting a PUT request to the REST resource using cURL. For more information about cURL, see Use cURL.

Note: The command in this example uses the URL structure https://rest_server_url/resource-path, where rest_server_url is the manager node for the Oracle Cloud Container instance. See Send Requests for the appropriate URL structure to use for Oracle Public Cloud.

cURL Command

curl -sk 
     -X "PUT" 
     -H "Authorization: Bearer b39f09c71c297f1d" 
     "https://rest_server_url/api/v2/registries/" 
     -d '{"registry_id":"ffea6b9477d7701a",
          "url":"index.docker.io",
          "email":"[e-mail]",
          "username":"admin",
          "password":"password",
          "description":"Public Docker Hub Registry"}'

Example of Response Body

{
  "elapsed_time": 0.000655836,
  "registries": [
    {
      "registry_id": "ffea6b9477d7701a",
      "url": "index.docker.io",
      "email": "",
      "username": "",
      "password": "",
      "description": "Public Docker Hub Registry"
    }
  ],
  "total_results": 1
}

Back to Top