ListImages
GET {{baseUrl}}/images?compartmentId={{compartment_ocid}}&limit=801&sortBy=TIMECREATED&sortOrder=DESC&lifecycleState=AVAILABLE
Lists a subset of images available in the specified compartment, including platform images and custom images. The list of platform images includes the three most recently published versions of each major distribution.
The list of images returned is ordered to first show the recent platform images, then all of the custom images.
Caution: Platform images are refreshed regularly. When new images are released, older versions are replaced. The image OCIDs remain available, but when the platform image is replaced, the image OCIDs are no longer returned as part of the platform image list.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
compartmentId | string | (Required) The OCID of the compartment. | |
displayName | string | A filter to return only resources that match the given display name exactly. | |
operatingSystem | string | The image's operating system. |
Example: Oracle Linux
|
| operatingSystemVersion | number | | The image's operating system version.
Example: 7.2
|
| shape | string | | Shape name. |
| limit | number | | For list pagination. The maximum number of results per page, or items to return in a paginated
"List" call. For important details about how pagination works, see
List Pagination.
Example: 50
|
| page | string | | For list pagination. The value of the opc-next-page response header from the previous "List"
call. For important details about how pagination works, see
List Pagination.
|
| sortBy | string | | The field to sort by. You can provide one sort order (sortOrder). Default order for
TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
sort order is case sensitive.
Note: In general, some "List" operations (for example, ListInstances) let you
optionally filter by availability domain if the scope of the resource type is within a
single availability domain. If you call one of these "List" operations without specifying
an availability domain, the resources are grouped by availability domain, then sorted.
|
| sortOrder | string | | The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order
is case sensitive.
|
| lifecycleState | string | | A filter to only return resources that match the given lifecycle state. The state
value is case-insensitive.
|
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Date | string | (Required) Current Date | |
Authorization | string | (Required) Signature Authentication on Authorization header |
RESPONSES
status: OK
[{"compartmentId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lifecycleState":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"timeCreated":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"operatingSystem":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"operatingSystemVersion":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"createImageAllowed":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"agentFeatures":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"baseImageId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"billableSizeInGBs":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"definedTags":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"displayName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"freeformTags":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"launchMode":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"launchOptions":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sizeInMBs":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"compartmentId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lifecycleState":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"timeCreated":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"operatingSystem":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"operatingSystemVersion":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"createImageAllowed":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"agentFeatures":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"baseImageId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"billableSizeInGBs":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"definedTags":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"displayName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"freeformTags":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"launchMode":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"launchOptions":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sizeInMBs":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]