Get Catalog

Get Catalog

Retrieves a specific catalog via URN.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/catalogs/{catalogUrn}
COPY
Path Parameters
string
catalogUrn
Required

catalogUrn

string
catalogUrn
Required

catalogUrn


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Catalog of type(s) application/json;version=39.0
{
    "id": "string",
    "sourceId": "string",
    "name": "string",
    "description": "string",
    "org": {
        "name": "string",
        "id": "string"
    },
    "isPublished": false,
    "isSubscribed": false,
    "isShared": false,
    "creationDate": "string",
    "owner": {
        "name": "string",
        "id": "string"
    },
    "versionNumber": 0,
    "numberOfVAppTemplates": 0,
    "numberOfMedia": 0,
    "catalogStorageProfiles": [
        {
            "name": "string",
            "id": "string"
        }
    ],
    "publishConfig": {
        "catalogPublishedUrl": "string",
        "isCachedEnabled": false,
        "preserveIdentityInfo": false,
        "password": "string"
    },
    "subscriptionConfig": {
        "subscriptionUrl": "string",
        "password": "string",
        "needLocalCopy": false
    },
    "distributedCatalogConfig": {
        "isDistributed": false,
        "isReadOnly": false,
        "distributedCatalogId": "string"
    }
}
string
id
Optional

A unique identifier for the catalog.

string
sourceId
Optional

A unique identifier (UUID) to globally identify this catalog. For a published or local catalog, this identifier is same as the id of the catalog. For subscribed catalogs, this identifier points to the id of the published catalog.

string
name
Optional

The name of the catalog.

string
description
Optional

The description of the catalog.

org
Optional

Entity reference used to describe VCD entities

boolean
isPublished
Optional

Whether this catalog is externally published.

boolean
isSubscribed
Optional

Whether this catalog is subscribed from an external catalog.

boolean
isShared
Optional

Whether this catalog is shared with other users or organziations.

string As date-time As date-time
creationDate
Optional

The ISO-8601 timestamp representing when this catalog was created.

owner
Optional

Entity reference used to describe VCD entities

integer As int64 As int64
versionNumber
Optional

Version number of this catalog.

integer As int64 As int64
numberOfVAppTemplates
Optional

Number of vApp templates in this catalog.

integer As int64 As int64
numberOfMedia
Optional

Number of media items in this catalog.

catalogStorageProfiles
Optional

A collection of OrgVdcStoragePolicy references used by this catalog.

publishConfig
Optional

An object representing publish settings of a catalog.

subscriptionConfig
Optional

An object representing subscription settings of a catalog.

distributedCatalogConfig
Optional

An object representing Distributed Catalog settings. A Distributed Catalog is a special kind of catalog that uses distributed storage to store its items.