Jump to

• Request
• Response

Delete Image Version

delete

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/goldImages/{goldImageId}/versions/{versionId}

Deletes the specified version of the image. For FPP based version of image, this is an asynchronous operation, which submits a deployment procedure to perform the task. FPP REST User credentials are required for deleting FPP based version of the image.

Request

Path Parameters

• goldImageId(required): string
  ID of the image
• versionId(required): string
  ID of the image version

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• object DeleteImageInput
  Delete gold image option

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DeleteImageInput"
        }
    ]
}

Nested Schema : DeleteImageInput

Type: object

Delete gold image option

Show Source

• fppRestUser: string
  REST user to be used for an FPP REST call

  Example: rest_cuser
• isForce: boolean
  Flag to force delete even if targets are subscribed

{
    "description":"Delete gold image option",
    "type":"object",
    "properties":{
        "isForce":{
            "description":"Flag to force delete even if targets are subscribed",
            "type":"boolean"
        },
        "fppRestUser":{
            "description":"REST user to be used for an FPP REST call",
            "type":"string",
            "example":"rest_cuser"
        }
    }
}

Back to Top

Response

202 Response

It is a long running/async API. It submits a deployment procedure for deletion of an FPP image.

Headers

• Location:
  URL link to track 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 for deletion of an FPP image.

{
    "type":"object",
    "properties":{
        "message":{
            "description":"message",
            "type":"string",
            "example":"It is a long running/async API. It submits a deployment procedure for deletion of an FPP image."
        },
        "links":{
            "description":"links",
            "type":"object",
            "properties":{
                "tracking":{
                    "type":"object",
                    "description":"Represents the link to 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 the link to REST API to track the status of the submitted deployment procedure

{
    "description":"links",
    "type":"object",
    "properties":{
        "tracking":{
            "type":"object",
            "description":"Represents the link to 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 the link to 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 the link to REST API to track the status of the submitted deployment procedure",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for the Link",
            "example":"/deploymentProcedureInstances/{deploymentProcedureInstanceId}"
        }
    }
}

204 Response

No content. This is the native fleet Gold Image version delete response

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"
        }
    }
}

404 Response

Not Found. The requested REST API URL is not found.

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