API Endpoint

Get a APIEndpoint by id

Get a APIEndpoint by id.

get/v1/apiEndpoints/{id}

Request

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

Path parameters

idstring uuid required

Id of the APIEndpoint

Query parameters

fieldsstring
Example:owners,followers,tags,extension,domains,dataProducts,sourceHash

Fields requested in the returned resource

include'all' | 'deleted' | 'non-deleted'

Include all, deleted, or non-deleted entities.

includeRelationsstring
Example:owners:non-deleted,followers:all

Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity's include value.

Response

The APIEndpoint

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.