ScalixScalix Docs

Functions API

Serverless function deployment and invocation

REST API endpoints for Functions. 8 operations.

List functions

plaintext
GET /v1/functions

Returns all serverless functions for the caller's project.

Auth: Bearer API key

Responses

StatusDescription
200Function list
401Missing or invalid API key
500Internal error

operationId: listFunctions

Create a function

plaintext
POST /v1/functions

Deploys a serverless function and returns the created function.

Auth: Bearer API key

Request body

application/json (required) — schema FunctionDeployRequest.

Responses

StatusDescription
201Function created
401Missing or invalid API key
500Internal error

operationId: createFunction

Delete a function

plaintext
DELETE /v1/functions/{id}

Removes a serverless function by id or name.

Auth: Bearer API key

Parameters

NameInTypeRequiredDescription
idpathstringYesFunction id or name

Responses

StatusDescription
200Function deleted
401Missing or invalid API key
500Internal error

operationId: deleteFunction

Get a function

plaintext
GET /v1/functions/{id}

Returns a single serverless function by id or name.

Auth: Bearer API key

Parameters

NameInTypeRequiredDescription
idpathstringYesFunction id or name

Responses

StatusDescription
200Function details
401Missing or invalid API key
500Internal error

operationId: getFunction

Update a function

plaintext
PUT /v1/functions/{id}

Redeploys a serverless function with a new configuration.

Auth: Bearer API key

Parameters

NameInTypeRequiredDescription
idpathstringYesFunction id or name

Request body

application/json (required) — schema FunctionDeployRequest.

Responses

StatusDescription
200Function updated
401Missing or invalid API key
500Internal error

operationId: updateFunction

List function invocations

plaintext
GET /v1/functions/{id}/invocations

Returns the invocation history for a serverless function.

Auth: Bearer API key

Parameters

NameInTypeRequiredDescription
idpathstringYesFunction id or name

Responses

StatusDescription
200Invocation history
401Missing or invalid API key
500Internal error

operationId: listFunctionInvocations

Invoke a function

plaintext
POST /v1/functions/{id}/invoke

Invokes a serverless function with the supplied payload and returns its result.

Auth: Bearer API key

Parameters

NameInTypeRequiredDescription
idpathstringYesFunction id or name

Request body

application/json (required) — schema object.

Responses

StatusDescription
200Invocation result
401Missing or invalid API key
500Internal error

operationId: invokeFunction

Get function logs

plaintext
GET /v1/functions/{id}/logs

Returns log output for a serverless function.

Auth: Bearer API key

Parameters

NameInTypeRequiredDescription
idpathstringYesFunction id or name

Responses

StatusDescription
200Function logs
401Missing or invalid API key
500Internal error

operationId: getFunctionLogs