API Services

Create API service

Create a new API service.

post/v1/services/apiServices

Request

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

Request body

namestring required
displayNamestring
descriptionstring
serviceType'Rest' | 'WEBHOOK' required
dataProductsstring[]
domainsstring[]
extensionobject

Response

API service instance

idstring uuid required
namestring required
fullyQualifiedNamestring
displayNamestring
serviceType'Rest' | 'WEBHOOK' required
descriptionstring
versionnumber double
updatedAtinteger
updatedBystring
impersonatedBystring
hrefstring uri
deletedboolean
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
provider'system' | 'user' | 'automation'
extensionobject
sourceHashstring

Changes

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