Filter
Liberty REST APIs
1.0.0
OAS 3.0
Discover REST APIs available within Liberty
Servers
https://api.dataplatform.cloud.ibm.com:443
Authorize
AWS Temporary Credentials
POST
/v2
/catalogs
/temporary_credentials
Request temporary security credentials
Asset Attachments
POST
/v2
/assets
/{asset_id}
/attachments
Create an attachment
GET
/v2
/assets
/{asset_id}
/attachments
/{attachment_id}
Get an attachment
DELETE
/v2
/assets
/{asset_id}
/attachments
/{attachment_id}
Delete an attachment
PATCH
/v2
/assets
/{asset_id}
/attachments
/{attachment_id}
Update attachment metadata
POST
/v2
/assets
/{asset_id}
/attachments
/{attachment_id}
/complete
Mark an attachment as transfer complete
PATCH
/v2
/assets
/{asset_id}
/attachments
/{attachment_id}
/datasource_type
Auto update attachment's datasource_type from connection asset
GET
/v2
/assets
/{asset_id}
/attachments
/{attachment_id}
/resources
Get resources info for an attachment
PUT
/v2
/assets
/{asset_id}
/attachments
/{attachment_id}
/resources
Increase resources for an attachment
Asset Attributes
GET
/v2
/assets
/{asset_id}
/attributes
List all attributes
POST
/v2
/assets
/{asset_id}
/attributes
Create an attribute
GET
/v2
/assets
/{asset_id}
/attributes
/{attribute_key}
Get an attribute
DELETE
/v2
/assets
/{asset_id}
/attributes
/{attribute_key}
Delete an attribute
PATCH
/v2
/assets
/{asset_id}
/attributes
/{attribute_key}
Update attributes
Asset Containers
POST
/v2
/asset_containers
/archive
Archive the asset container
GET
/v2
/asset_containers
/archive_info
Get archive information of the asset container
GET
/v2
/asset_containers
/configurations
Get configurations
PUT
/v2
/asset_containers
/configurations
Replace or create configurations
POST
/v2
/asset_containers
/restore
Restore the asset container
Asset Document Conflicts
GET
/v2
/assets
/{asset_id}
/conflicts
Get asset document conflicts
DELETE
/v2
/assets
/{asset_id}
/conflicts
Delete asset document conflicts
Asset Images
GET
/v2
/assets
/{asset_id}
/images
Get the image of asset
PUT
/v2
/assets
/{asset_id}
/images
Upload an image for asset
DELETE
/v2
/assets
/{asset_id}
/images
/{image_id}
Delete the image of asset
Asset Lists
GET
/v2
/asset_lists
List all asset lists defined for an account
POST
/v2
/asset_lists
Create a new asset list
DELETE
/v2
/asset_lists
Delete asset lists
GET
/v2
/asset_lists
/{asset_list_id}
Retrieve an asset list identified by ID
DELETE
/v2
/asset_lists
/{asset_list_id}
Delete an asset list identified by ID
PATCH
/v2
/asset_lists
/{asset_list_id}
Update the metadata of an asset list
GET
/v2
/asset_lists
/{asset_list_id}
/items
List the items of an asset list identified by ID
GET
/v2
/asset_lists
/{asset_list_id}
/items
/{asset_list_item_id}
Retrieve an item in an asset list
PATCH
/v2
/asset_lists
/{asset_list_id}
/items
/{asset_list_item_id}
Update an asset list item
Asset Notes
GET
/v2
/assets
/note_stats
Get asset note stats
POST
/v2
/assets
/notes
/bulk
Bulk create asset notes
GET
/v2
/assets
/{asset_id}
/notes
Get asset or column notes
POST
/v2
/assets
/{asset_id}
/notes
Create notes on an asset
GET
/v2
/assets
/{asset_id}
/notes
/column_stats
Get the count of notes for each column in an asset
GET
/v2
/assets
/{asset_id}
/notes
/{note_id}
Get an asset or column note
DELETE
/v2
/assets
/{asset_id}
/notes
/{note_id}
Delete an asset or a column note
PATCH
/v2
/assets
/{asset_id}
/notes
/{note_id}
Update an asset or column note
Asset Ratings
POST
/v2
/assets
/ratings
/bulk
Bulk create asset ratings
GET
/v2
/assets
/{asset_id}
/ratings
Get ratings of an asset
POST
/v2
/assets
/{asset_id}
/ratings
Rate an asset
GET
/v2
/assets
/{asset_id}
/ratings
/stats
Get the count of each rating value for the specified asset
DELETE
/v2
/assets
/{asset_id}
/ratings
/{asset_rating_id}
Delete an asset rating
PATCH
/v2
/assets
/{asset_id}
/ratings
/{asset_rating_id}
Use this API to update an asset rating.
Asset Relationship Types
GET
/v2
/asset_relationship_types
Searches for relationship types
POST
/v2
/asset_relationship_types
Creates an asset relationship type
POST
/v2
/asset_relationship_types
/search_ends
Searches for relationship type ends
POST
/v2
/asset_relationship_types
/search_used_ends
Finds relationship types that are used by an asset, column or governance artifact
DELETE
/v2
/asset_relationship_types
/{relationship_type_id}
PATCH
/v2
/asset_relationship_types
/{relationship_type_id}
Patches a relationship type
Asset Relationships
POST
/v2
/assets
/get_relationships
Finds related assets
POST
/v2
/assets
/search_relationships
Searches for relationships
POST
/v2
/assets
/set_relationships
Create asset relationships
POST
/v2
/assets
/unset_relationships
Deletes asset relationships
GET
/v2
/assets
/{asset_id}
/relationship_types
Finds relationship types used by an asset
GET
/v2
/assets
/{asset_id}
/relationships
Finds related assets
PUT
/v2
/assets
/{asset_id}
/relationships
/{relationship_name}
Create asset relationships
DELETE
/v2
/assets
/{asset_id}
/relationships
/{relationship_name}
Deletes asset relationships
HEAD
/v2
/assets
/{asset_id}
/relationships
/{relationship_name}
Determine if a relationship exists between an asset and a target artifact
Asset Revisions
GET
/v2
/assets
/{asset_id}
/revisions
Get a list of revisions for an asset
POST
/v2
/assets
/{asset_id}
/revisions
Commit a revision of an asset
DELETE
/v2
/assets
/{asset_id}
/revisions
Delete a revision
Asset Trash
GET
/v2
/trashed_assets
List all assets in the trash (Marked for delete)
GET
/v2
/trashed_assets
/count
Get count of all assets in the trash (Marked for delete)
DELETE
/v2
/trashed_assets
/purge_all
Delete all assets from trash
GET
/v2
/trashed_assets
/{asset_id}
Get a soft-deleted object from trash
DELETE
/v2
/trashed_assets
/{asset_id}
Delete an asset from the trash
POST
/v2
/trashed_assets
/{asset_id}
/restore
Restore an asset from the trash
Asset Types
GET
/v2
/asset_types
List all asset types defined for an account, catalog, project or space.
POST
/v2
/asset_types
Creates an asset type in an account, catalog, project or space.
GET
/v2
/asset_types
/{type_name}
Retrieves an asset type of a given name.
PUT
/v2
/asset_types
/{type_name}
Replace an asset type
DELETE
/v2
/asset_types
/{type_name}
Deletes an asset type
GET
/v2
/asset_types
/{type_name}
/relationships
Finds relationship types for an asset type
POST
/v2
/asset_types
/{type_name}
/search
Search for asset metadata within assets of the specified type
GET
/v2
/asset_types
/{type_name}
/status
Get the status of an account scope or global scope asset type.
Assets
POST
/v2
/assets
Create an asset
GET
/v2
/assets
/bulk
Get one or more assets.
DELETE
/v2
/assets
/bulk
Marks existing assets for delete
GET
/v2
/assets
/bulk
/members
/{member_id}
Get assets membership for a specific user
POST
/v2
/assets
/bulk_copy
Copies one or more assets and, if deep copy option is on, their related assets from a source container to a target container.
POST
/v2
/assets
/bulk_create
Create one or more assets.
POST
/v2
/assets
/bulk_patch
Patch one or more assets.
GET
/v2
/assets
/copy_status
/{copy_task_id}
Gets the status of asset copy operation
POST
/v2
/assets
/create_object_url
Create a PUT signed url for an object or a file
GET
/v2
/assets
/deepcopy
/{deep_copy_task_id}
Gets the status of a deep copy operation
POST
/v2
/assets
/duplicates
/bulk_search
Bulk search duplicate assets
POST
/v2
/assets
/duplicates
/search
Search duplicate assets
GET
/v2
/assets
/ibm_data_source
Get an ibm_data_source asset
POST
/v2
/assets
/publish
Publish an asset from a project which is only referenced in that project
GET
/v2
/assets
/{asset_id}
Get an asset
DELETE
/v2
/assets
/{asset_id}
Marks an existing asset for delete
PATCH
/v2
/assets
/{asset_id}
Update an asset
POST
/v2
/assets
/{asset_id}
/clone
Clone an asset
PATCH
/v2
/assets
/{asset_id}
/collaborators
Add/Update asset collaborators
POST
/v2
/assets
/{asset_id}
/deepcopy
Deep copies an asset and its related assets to a catalog, project, or space
PUT
/v2
/assets
/{asset_id}
/owner
Update the owner of an asset
PUT
/v2
/assets
/{asset_id}
/perms
Update privacy settings of an asset
POST
/v2
/assets
/{asset_id}
/promote
Promote an asset
POST
/v2
/assets
/{asset_id}
/publish
Publish an asset
Assets And Relationships
POST
/v2
/assets
/create_with_relationships
Create assets with relationships simultaneously
Buckets
GET
/v2
/catalogs
/{catalog_id}
/asset_buckets
Get bucket info for a given container
POST
/v2
/catalogs
/{catalog_id}
/asset_buckets
Add bucket to catalog
DELETE
/v2
/catalogs
/{catalog_id}
/asset_buckets
/{bucket_id}
Delete a bucket
PATCH
/v2
/catalogs
/{catalog_id}
/asset_buckets
/{bucket_id}
Update bucket
CAMS Admin
GET
/v2
/cams
/admin
/catalogs
/accounts
Retrieve accounts
DELETE
/v2
/cams
/admin
/catalogs
/{catalog_id}
delete a catalog
POST
/v2
/cams
/admin
/catalogs
/{catalog_id}
/suspend
suspend a catalog
POST
/v2
/cams
/admin
/catalogs
/{catalog_id}
/unsuspend
unsuspend a catalog
DELETE
/v2
/cams
/admin
/delete_suspended_catalogs
Marks catalogs as deleted that have been suspended for 30 days.
POST
/v2
/cams
/admin
/id_conversion
Convert user ID to IAM ID or vice versa
POST
/v2
/cams
/admin
/index_repairs
Find and repair stuck temporary design documents by creating cache entries that resume their processing
GET
/v2
/cams
/admin
/index_repairs
/{id}
Gets the status of a temporary design document repair operation
POST
/v2
/cams
/admin
/reconfigure
Reconfigure the asset container
DELETE
/v2
/cams
/admin
/roles_cache_entry
Catalog Collections
GET
/v2
/catalogs
/{catalog_id}
/collections
List all catalog-level collections for a catalog
POST
/v2
/catalogs
/{catalog_id}
/collections
Create a catalog-level collection in a catalog
GET
/v2
/catalogs
/{catalog_id}
/collections
/{collection_id}
Get a catalog-level collection by collection ID
PUT
/v2
/catalogs
/{catalog_id}
/collections
/{collection_id}
Update a catalog-level collection for a catalog
DELETE
/v2
/catalogs
/{catalog_id}
/collections
/{collection_id}
Delete a catalog-level collection by collection id
GET
/v2
/catalogs
/{catalog_id}
/members
/{member_id}
/collections
List all collections for a user
POST
/v2
/catalogs
/{catalog_id}
/members
/{member_id}
/collections
Create a user collection in catalog
GET
/v2
/catalogs
/{catalog_id}
/members
/{member_id}
/collections
/{collection_id}
Get a user collection by collection ID
PUT
/v2
/catalogs
/{catalog_id}
/members
/{member_id}
/collections
/{collection_id}
Update a user-level collection
DELETE
/v2
/catalogs
/{catalog_id}
/members
/{member_id}
/collections
/{collection_id}
Delete a collection for the member from a catalog
Catalog Members
GET
/v2
/catalogs
/{catalog_id}
/members
List all members of the catalog
POST
/v2
/catalogs
/{catalog_id}
/members
Add members to a catalog
DELETE
/v2
/catalogs
/{catalog_id}
/members
/bulk
Delete members from a catalog
GET
/v2
/catalogs
/{catalog_id}
/members
/{member_id}
Get catalog membership for a specific user
DELETE
/v2
/catalogs
/{catalog_id}
/members
/{member_id}
Delete a member from a catalog
PATCH
/v2
/catalogs
/{catalog_id}
/members
/{member_id}
Update members in a catalog
Catalogs
GET
/v2
/catalogs
List all catalogs for a specific account
POST
/v2
/catalogs
Create a catalog
GET
/v2
/catalogs
/default
Retrieve the default catalog
POST
/v2
/catalogs
/default
Create the default catalog
POST
/v2
/catalogs
/default
/rehome
Rehome one or more synced assets.
GET
/v2
/catalogs
/default
/rehome
/status
Monitor status of rehome task
GET
/v2
/catalogs
/heartbeat
Get heartbeat for catalog
GET
/v2
/catalogs
/{catalog_id}
Get a catalog by catalog ID
DELETE
/v2
/catalogs
/{catalog_id}
Delete a catalog by catalog ID
PATCH
/v2
/catalogs
/{catalog_id}
Update catalog
GET
/v2
/catalogs
/{catalog_id}
/properties
List all properties of a catalog
PATCH
/v2
/catalogs
/{catalog_id}
/properties
Update catalog properties
GET
/v2
/catalogs
/{catalog_id}
/properties
/{property_key}
Get a single property in a catalog
PATCH
/v2
/catalogs
/{catalog_id}
/reconfigure
Update catalog connections
GET
/v2
/catalogs
/{catalog_id}
/state
Get the catalog state
Data Assets
POST
/v2
/data_assets
Create a data asset
GET
/v2
/data_assets
/{data_asset_id}
Get a data asset
GET
/v2
/data_assets
/{data_asset_id}
/columns
Get columns of a data asset
Expiration
DELETE
/v2
/catalogs
/{catalog_id}
/expire
expire a data lake -- permanently removes all assets (meta-data and objects)
Folder Assets
POST
/v2
/folder_assets
Create a folder asset
GET
/v2
/folder_assets
/{asset_id}
Get a folder asset
GET
/v2
/folder_assets
/{asset_id}
/contents
Get a signed URL of an item to be downloaded
Import Assets
POST
/v2
/catalogs
/export_assets
Export as a zip file containing appropriate csv files for the selected assets
POST
/v2
/catalogs
/import_assets
Process an import asset
Metrics
GET
/v2
/cams
/metrics
List all metrics
GET
/v2
/cams
/metrics
/asset_list_count
Get metrics of the asset lists
GET
/v2
/cams
/metrics
/user_access_count
Get metrics of the users who accessed the catalogs
GET
/v2
/cams
/warehouse-statistics
Get statistics runs history document
POST
/v2
/cams
/warehouse-statistics
Post warehouse statistics
GET
/v2
/cams
/warehouse-statistics
/{catalog_id}
Get warehouse statistics for a specific catalog
Sub Container Members
GET
/v2
/sub_containers
/{sub_container_id}
/members
List all members of the sub container
POST
/v2
/sub_containers
/{sub_container_id}
/members
Add members to a sub container
DELETE
/v2
/sub_containers
/{sub_container_id}
/members
/{member_id}
Delete a member from a sub container
Sub Containers
GET
/v2
/sub_containers
List all sub containers
POST
/v2
/sub_containers
Create a sub container
GET
/v2
/sub_containers
/{sub_container_id}
Get a sub container
DELETE
/v2
/sub_containers
/{sub_container_id}
Delete a sub container
Suspended Accounts
GET
/v2
/cams
/admin
/wkc_suspended_accounts
List all suspended BSS accounts that are eligible for removal
POST
/v2
/cams
/admin
/wkc_suspended_accounts
Add a BSS account to the suspended accounts list and suspend all catalogs for this account
DELETE
/v2
/cams
/admin
/wkc_suspended_accounts
Delete a BSS account from the suspended accounts list and unsuspend the suspended catalogs for this account
POST
/v2
/cams
/admin
/wkc_suspended_accounts
/entitlement_changes
Create entitlement changes for BSS accounts
DELETE
/v2
/cams
/admin
/wkc_suspended_accounts
/expire
Expires a suspended account and deletes all suspended catalogs for this account.
Schemas
AttachmentPartitionKey
IamId
CatalogLookupObject
BulkAssetsCreateRequest
BSSResponse
QualifiedArtifactId
ExternalAssetPreview
RelationshipTargetType
QualifiedAssetId
AssetTypeStatusResponse
ViewInfo
AssetListStatistics
MediaType
CLSourceSystem
RepairIndexesResponse
FoundRelationship
AssetRatingResult
CloudantDesignDocumentObject
AssetDocumentConflict
CLColumnDetail
ResponseRelationshipType
BulkAssetsCreateResponse
JsonPatch
CopiedAsset
ResponseAssetMetadata
CatalogBucket
IndexRepairStatusResponse
BulkSearchDuplicateRequest
Sub Container
MemberSet
CreateDefaultCatalogResponse
Link
CatalogMetadata
CLAssetMetadata
ListWithColumnNoteCountInfo
ArchiveInfo
Attribute
UserCollectionResponse
AssetListItemCollection
SourceAssetInfo
List Sub Containers Response
PublishAsset
MemberSetPartialResult
DeleteAssetDocumentConflictsRequest
DataProtection
RelationshipSource
BulkCreateAssetNotesRequestItem
AssetListReference
BulkAssetRatingsCreateResponse
LocalizedProperty
NewCookie
AssetRelationship
AssetSearchResponse
BulkAssetsCopyRequestEntry
RelationshipTypeControllerBase
FindRelatedObjectsResponse
RelationshipTypeEndpoint
ResponseAssetRov
CatalogFactoryBaseObjectObjectObjectObject
BulkMembersDeleteResponseEntry
BulkCreateAssetRatingsRequestItem
BaseCollectionNextPage
ExpireCatalogRequest
ErrorContainer
MetricsResponse
BulkAssetsCopyRequest
AssetCopyStatusNew
Credentials
CloudantApiDesignDocument
CloudantMapReduce
BulkCreateAssetNotesResponseItem
FindRelationshipTypesResponse
Attachment
RelationshipEntity
BaseCollection
CreationType
JsonNull
CatalogSearch
BulkAssetsCreateResponseEntry
AssetReference
AssetMember
ReadThroughAssetTypeCache
BulkAssetsCopyResponse
AssetCopyError
AssetPublishedFrom
MatchScore
BulkAssetsGetMembersResponseEntry
RelationshipCreationResult
FindRelationshipsResponse
RelationshipTypeControllerBaseObject
BulkAssetRelationshipsRequest
CreateDefaultCatalogRequest
CatalogSet
CatalogEntityWithBucket
TrashedAssetCountResponse
CollectionList
MemberRole
AssetNoteEntity
RelationshipTypeControllerBaseCLCatalog
BulkAssetsResponseEntry
AssetMetadataCreate
NewAssetAssetRov
TemporaryCredentials
CLColumnDetails
SearchResponseAsset
CatalogStateResponse
DeepCopyOptions
ColumnLoadListener
AssetTypeControllerBaseCLCatalog
CreateRelationshipsRequestBody
AttachmentPartition
BucketConnectionValue
AssetDocumentConflictsResponse
TokenPaginatedAssetNoteList
ColumnNoteCountInfo
UserInfo
SearchDuplicateResponse
AttachmentPartitions
CreationResponseAsset
FindRelatedObjectsOptions
RelationshipTypeEntity
Number
PublishAssetMetadata
DeepCopyResponse
BluemixCOSCredentialsResponse
DynamicAsset
GetTrashContentsResponse
CatalogFactoryBase
AssetImage
CatalogLookup
DateConstraints
BulkCreateAssetsRatingsRequest
ResponseAsset
UpdateType
AssetRatingCount
ArtifactTypeManager
RelatedAsset
ErrorContainerModel
CollectionAsset
FindOutgoingRelationshipTypesResponse
TypesResponse
GetColumnsResponse
MemberSearchResult
AssetCopyStatusEntry
CLColumnPositions
UserAccessMetricsResponse
BulkAssetsResponse
AssetContainer
CatalogCollectionResponse
SourceArtifactInfo
DefaultRelationshipController
BluemixCOSCredential
CatalogEntity
JsonNode
AssetListMetricsResponse
PageUrl
AssetListItem
CLAssetRovMembers
BulkMembersDeleteResponse
AssetTypeDuplicateStrategyConfig
MemberError
Asset
CreateAssetsAndRelationshipsRequest
CollectionListItem
AssetOwner
BulkAssetsUpdateRequestEntry
BulkAssetsDeleteResponse
AssetPublishedTo
SuspendedAccountsResponse
CLAttachmentHandle
CatalogLookupCLCatalog
IdConversion
RunHistoryEventResponse
RelationshipOptionOverride
CLCommitInfo
AttributeBehavior
BucketConnection
AssetContainerConfiguration
JsonStringPatch
AssetController
AssetNote
UserAccessStatistics
BaseCollectionPage
CLAttachment
AssetListPrototype
JsonPatchInstruction
ArchiveCatalogRequest
AssetListAccessControl
RelationshipDeleteResponse
AttachmentIncRes
BucketCredentialResponse
AssetTypeProperty
AssetCopyTo
MatchedDuplicateAsset
AssetTypeControllerBase
AccountInfo
FolderAsset
DataAsset
BulkAssetRatingsCreateResponseItem
RelationshipTypeMetadata
StatisticsResponse
RevInfo
JsonArray
BulkAssetsDeleteResponseEntry
Multimap
BucketListResponse
AssetRov
Type
JsonElement
BulkAssetRatingEntity
ErrorModel
SourceSystem
AssetListItemPrototype
TypeIdentity
FindOutgoingRelationshipTypesOptions
FileCopyStatus
AssetNoteMetadata
Locale
Sub Container Entity
CreateRelationshipsResponse
AssetUsage
ListWithAssetNoteCountInfo
JsonObject
AssetNotesCreationResponse
CLRelationshipTenancy
SourceSystemHistoryRecord
AssetTypeField
BucketResponse
StatisticsErrorSummary
AssetListSummary
DeleteRelationshipsResponse
AssetNotesCreationRequest
RelationshipDeletionResult
AssetTypeRelationship
BulkAssetsGetMembersResponse
UriBuilder
Member
BulkSearchDuplicateResponse
RelationshipSourceCriteria
IndexRepairOptions
ObjectURLReqResp
CollectionMetadata
AssetRatingStatsResponse
CredentialsResponse
CLAssetMember
ListAssetRevisionsResponse
OutgoingRelationshipType
CreateAssetsAndRelationshipsResponse
ContainerReference
AssetListBase
AssetNoteCreationResult
Catalog
GlobalSearchService
RelationshipTarget
AssetRatingEntity
AssetTypeInfo
BulkAssetsCopyResponseEntry
Collection
CLAsset
BulkAssetsUpdateRequest
BulkAssetsUpdateResponse
SourceAsset
JsonPrimitive
PropertiesObject
SearchDuplicateRequest
AssetCreateRequest
TemporaryCredentialsRequest
AssetCommitOptions
AssetMetadata
TokenPaginatedAssetRatingList
ErrorTargetModel
TargetModel
AssetListCollection
SubContainerResponse
AssetNoteCreationRequestItem
BulkCreateAssetNotesResponsePerAssetResultItem
EntityTag
RelationshipEndpoint
BulkCreateAssetNotesResponse
AssetCopyStatus
BulkAssetNoteEntity
AssetNoteController
BulkSearchDuplicateResponseEntry
AssetNoteCountInfo
BulkAssetsUpdateResponseEntry
BluemixCOSCredentials
Response
RelationshipDeleteResult
AssetRatingMetadata
StatusType
LocationAttribute
AssetRating
BulkCreateAssetNotesRequest
BulkAssetsCopyMetadataOverrides
MultimapStringErrorModel
AssetTypePointer