A function defines a procedure on how to change one element into another. The function remains static, while the variables that pass through it can vary.
List all your functions
path Parameters
regionThe region you want to target
query Parameters
namespace_idUUID of the namespace the function belongs to.
pagePage number.
page_sizeNumber of functions per page.
order_byOrder of the functions.
nameName of the function.
organization_idUUID of the Organization the function belongs to.
project_idUUID of the Project the function belongs to.
List all your functions › Responses
Array of functions.
total_countTotal number of functions.
Create a new function
Create a new function in the specified region for a specified Organization or Project.
path Parameters
regionThe region you want to target
Create a new function › Request Body
nameName of the function to create.
namespace_idUUID of the namespace the function will be created in.
Environment variables of the function.
min_scaleMinimum number of instances to scale the function to.
max_scaleMaximum number of instances to scale the function to.
runtimeRuntime to use with the function.
memory_limitMemory limit of the function in MB.
timeoutRequest processing time limit for the function. (in seconds)
handlerHandler to use with the function.
privacyPrivacy setting of the function.
descriptionDescription of the function.
http_optionConfigure how HTTP and HTTPS requests are handled. Possible values:
- redirected: Responds to HTTP request with a 301 redirect to ask the clients to use HTTPS.
- enabled: Serve both HTTP and HTTPS traffic.
sandboxExecution environment of the function.
tagsTags of the Serverless Function.
private_network_idID of the Private Network the function is connected to. When connected to a Private Network, the function can access other Scaleway resources in this Private Network.
Create a new function › Responses
idUUID of the function.
nameName of the function.
namespace_idUUID of the namespace the function belongs to.
statusStatus of the function.
Environment variables of the function.
min_scaleMinimum number of instances to scale the function to.
max_scaleMaximum number of instances to scale the function to.
runtimeRuntime of the function.
memory_limitMemory limit of the function in MB.
cpu_limitCPU limit of the function.
timeoutRequest processing time limit for the function. (in seconds)
handlerHandler to use for the function.
error_messageError message if the function is in "error" state.
build_messageDescription of the current build step.
privacyPrivacy setting of the function.
descriptionDescription of the function.
domain_nameDomain name associated with the function.
Secret environment variables of the function.
regionRegion in which the function is deployed.
http_optionConfiguration for handling of HTTP and HTTPS requests. Possible values:
- redirected: Responds to HTTP request with a 301 redirect to ask the clients to use HTTPS.
- enabled: Serve both HTTP and HTTPS traffic.
runtime_messagesandboxExecution environment of the function.
created_atCreation date of the function. (RFC 3339 format)
updated_atLast update date of the function. (RFC 3339 format)
ready_atLast date when the function was successfully deployed and set to ready. (RFC 3339 format)
tagsList of tags applied to the Serverless Function.
private_network_idID of the Private Network the function is connected to. When connected to a Private Network, the function can access other Scaleway resources in this Private Network.
Get a function
Get the function associated with the specified ID.
path Parameters
regionThe region you want to target
function_idUUID of the function.
Get a function › Responses
idUUID of the function.
nameName of the function.
namespace_idUUID of the namespace the function belongs to.
statusStatus of the function.
Environment variables of the function.
min_scaleMinimum number of instances to scale the function to.
max_scaleMaximum number of instances to scale the function to.
runtimeRuntime of the function.
memory_limitMemory limit of the function in MB.
cpu_limitCPU limit of the function.
timeoutRequest processing time limit for the function. (in seconds)
handlerHandler to use for the function.
error_messageError message if the function is in "error" state.
build_messageDescription of the current build step.
privacyPrivacy setting of the function.
descriptionDescription of the function.
domain_nameDomain name associated with the function.
Secret environment variables of the function.
regionRegion in which the function is deployed.
http_optionConfiguration for handling of HTTP and HTTPS requests. Possible values:
- redirected: Responds to HTTP request with a 301 redirect to ask the clients to use HTTPS.
- enabled: Serve both HTTP and HTTPS traffic.
runtime_messagesandboxExecution environment of the function.
created_atCreation date of the function. (RFC 3339 format)
updated_atLast update date of the function. (RFC 3339 format)
ready_atLast date when the function was successfully deployed and set to ready. (RFC 3339 format)
tagsList of tags applied to the Serverless Function.
private_network_idID of the Private Network the function is connected to. When connected to a Private Network, the function can access other Scaleway resources in this Private Network.
Delete a function
Delete the function associated with the specified ID.
path Parameters
regionThe region you want to target
function_idUUID of the function to delete.
Delete a function › Responses
idUUID of the function.
nameName of the function.
namespace_idUUID of the namespace the function belongs to.
statusStatus of the function.
Environment variables of the function.
min_scaleMinimum number of instances to scale the function to.
max_scaleMaximum number of instances to scale the function to.
runtimeRuntime of the function.
memory_limitMemory limit of the function in MB.
cpu_limitCPU limit of the function.
timeoutRequest processing time limit for the function. (in seconds)
handlerHandler to use for the function.
error_messageError message if the function is in "error" state.
build_messageDescription of the current build step.
privacyPrivacy setting of the function.
descriptionDescription of the function.
domain_nameDomain name associated with the function.
Secret environment variables of the function.
regionRegion in which the function is deployed.
http_optionConfiguration for handling of HTTP and HTTPS requests. Possible values:
- redirected: Responds to HTTP request with a 301 redirect to ask the clients to use HTTPS.
- enabled: Serve both HTTP and HTTPS traffic.
runtime_messagesandboxExecution environment of the function.
created_atCreation date of the function. (RFC 3339 format)
updated_atLast update date of the function. (RFC 3339 format)
ready_atLast date when the function was successfully deployed and set to ready. (RFC 3339 format)
tagsList of tags applied to the Serverless Function.
private_network_idID of the Private Network the function is connected to. When connected to a Private Network, the function can access other Scaleway resources in this Private Network.
Update an existing function
Update the function associated with the specified ID.
When updating a function, the function is automatically redeployed to apply the changes.
This behavior can be changed by setting the redeploy field to false in the request.
path Parameters
regionThe region you want to target
function_idUUID of the function to update.
Update an existing function › Request Body
Environment variables of the function to update.
min_scaleMinimum number of instances to scale the function to.
max_scaleMaximum number of instances to scale the function to.
runtimeRuntime to use with the function.
memory_limitMemory limit of the function in MB.
timeoutProcessing time limit for the function. (in seconds)
redeployRedeploy failed function.
handlerHandler to use with the function.
privacyPrivacy setting of the function.
descriptionDescription of the function.
Secret environment variables of the function. During an update, secret environment variables that are not specified in this field will be kept unchanged.
In order to delete a specific secret environment variable, you must reference its key, but not provide any value for it.
For example, the following payload will delete the TO_DELETE secret environment variable:
Code
http_optionConfigure how HTTP and HTTPS requests are handled. Possible values:
- redirected: Responds to HTTP request with a 301 redirect to ask the clients to use HTTPS.
- enabled: Serve both HTTP and HTTPS traffic.
sandboxExecution environment of the function.
tagsTags of the Serverless Function.
private_network_idID of the Private Network the function is connected to. When connected to a Private Network, the function can access other Scaleway resources in this Private Network.
Update an existing function › Responses
idUUID of the function.
nameName of the function.
namespace_idUUID of the namespace the function belongs to.
statusStatus of the function.
Environment variables of the function.
min_scaleMinimum number of instances to scale the function to.
max_scaleMaximum number of instances to scale the function to.
runtimeRuntime of the function.
memory_limitMemory limit of the function in MB.
cpu_limitCPU limit of the function.
timeoutRequest processing time limit for the function. (in seconds)
handlerHandler to use for the function.
error_messageError message if the function is in "error" state.
build_messageDescription of the current build step.
privacyPrivacy setting of the function.
descriptionDescription of the function.
domain_nameDomain name associated with the function.
Secret environment variables of the function.
regionRegion in which the function is deployed.
http_optionConfiguration for handling of HTTP and HTTPS requests. Possible values:
- redirected: Responds to HTTP request with a 301 redirect to ask the clients to use HTTPS.
- enabled: Serve both HTTP and HTTPS traffic.
runtime_messagesandboxExecution environment of the function.
created_atCreation date of the function. (RFC 3339 format)
updated_atLast update date of the function. (RFC 3339 format)
ready_atLast date when the function was successfully deployed and set to ready. (RFC 3339 format)
tagsList of tags applied to the Serverless Function.
private_network_idID of the Private Network the function is connected to. When connected to a Private Network, the function can access other Scaleway resources in this Private Network.
Deploy a function
Deploy a function associated with the specified ID.
path Parameters
regionThe region you want to target
function_idUUID of the function to deploy.
Deploy a function › Responses
idUUID of the function.
nameName of the function.
namespace_idUUID of the namespace the function belongs to.
statusStatus of the function.
Environment variables of the function.
min_scaleMinimum number of instances to scale the function to.
max_scaleMaximum number of instances to scale the function to.
runtimeRuntime of the function.
memory_limitMemory limit of the function in MB.
cpu_limitCPU limit of the function.
timeoutRequest processing time limit for the function. (in seconds)
handlerHandler to use for the function.
error_messageError message if the function is in "error" state.
build_messageDescription of the current build step.
privacyPrivacy setting of the function.
descriptionDescription of the function.
domain_nameDomain name associated with the function.
Secret environment variables of the function.
regionRegion in which the function is deployed.
http_optionConfiguration for handling of HTTP and HTTPS requests. Possible values:
- redirected: Responds to HTTP request with a 301 redirect to ask the clients to use HTTPS.
- enabled: Serve both HTTP and HTTPS traffic.
runtime_messagesandboxExecution environment of the function.
created_atCreation date of the function. (RFC 3339 format)
updated_atLast update date of the function. (RFC 3339 format)
ready_atLast date when the function was successfully deployed and set to ready. (RFC 3339 format)
tagsList of tags applied to the Serverless Function.
private_network_idID of the Private Network the function is connected to. When connected to a Private Network, the function can access other Scaleway resources in this Private Network.
Get a download URL of a function
Get a download URL for a function associated with the specified ID.
path Parameters
regionThe region you want to target
function_idUUID of the function to get the download URL for.
Get a download URL of a function › Responses
urlGet an upload URL of a function
Get an upload URL of a function associated with the specified ID.
path Parameters
regionThe region you want to target
function_idUUID of the function to get the upload URL for.
query Parameters
content_lengthSize of the archive to upload in bytes.
Get an upload URL of a function › Responses
urlUpload URL to upload the function to.
HTTP headers.