Gets a list of listings.

GET {{baseUrl}}/listings?limit=30&sortBy=TIMERELEASED&sortOrder=DESC&pricing=PAYGO&listingTypes=PARTNER&compartmentId={{compartment_ocid}}

Gets a list of listings from Oracle Cloud Infrastructure Marketplace by searching keywords and filtering according to listing attributes.

If you plan to launch an instance from an image listing, you must first subscribe to the listing. When you launch the instance, you also need to provide the image ID of the listing resource version that you want.

Subscribing to the listing requires you to first get a signature from the terms of use agreement for the listing resource version. To get the signature, issue a GetAppCatalogListingAgreements API call. The AppCatalogListingResourceVersionAgreements object, including its signature, is returned in the response. With the signature for the terms of use agreement for the desired listing resource version, create a subscription by issuing a CreateAppCatalogSubscription API call.

To get the image ID to launch an instance, issue a GetAppCatalogListingResourceVersion API call. Lastly, to launch the instance, use the image ID of the listing resource version to issue a LaunchInstance API call.

Request Params

KeyDatatypeRequiredDescription
namestringThe name of the listing.
namestringThe name of the listing.
listingIdstringThe unique identifier for the listing.
imageIdstringThe image identifier of the listing.
publisherIdstringLimit results to just this publisher.
packageTypestringA filter to return only packages that match the given package type exactly.
limitnumberHow many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.
pagestringThe value of the opc-next-page response header from the previous "List" call.
sortBystringThe field to use to sort listed results. You can only specify one field to sort by.
TIMERELEASED displays results in descending order by default.
You can change your preference by specifying a different sort order.
sortOrderstringThe sort order to use, either ASC or DESC.
categorystringName of the product category or categories. If you specify multiple categories, then Marketplace returns any listing with
one or more matching categories.
categorystringName of the product category or categories. If you specify multiple categories, then Marketplace returns any listing with
one or more matching categories.
pricingstringName of the pricing type. If multiple pricing types are provided, then any listing with
one or more matching pricing models will be returned.
pricingstringName of the pricing type. If multiple pricing types are provided, then any listing with
one or more matching pricing models will be returned.
isFeaturedbooleanIndicates whether to show only featured listings. If this is set to false or is omitted, then all listings will be returned.
listingTypesstringThe type of the listing.
listingTypesstringThe type of the listing.
operatingSystemsstringThe operating system of the listing.
operatingSystemsstringThe operating system of the listing.
compartmentIdstringThe unique identifier for the compartment.

HEADERS

KeyDatatypeRequiredDescription
opc-request-idstringUnique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
please provide the request ID.
Acceptstring

RESPONSES

status: OK

[{"categories":["eiusmod officia","laboris consectetur Ut deserunt"],"compatibleArchitectures":["X86","ARM"],"icon":{"contentUrl":"magna et ipsum","fileExtension":"culpa adipisicing","mimeType":"quis incididunt exercitation","name":"irure"},"id":"labor","isFeatured":false,"isRoverExportable":false,"listingType":"PRIVATE","name":"eiusmod enim in consequat","packageType":"IMAGE","pricingTypes":["BYOL","BYOL"],"publisher":{"description":"sunt ul","id":"est aute","name":"occaecat"},"regions":[{"code":"qui","countries":[{"code":"ad in in id","name":"officia sed"},{"code":"ut laboris","name":"aliquip laboris aute consequat"}],"name":"eu sit esse"},{"code":"amet mollit dolor enim","countries":[{"code":"Ut in est ","name":"laboris dolore"},{"code":"nisi eu Lorem","name":"minim aliquip fugiat veniam"}],"name":"pariatur"}],"shortDescription":"nulla tempor dolore ut","supportedOperatingSystems":[{"name":"in aliquip adipisicing sit"},{"name":"incididunt voluptate reprehenderit"}],"tagline":"deserunt Duis enim aute"},{"categories":["proident Lorem laborum Duis ad","nulla ut"],"compatibleArchitectures":["ARM","ARM"],"icon":{"contentUrl":"veniam velit","fileExtension":"commodo incididunt nisi","mimeType":"veniam eu laborum","name":"occaecat"},"id":"proident d","isFeatured":true,"isRoverExportable":false,"listingType":"PRIVATE","name":"irure velit tempor mollit aliqua","packageType":"IMAGE","pricingTypes":["PAYGO","FREE"],"publisher":{"description":"consectetur labore","id":"dolore qui in","name":"deserunt do ad"},"regions":[{"code":"sit mollit labore eu eiusmod","countries":[{"code":"deserunt cillum","name":"nulla"},{"code":"irure","name":"proident ad"}],"name":"in sint"},{"code":"cupidatat","countries":[{"code":"ut enim aliquip","name":"eiusmod dolor laborum ad"},{"code":"reprehenderit qui est ex","name":"elit proident laboris enim"}],"name":"veniam anim officia"}],"shortDescription":"voluptate officia veniam labore cillum","supportedOperatingSystems":[{"name":"deserunt amet consectetur dolor"},{"name":"aute"}],"tagline":"ad consectet"}]