AeontelAeontel Docs

Endpoints hooks

Hand-written shim. Implementation is generated; see ./endpoints.gen.

Hooks

useCreateEndpoint mutation

Create an endpoint.

TypeScript
useCreateEndpoint(options?: MutationOpts<Endpoint, CreateEndpointParams>)

Types: Endpoint · CreateEndpointParams

useDeleteEndpoint mutation

Soft-delete an endpoint.

TypeScript
useDeleteEndpoint(options?: MutationOpts<SuccessResponse, string>)

Types: SuccessResponse

useListEndpoints query

List endpoints.

TypeScript
useListEndpoints(params?: Omit<ListEndpointsParams, | > & { filter?: EndpointFilter; orderBy?: EndpointOrderBy[]; } & EndpointShorthands, options?: QueryOpts<Page<Endpoint>>)

Types: ListEndpointsParams · EndpointFilter · EndpointOrderBy · EndpointShorthands · Page · Endpoint

usePurgeEndpoint composite

Permanently delete a soft-deleted endpoint.

TypeScript
usePurgeEndpoint(options?: MutationOpts<SuccessResponse, PurgeEndpointParams>)

Types: SuccessResponse · PurgeEndpointParams

useRestoreEndpoint composite

Restore a soft-deleted endpoint.

TypeScript
useRestoreEndpoint(options?: MutationOpts<Endpoint, string>)

Types: Endpoint

useRetrieveEndpoint query

Get an endpoint by ID.

TypeScript
useRetrieveEndpoint(id: string, options?: QueryOpts<Endpoint>)

Types: Endpoint

useUpdateEndpoint mutation

Update an endpoint.

TypeScript
useUpdateEndpoint(options?: MutationOpts<Endpoint, UpdateEndpointParams>)

Types: Endpoint · UpdateEndpointParams