Containers

Create or update a Container

Create a new Container, if it does not exist or update an existing container.

put/v1/containers

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/containers
  • Auth: HTTP bearer

Request body

namestring required
displayNamestring
descriptionstring
servicestring required
prefixstring
numberOfObjectsnumber double
sizenumber double
fileFormatsstring[]
extensionobject
sourceUrlstring
fullPathstring
domainsstring[]
dataProductsstring[]
sourceHashstring

Response

The Container

idstring uuid required
namestring required
fullyQualifiedNamestring
displayNamestring
descriptionstring
versionnumber double
updatedAtinteger
updatedBystring
impersonatedBystring
hrefstring uri
prefixstring
numberOfObjectsnumber double
sizenumber double
fileFormatsstring[]
serviceType'S3' | 'ADLS' | 'GCS' | 'CustomStorage'
deletedboolean
retentionPeriodstring
extensionobject
sourceUrlstring
fullPathstring
sourceHashstring
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
provider'system' | 'user' | 'automation'

Changes

No recorded changes to this operation across all 1 revision of this API.