Get Content Library

Get Content Library

Retrieves a specific content library via URN.

Request
URI
GET
https://{api_host}/cloudapi/vcf/contentLibraries/{libraryUrn}
COPY
Path Parameters
string
libraryUrn
Required

libraryUrn

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ContentLibrary of type(s) application/json;version=40.0 
{
    "id": "string",
    "name": "string",
    "description": "string",
    "org": {
        "name": "string",
        "id": "string"
    },
    "libraryType": "string",
    "isSubscribed": false,
    "isShared": false,
    "creationDate": "string",
    "storageClasses": [
        {
            "name": "string",
            "id": "string"
        }
    ],
    "versionNumber": 0,
    "subscriptionConfig": {
        "subscriptionUrl": "string",
        "password": "string",
        "needLocalCopy": false
    },
    "autoAttach": false,
    "status": "READY, NOT_READY, FAILED, PARTIALLY_READY"
}
string
id
Optional

A unique identifier for the Content library.

string
name
Required

The name of the Content Library.

string
description
Optional

The description of the Content Library.

object
org
Optional

Entity reference used to describe VCD entities

string
libraryType
Optional

The type of content library.

  • PROVIDER - Content Library that is scoped to a provider.
  • TENANT - Content Library that is scoped to a tenant organization.

boolean
isSubscribed
Optional

Whether this Content Library is subscribed from an external published library.

boolean
isShared
Optional

Whether this Content Library is shared with other organziations.

string As date-time As date-time
creationDate
Optional

The ISO-8601 timestamp representing when this Content Library was created.

array of object
storageClasses
Optional

A collection of storage class references used by this Content Library.

integer As int64 As int64
versionNumber
Optional

Version number of this Content library.

object
subscriptionConfig
Optional

An object representing subscription settings of an Content Library.

boolean
autoAttach
Optional
Constraints: default: true

For Tenant Content Libraries this field represents whether this Content Library should be automatically attached to all current and future namespaces in the tenant organization. If no value is supplied during Tenant Content Library creation then this field will default to true. If a value of false is supplied, then this Tenant Content Library will only be attached to namespaces that explicitly request it. For Provider Content Libraries this field is not needed for creation and will always be returned as true. This field cannot be updated after Content Library creation.

string
status
Optional

Status of this content library.


Vendor Extension

This operation contains the following vendor extensions defined in the spec:

                    [object Object]
Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/vcf/contentLibraries/{libraryUrn}
Availability
Added in 40.0
On This Page
Content Library Operations
GET
Query Content Libraries
POST
Create Content Library
POST
Refresh Content Library
POST
Sync Content Library
GET
Get Content Library
PUT
Update Content Library
DELETE
Delete Content Library