Get | VM Apps Org

Get

Returns the catalog source with the supplied ID.

Request

URI

GET

https://{api_host}/catalog/api/admin/sources/{sourceId}

COPY

Path Parameters

string

sourceId

Required

Catalog source ID

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

Returns CatalogSource of type(s) application/json

{
    "config": {},
    "createdAt": "string",
    "createdBy": "string",
    "creator": {
        "email": "string",
        "firstname": "string",
        "id": "string",
        "lastname": "string",
        "type": "string"
    },
    "description": "string",
    "global": false,
    "iconId": "string",
    "id": "string",
    "itemsFound": 0,
    "itemsImported": 0,
    "lastImportCompletedAt": "string",
    "lastImportErrors": [
        "string"
    ],
    "lastImportStartedAt": "string",
    "lastUpdatedAt": "string",
    "lastUpdatedBy": "string",
    "lastUpdater": {
        "email": "string",
        "firstname": "string",
        "id": "string",
        "lastname": "string",
        "type": "string"
    },
    "name": "string",
    "originOrgId": "string",
    "projectId": "string",
    "typeId": "string"
}

object

config

Required

config

string As date-time As date-time

createdAt

Optional

Creation time

string

createdBy

Optional

Created By

object

creator

Optional

Expanded policy last updater details

string

description

Optional

Constraints: maxLength: 2000

Catalog Source description

boolean

global

Optional

Global flag indicating that all the items can be requested across all projects.

string As uuid As uuid

iconId

Optional

Default Icon Id

string As uuid As uuid

Required

Catalog Source id

integer As int32 As int32

itemsFound

Optional

Number of items found

integer As int32 As int32

itemsImported

Optional

Number of items imported.

string As date-time As date-time

lastImportCompletedAt

Optional

Last import completion time

array of string

lastImportErrors

Optional

Last import error(s)

string As date-time As date-time

lastImportStartedAt

Optional

Last import start time

string As date-time As date-time

lastUpdatedAt

Optional

Update time

string

lastUpdatedBy

Optional

Updated By

object

lastUpdater

Optional

Expanded policy last updater details

string

name

Required

Constraints: maxLength: 1024

Catalog Source name

string

originOrgId

Optional

Org id where the source content originates from

string

projectId

Optional

Project id where the source content originates from

string

typeId

Required

Type of source, e.g. blueprint, CFT... etc

401

Unauthorized

Returns CatalogSource of type(s) application/json

"CatalogSource Object"

object

config

Required

config

string As date-time As date-time

createdAt

Optional

Creation time

string

createdBy

Optional

Created By

object

creator

Optional

Expanded policy last updater details

string

description

Optional

Constraints: maxLength: 2000

Catalog Source description

boolean

global

Optional

Global flag indicating that all the items can be requested across all projects.

string As uuid As uuid

iconId

Optional

Default Icon Id

string As uuid As uuid

Required

Catalog Source id

integer As int32 As int32

itemsFound

Optional

Number of items found

integer As int32 As int32

itemsImported

Optional

Number of items imported.

string As date-time As date-time

lastImportCompletedAt

Optional

Last import completion time

array of string

lastImportErrors

Optional

Last import error(s)

string As date-time As date-time

lastImportStartedAt

Optional

Last import start time

string As date-time As date-time

lastUpdatedAt

Optional

Update time

string

lastUpdatedBy

Optional

Updated By

object

lastUpdater

Optional

Expanded policy last updater details

string

name

Required

Constraints: maxLength: 1024

Catalog Source name

string

originOrgId

Optional

Org id where the source content originates from

string

projectId

Optional

Project id where the source content originates from

string

typeId

Required

Type of source, e.g. blueprint, CFT... etc

404

Not Found

Returns CatalogSource of type(s) application/json

"CatalogSource Object"

object

config

Required

config

string As date-time As date-time

createdAt

Optional

Creation time

string

createdBy

Optional

Created By

object

creator

Optional

Expanded policy last updater details

string

description

Optional

Constraints: maxLength: 2000

Catalog Source description

boolean

global

Optional

Global flag indicating that all the items can be requested across all projects.

string As uuid As uuid

iconId

Optional

Default Icon Id

string As uuid As uuid

Required

Catalog Source id

integer As int32 As int32

itemsFound

Optional

Number of items found

integer As int32 As int32

itemsImported

Optional

Number of items imported.

string As date-time As date-time

lastImportCompletedAt

Optional

Last import completion time

array of string

lastImportErrors

Optional

Last import error(s)

string As date-time As date-time

lastImportStartedAt

Optional

Last import start time

string As date-time As date-time

lastUpdatedAt

Optional

Update time

string

lastUpdatedBy

Optional

Updated By

object

lastUpdater

Optional

Expanded policy last updater details

string

name

Required

Constraints: maxLength: 1024

Catalog Source name

string

originOrgId

Optional

Org id where the source content originates from

string

projectId

Optional

Project id where the source content originates from

string

typeId

Required

Type of source, e.g. blueprint, CFT... etc

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/catalog/api/admin/sources/{sourceId}

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors

Catalog Sources Operations