Edit image information
    • PDF

    Edit image information

    • PDF

    Article summary

    Available in Classic and VPC

    Edit short description (description) and detailed description (full_description) information registered for a specific image registered in the registry of Container Registry.

    Requests

    The following describes the request format for the endpoint. The request format is as follows.

    MethodURI
    PATCH/repositories/{registry}/{imageName}

    Request headers

    For headers common to all Container Registry APIs, see Container Registry common headers.

    Request path parameters

    The following describes the parameters.

    FieldTypeRequiredDescription
    registryStringRequiredName of the registry where the image for which you want to edit information is registered
    imageNameStringRequiredName of the image to edit the information
    • Need to use URI encoded values
    • <Example> For hello/world, convert to hello%2Fworld and use it

    Request syntax

    The request syntax is as follows.

    {
      "description": "string",
      "full_description": "string"
    }
    

    Request body

    The following describes the request body.

    FieldTypeRequiredDescription
    descriptionStringOptionalCreate short description for the image
    • Under 100 characters
    full_descriptionStringOptionalCreate detailed description for the image
    • Markdown supported

    Request example

    The following is a sample request.

    curl -X PATCH "https://ncr.apigw.ntruss.com/ncr/api/v2/repositories/{registry}/{imageName}" 
    -H "x-ncp-apigw-timestamp: {Timestamp}"
    -H "x-ncp-iam-access-key: {Sub Account Access Key}"
    -H "x-ncp-apigw-signature-v2: {API Gateway Signature}"
    -d "
    {
      "description": "string",
      "full_description": "string"
    }
    "
    

    Responses

    The following describes the response format.

    Response syntax

    The response syntax is as follows.

    None
    

    Response status codes

    The following describes response status codes. For response status codes common to all Container Registry APIs, see Container Registry response status codes.

    HTTP status codeCodeMessageDescription
    204-OKRequest succeeded
    404-Not FoundRequested resource not found

    Was this article helpful?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.