ApiEndpoint

Type: Object

An endpoint is a custom HTTP endpoint that can be used as an API for your data. This enables interaction with external systems that require fixed formats, or for shortcuts to data that you use in your application.

Fields

Name	Type	Args	Description	Deprecated
active	Boolean!		Whether the endpoint is active
authToken	String!		The authentication token for the endpoint, to be used as a Bearer token
connection	Connection		The connection that owns this timer
connectionId	ID
contentType	ContentTypeEnum!		The content type that the endpoint will accept and respond with, incoming data will automatically be parsed and encoded to/from the correct type
createdAt	DateTime!
function	Function		The function to execute when this endpoint is called
functionId	ID
handle	String!		The handle of the endpoint, this will form the first part of the URL
id	ID!
name	String!		The name of the endpoint
path	String!		The path of the endpoint, this will form the second part of the URL, and supports dynamic segments such as /:id which will be passed as params to the endpoint
roleBindings	[IamRoleBinding!]!	filter: IamRoleBindingFilterInput limit: Int offset: Int sort: [IamRoleBindingSortInput]	The role bindings for the API endpoint
updatedAt	DateTime!
verb	HttpVerbEnum!		The HTTP verb that the endpoint will respond to

Relationships

• Connection
• Function