Apis hooks
Hand-written shim. Implementation is generated; see ./apis.gen.
Hooks
useCreateApi mutation
Create a new API.
TypeScript
useCreateApi(options?: MutationOpts<Api, CreateApiParams>)Types: Api · CreateApiParams
useDeleteApi mutation
Soft-delete an API.
TypeScript
useDeleteApi(options?: MutationOpts<SuccessResponse, DeleteApiParams>)Types: SuccessResponse · DeleteApiParams
useListApis query
List APIs.
TypeScript
useListApis(params?: Omit<ListApisParams, | > & { filter?: ApiFilter; orderBy?: ApiOrderBy[]; } & ApiShorthands, options?: QueryOpts<Page<Api>>)Types: ListApisParams · ApiFilter · ApiOrderBy · ApiShorthands · Page · Api
usePurgeApi composite
Permanently delete a soft-deleted API.
TypeScript
usePurgeApi(options?: MutationOpts<SuccessResponse, PurgeApiParams>)Types: SuccessResponse · PurgeApiParams
useRestoreApi composite
Restore a soft-deleted API.
TypeScript
useRestoreApi(options?: MutationOpts<Api, string>)Types: Api
useRetrieveApi query
Get a single API by ID.
TypeScript
useRetrieveApi(id: string, options?: QueryOpts<Api>)Types: Api
useUpdateApi mutation
Update an API.
TypeScript
useUpdateApi(options?: MutationOpts<Api, UpdateApiParams>)Types: Api · UpdateApiParams