API Endpoint

Create a API Endpoint

Create a API Endpoint under an existing service.

post/v1/apiEndpoints

Request

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

Request body

namestring required
displayNamestring
descriptionstring
apiCollectionstring required
endpointURLstring uri
requestMethod'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'CONNECT' | 'OPTIONS' | 'TRACE'
extensionobject
sourceUrlstring
domainsstring[]
dataProductsstring[]
sourceHashstring

Response

The API Endpoint

idstring uuid required
namestring required
displayNamestring
fullyQualifiedNamestring
descriptionstring
versionnumber double
updatedAtinteger
updatedBystring
impersonatedBystring
endpointURLstring uri
requestMethod'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'CONNECT' | 'OPTIONS' | 'TRACE'
hrefstring uri
serviceType'Rest' | 'WEBHOOK'
deletedboolean
extensionobject
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.