Post Using POST | vRealize Automation Cloud Catalog API

Post Using POST

Creates a catalog source and imports catalog items from it.

Request

URI

POST

https://{api_host}//api.mgmt.cloud.vmware.com/catalog/api/admin/sources

COPY

Query Parameters

boolean

validationOnly

Optional

If true, the source will not be created. It returns the number of items belonging to the source. The request will still return an error code if the source is invalid.

Request Body

The catalog source to be created

CatalogSource of type(s) application/json

Optional

{
    "createdAt": "string",
    "createdBy": "string",
    "description": "string",
    "global": false,
    "id": "string",
    "itemsFound": 0,
    "itemsImported": 0,
    "lastImportCompletedAt": "string",
    "lastImportErrors": [
        "string"
    ],
    "lastImportStartedAt": "string",
    "lastUpdatedAt": "string",
    "lastUpdatedBy": "string",
    "name": "string",
    "projectId": "string",
    "typeId": "string"
}

object

config

Required

Source custom configuration

string As date-time As date-time

createdAt

Optional

Creation time

string

createdBy

Optional

Created By

string

description

Optional

Catalog Source description

boolean

global

Optional

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

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

string

name

Required

Catalog Source name

string

projectId

Optional

Project id where the source belongs

string

typeId

Required

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

Responses

200

Returns CatalogSource of type(s) */*

{
    "createdAt": "string",
    "createdBy": "string",
    "description": "string",
    "global": false,
    "id": "string",
    "itemsFound": 0,
    "itemsImported": 0,
    "lastImportCompletedAt": "string",
    "lastImportErrors": [
        "string"
    ],
    "lastImportStartedAt": "string",
    "lastUpdatedAt": "string",
    "lastUpdatedBy": "string",
    "name": "string",
    "projectId": "string",
    "typeId": "string"
}

object

config

Required

Source custom configuration

string As date-time As date-time

createdAt

Optional

Creation time

string

createdBy

Optional

Created By