Jump to

• Request
• Response

Export Image

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/goldImages/{goldImageId}/actions/export

Export a specified version of image. Refer to Create Image Version for details on importing the same.

Request

Path Parameters

• goldImageId(required): string
  ID of the image

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Image export details

Show Source

• destinationHostCredential(required): string
  Destination host target credential

  Example: HOST_CRED:ADMIN
• destinationHostName(required): string
  Destination host target name

  Example: myhost
• imageBundleLocation(required): string
  Image bundle location

  Example: /scratch/images/exportedimages
• imageBundleName: string
  Image bundle name

  Example: exportedImage_18c.zip
• versionId: string
  ID of the image version

  Example: E5B98897FE871AC1E05380FE4564F682
• versionName: string
  Name of the image version

  Example: fm_version_1
• workingDirectory: string
  Default Value: /tmp

  Staging/Working directory location

  Example: /u01/workdir

{
    "description":"Image export details",
    "type":"object",
    "required":[
        "destinationHostName",
        "destinationHostCredential",
        "imageBundleLocation"
    ],
    "properties":{
        "destinationHostName":{
            "description":"Destination host target name",
            "type":"string",
            "example":"myhost"
        },
        "destinationHostCredential":{
            "description":"Destination host target credential",
            "type":"string",
            "example":"HOST_CRED:ADMIN"
        },
        "imageBundleLocation":{
            "description":"Image bundle location",
            "type":"string",
            "example":"/scratch/images/exportedimages"
        },
        "imageBundleName":{
            "description":"Image bundle name",
            "type":"string",
            "example":"exportedImage_18c.zip"
        },
        "workingDirectory":{
            "description":"Staging/Working directory location",
            "type":"string",
            "default":"/tmp",
            "example":"/u01/workdir"
        },
        "versionName":{
            "description":"Name of the image version",
            "type":"string",
            "example":"fm_version_1"
        },
        "versionId":{
            "description":"ID of the image version",
            "type":"string",
            "example":"E5B98897FE871AC1E05380FE4564F682"
        }
    }
}

Examples

Select an example Payload

Back to Top

Response

202 Response

It is a long running/async API. It submits a deployment procedure.

Headers

• Location:
  URL link to track the status of the API for the deployment procedure

  Example:

  /deploymentProcedureInstances/{deploymentProcedureInstanceId}

Body ()

Root Schema : schema

Type: object

Show Source

• links: object links
  links
• message: string
  message

  Example: It is a long running/async API. It submits a deployment procedure.

{
    "type":"object",
    "properties":{
        "message":{
            "description":"message",
            "type":"string",
            "example":"It is a long running/async API. It submits a deployment procedure."
        },
        "links":{
            "description":"links",
            "type":"object",
            "properties":{
                "tracking":{
                    "type":"object",
                    "description":"Represents a link to the REST API to track the status of the submitted deployment procedure",
                    "properties":{
                        "href":{
                            "type":"string",
                            "description":"URL for the link",
                            "example":"/deploymentProcedureInstances/{deploymentProcedureInstanceId}"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : links

Type: object

links

Show Source

• tracking: object tracking
  Represents a link to the REST API to track the status of the submitted deployment procedure

{
    "description":"links",
    "type":"object",
    "properties":{
        "tracking":{
            "type":"object",
            "description":"Represents a link to the REST API to track the status of the submitted deployment procedure",
            "properties":{
                "href":{
                    "type":"string",
                    "description":"URL for the link",
                    "example":"/deploymentProcedureInstances/{deploymentProcedureInstanceId}"
                }
            }
        }
    }
}

Nested Schema : tracking

Type: object

Represents a link to the REST API to track the status of the submitted deployment procedure

Show Source

• href: string
  URL for the link

  Example: /deploymentProcedureInstances/{deploymentProcedureInstanceId}

{
    "type":"object",
    "description":"Represents a link to the REST API to track the status of the submitted deployment procedure",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for the link",
            "example":"/deploymentProcedureInstances/{deploymentProcedureInstanceId}"
        }
    }
}

401 Response

Unauthorized. The user does not have permissions to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

403 Response

Forbidden. The user is forbidden to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. Exception in execution of REST API.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503 Response

Service Unavailable. The server is unable to process the request.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

Back to Top