Update Image Profile

Update Image Profile

Update image profile. All existing image mapping definitions for the specified region will be replaced with the payload provided and if you want to keep the existing definitions, they should be added to the payload.

Request
URI
PATCH
https://vra-interop-222-139.lvn.broadcom.net/iaas/api/image-profiles/{id}
COPY
Path Parameters
string
id
Required

The ID of the image.

Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about


Request Body

ImageProfile instance

UpdateImageProfileSpecification of type(s) application/json
Required

Show optional properties

{
    "name": "string",
    "imageMapping": {}
}
{
    "name": "string",
    "description": "string",
    "imageMapping": {
        "ubuntu": {
            "id": "9e49",
            "name": "ami-ubuntu-16.04-1.9.1-00-1516139717"
        },
        "centos": {
            "id": "9e50",
            "name": "ami-centos-7-1.13.0-00-1543963388"
        }
    }
}
string
name
Required

A human-friendly name used as an identifier in APIs that support this option.

string
description
Optional

A human-friendly description.

object
imageMapping
Required

Image mapping defined for the corresponding region.

Authentication
This operation uses the following authentication methods.
Responses
200

Successful operation

Returns ImageProfile of type(s) application/json
"ImageProfile Object"
string
id
Required

The id of this resource instance

string
createdAt
Optional

Date when the entity was created. The date is in ISO 8601 and UTC.

string
updatedAt
Optional

Date when the entity was last updated. The date is ISO 8601 and UTC.

string
owner
Optional

Email of the user or display name of the group that owns the entity.

string
ownerType
Optional

Type of a owner(user/ad_group) that owns the entity.

string
orgId
Optional

The id of the organization this entity belongs to.

object
_links
Required

HATEOAS of the entity

string
name
Optional

A human-friendly name used as an identifier in APIs that support this option.

string
description
Optional

A human-friendly description.

object
imageMappings
Required

Describes an image mapping between image key and fabric image.
HATEOAS links:
region - Region - Region for the mapping.

string
externalRegionId
Optional

The id of the region for which this profile is defined

string
cloudAccountId
Optional

Id of the cloud account this image profile belongs to.


403

Forbidden

Returns ServiceErrorResponse of type(s) application/json
"ServiceErrorResponse Object"
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


404

Not found

Returns ServiceErrorResponse of type(s) application/json
"ServiceErrorResponse Object"
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


Code Samples
COPY
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"imageMapping:"object","name:"string"}'