Vikunja.API.Api

Operations

Api

routesGet

routesGet :: VikunjaRequest RoutesGet MimeNoContent [ModelsRouteDetail] MimeJSON

GET /routes

Get a list of all token api routes

Returns a list of all API routes which are available to use with an api token, not a user login.

AuthMethod: AuthApiKeyJWTKeyAuth

data RoutesGet

Instances

Produces RoutesGet MimeJSON

application/json

Defined in Vikunja.API.Api

tokensGet

tokensGet :: VikunjaRequest TokensGet MimeNoContent [ModelsAPIToken] MimeJSON

GET /tokens

Get all api tokens of the current user

Returns all api tokens the current user has created.

AuthMethod: AuthApiKeyJWTKeyAuth

data TokensGet

Instances

Produces TokensGet MimeJSON

application/json

Defined in Vikunja.API.Api

HasOptionalParam TokensGet S

Optional Param "s" - Search tokens by their title.

Defined in Vikunja.API.Api

Methods

applyOptionalParam :: VikunjaRequest TokensGet contentType res accept -> S -> VikunjaRequest TokensGet contentType res accept

(-&-) :: VikunjaRequest TokensGet contentType res accept -> S -> VikunjaRequest TokensGet contentType res accept

HasOptionalParam TokensGet PerPage

Optional Param "per_page" - The maximum number of tokens per page. This parameter is limited by the configured maximum of items per page.

Defined in Vikunja.API.Api

Methods

applyOptionalParam :: VikunjaRequest TokensGet contentType res accept -> PerPage -> VikunjaRequest TokensGet contentType res accept

(-&-) :: VikunjaRequest TokensGet contentType res accept -> PerPage -> VikunjaRequest TokensGet contentType res accept

HasOptionalParam TokensGet Page

Optional Param "page" - The page number, used for pagination. If not provided, the first page of results is returned.

Defined in Vikunja.API.Api

Methods

applyOptionalParam :: VikunjaRequest TokensGet contentType res accept -> Page -> VikunjaRequest TokensGet contentType res accept

(-&-) :: VikunjaRequest TokensGet contentType res accept -> Page -> VikunjaRequest TokensGet contentType res accept

tokensPut

tokensPut

Arguments

:: (Consumes TokensPut MimeJSON, MimeRender MimeJSON ModelsAPIToken)

=> ModelsAPIToken

"token" - The token object with required fields

-> VikunjaRequest TokensPut MimeJSON ModelsAPIToken MimeJSON

PUT /tokens

Create a new api token

Create a new api token to use on behalf of the user creating it.

AuthMethod: AuthApiKeyJWTKeyAuth

data TokensPut

Instances

Produces TokensPut MimeJSON

application/json

Defined in Vikunja.API.Api

Consumes TokensPut MimeJSON

application/json

Defined in Vikunja.API.Api

HasBodyParam TokensPut ModelsAPIToken

Body Param "token" - The token object with required fields

Defined in Vikunja.API.Api

Methods

setBodyParam :: (Consumes TokensPut contentType, MimeRender contentType ModelsAPIToken) => VikunjaRequest TokensPut contentType res accept -> ModelsAPIToken -> VikunjaRequest TokensPut contentType res accept

tokensTokenIDDelete

tokensTokenIDDelete

Arguments

:: TokenId

"tokenId" - Token ID

-> VikunjaRequest TokensTokenIDDelete MimeNoContent ModelsMessage MimeJSON

DELETE /tokens/{tokenID}

Deletes an existing api token

Delete any of the user's api tokens.

AuthMethod: AuthApiKeyJWTKeyAuth

data TokensTokenIDDelete

Instances

Produces TokensTokenIDDelete MimeJSON

application/json

Defined in Vikunja.API.Api