REST API Reference

Back Next

Images

Use the RuntimeApplicationImage resource to list the images for an elastic runtime environment.

GET request

To list all available images, use the following URI:

/public/core/v3/ais/RuntimeApplicationImage?runtimeEnvironmentId=<rteId>&includeAllImageStates=<true or false>

Include the following parameter:

Parameter	Type	Description
rteId	String	Runtime environment ID from which images are downloaded.
includeAllImageStates	Boolean	Returns the current stage of the image download until it's complete.

The following table lists the potential error codes for a request:

HTTP status code	Description
401	Unauthenticated or unauthorized.
403	Privilege get.k8s.repository.token is required for accessing this API.

GET response

If successful, a list of available images is returned.

GET response examples

To list available images for download, use the following request:

GET <baseApiUrl>/public/core/v3/RuntimeApplicationImage?runtimeEnvironmentId=<rteId>&includeAllImageStates=<true or false>
Content-type: application/json
Accept: application/json
INFA-SESSION-ID: <SessionId>

If successful, you might receive a "200 OK" response like the following example:

[
    {
        "appSpecName": "Data_Integration",
        "appSpecVersion": "64.0",
        "dependencies": "package-Administrator_R1.226",
        "imageName": "Data_Integration",
        "imageVersion": "64.0",
        "imageRepositoryPath": "infacloud-k8s-agent-docker-dev.jfrog.io/3SLs6FMAlJ0lGGyI0pMK0g/rteId1/DataIntegration:64.0",
        "rteGroupId": "rteId1",
        "orgId": "3SLs6FMAlJ0lGGyI0pMK0g",
        "imageState": "IMAGE_BAKE_COMPLETE",
        "endTime": "2022-10-31T07:06:59.000Z",
        "helmChartPath": "helmChartPath"
    },
    {
        "appSpecName": "Data_Integration",
        "appSpecVersion": "64.1",
        "dependencies": "package-Administrator_R1.226,
        "imageName": "Data_Integration,
        "imageVersion": "64.1",
        "imageRepositoryPath": "infacloud-k8s-agent-docker-dev.jfrog.io/3SLs6FMAlJ0lGGyI0pMK0g/rteId1/DataIntegration:64.1",
        "rteGroupId": "rteId1",
        "orgId": "3SLs6FMAlJ0lGGyI0pMK0g",
        "imageState": "IMAGE_BAKE_COMPLETE",
        "endTime": "2022-10-31T07:06:59.000Z",
        "helmChartPath": "helmChartPath"
    }
]

If you have insufficient privileges, you might receive a "403 Forbidden" response like the following example:

{
    "error": {
        "code": "AIS_007",
        "message": "Privilege - view.k8s.agent.config required for accessing this API.",
        "debugMessage": "Privilege - view.k8s.agent.config required for accessing this API.",
        "requestId": "l2EpwkFoqkEjrEJURclPw2",
        "details": null
    }
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Images

Images

GET request

GET response

GET response examples