Scaleway logo
Serverless Functions API
Serverless Functions API

Schemas

Download schema

google.protobuf.StringValue

string | null

scaleway.functions.v1beta1.CreateTriggerRequest.MnqNatsClientConfig

subject
​string · pattern: ^[^\s]+$ · required

Name of the NATS subject the trigger should listen to.

mnq_nats_account_id
​string · required

ID of the Messaging and Queuing NATS account.

mnq_region
​string · required

Region in which the Messaging and Queuing project is activated. Currently, only the fr-par and nl-ams regions are available.

mnq_project_id
​string

ID of the Messaging and Queuing project.

scaleway.functions.v1beta1.CreateTriggerRequest.MnqSqsClientConfig

queue
​string · required

Name of the SQS queue the trigger should listen to.

mnq_project_id
​string · required

ID of the Messaging and Queuing project. You must have activated SQS on this project.

mnq_region
​string · required

Region in which the Messaging and Queuing project is activated. Currently, only the fr-par and nl-ams regions are available.

scaleway.functions.v1beta1.Cron

id
​string

UUID of the cron.

srn
​string · pattern: ^srn://functions\.[^…

SRN of the cron.

function_id
​string

UUID of the function the cron applies to.

schedule
​string

Schedule of the cron.

​object

Arguments to pass with the cron.

status
​scaleway.functions.v1beta1.Cron.Status · enum

Status of the cron.

Enum values:
unknown
ready
deleting
error
locked
creating
pending
Default: unknown
name
​string

Name of the cron.

region
​string

Region in which the cron is located.

scaleway.functions.v1beta1.Cron.Status

string · enum
Enum values:
unknown
ready
deleting
error
locked
creating
pending
Default: unknown

scaleway.functions.v1beta1.Domain

id
​string

UUID of the domain.

srn
​string · pattern: ^srn://functions\.[^…

SRN of the domain.

hostname
​string

Hostname associated with the function.

function_id
​string

UUID of the function the domain is associated with.

url
​string

URL of the function.

status
​scaleway.functions.v1beta1.Domain.Status · enum

State of the domain.

Enum values:
unknown
ready
deleting
error
creating
pending
Default: unknown
error_message
​string | null

Error message if the domain is in "error" state.

region
​string

Region in which the domain is located.

scaleway.functions.v1beta1.Domain.Status

string · enum
Enum values:
unknown
ready
deleting
error
creating
pending
Default: unknown

scaleway.functions.v1beta1.DownloadURL

url
​string
​object

scaleway.functions.v1beta1.Function

id
​string

UUID of the function.

srn
​string · pattern: ^srn://functions\.[^…

SRN of the function.

name
​string

Name of the function.

namespace_id
​string

UUID of the namespace the function belongs to.

status
​scaleway.functions.v1beta1.Function.Status · enum

Status of the function.

Enum values:
unknown
ready
deleting
error
locked
creating
pending
created
Default: unknown
​object

Environment variables of the function.

min_scale
​integer · uint32

Minimum number of instances to scale the function to.

max_scale
​integer · uint32

Maximum number of instances to scale the function to.

runtime
​scaleway.functions.v1beta1.Function.Runtime · enum

Runtime of the function.

Enum values:
unknown_runtime
golang
python
python3
node8
node10
node14
node16
Default: unknown_runtime
memory_limit
​integer · uint32

Memory limit of the function in MB.

cpu_limit
​integer · uint32

CPU limit of the function.

timeout
​string | null

Request processing time limit for the function. (in seconds)

handler
​string

Handler to use for the function.

error_message
​string | null

Error message if the function is in "error" state.

build_message
​string | null

Description of the current build step.

privacy
​scaleway.functions.v1beta1.Function.Privacy · enum

Privacy setting of the function.

Enum values:
unknown_privacy
public
private
Default: unknown_privacy
description
​string | null

Description of the function.

domain_name
​string

Domain name associated with the function.

​scaleway.functions.v1beta1.SecretHashedValue[]

Secret environment variables of the function.

region
​string

Region in which the function is deployed.

http_option
​scaleway.functions.v1beta1.Function.HttpOption · enum

Configuration 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.
Enum values:
unknown_http_option
enabled
redirected
Default: enabled
runtime_message
​string
sandbox
​scaleway.functions.v1beta1.Function.Sandbox · enum

Execution environment of the function.

Enum values:
unknown_sandbox
v1
v2
Default: unknown_sandbox
created_at
​string | null · date-time

Creation date of the function. (RFC 3339 format)

updated_at
​string | null · date-time

Last update date of the function. (RFC 3339 format)

ready_at
​string | null · date-time

Last date when the function was successfully deployed and set to ready. (RFC 3339 format)

tags
​string[]

List of tags applied to the Serverless Function.

private_network_id
​string | null

ID 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.

scaleway.functions.v1beta1.Function.HttpOption

string · enum
Enum values:
unknown_http_option
enabled
redirected
Default: unknown_http_option

scaleway.functions.v1beta1.Function.Privacy

string · enum
Enum values:
unknown_privacy
public
private
Default: unknown_privacy

scaleway.functions.v1beta1.Function.Runtime

string · enum
Enum values:
unknown_runtime
golang
python
python3
node8
node10
node14
node16
Default: unknown_runtime

scaleway.functions.v1beta1.Function.Sandbox

string · enum
Enum values:
unknown_sandbox
v1
v2
Default: unknown_sandbox

scaleway.functions.v1beta1.Function.Status

string · enum
Enum values:
unknown
ready
deleting
error
locked
creating
pending
created
Default: unknown

scaleway.functions.v1beta1.ListCronsRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
Default: created_at_asc

scaleway.functions.v1beta1.ListCronsResponse

Array of crons.

total_count
​integer · uint32

Total number of crons.

scaleway.functions.v1beta1.ListDomainsRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
hostname_asc
hostname_desc
Default: created_at_asc

scaleway.functions.v1beta1.ListDomainsResponse

Array of domains.

total_count
​integer · uint32

Total number of domains.

scaleway.functions.v1beta1.ListFunctionRuntimesResponse

Array of runtimes available.

total_count
​integer · uint32

Total number of runtimes.

scaleway.functions.v1beta1.ListFunctionsRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
name_asc
name_desc
Default: created_at_asc

scaleway.functions.v1beta1.ListFunctionsResponse

Array of functions.

total_count
​integer · uint32

Total number of functions.

scaleway.functions.v1beta1.ListNamespacesRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
name_asc
name_desc
Default: created_at_asc

scaleway.functions.v1beta1.ListNamespacesResponse

total_count
​integer · uint32

Total number of namespaces.

scaleway.functions.v1beta1.ListTokensRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
Default: created_at_asc

scaleway.functions.v1beta1.ListTokensResponse

total_count
​integer · uint32

scaleway.functions.v1beta1.ListTriggersRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
Default: created_at_asc

scaleway.functions.v1beta1.ListTriggersResponse

total_count
​integer · uint32

Total count of existing triggers (matching any filters specified).

Triggers on this page.

scaleway.functions.v1beta1.Namespace

id
​string

UUID of the namespace.

srn
​string · pattern: ^srn://functions\.[^…

SRN of the namespace.

name
​string

Name of the namespace.

​object

Environment variables of the namespace.

organization_id
​string

UUID of the Organization the namespace belongs to.

project_id
​string

UUID of the Project the namespace belongs to.

status
​scaleway.functions.v1beta1.Namespace.Status · enum

Status of the namespace.

Enum values:
unknown
ready
deleting
error
locked
creating
pending
Default: unknown
registry_namespace_id
​string

UUID of the registry namespace.

error_message
​string | null

Error message if the namespace is in "error" state.

registry_endpoint
​string

Registry endpoint of the namespace.

description
​string | null

Description of the namespace.

​scaleway.functions.v1beta1.SecretHashedValue[]

Secret environment variables of the namespace.

region
​string

Region in which the namespace is located.

tags
​string[]

List of tags applied to the Serverless Function Namespace.

created_at
​string | null · date-time

Creation date of the namespace. (RFC 3339 format)

updated_at
​string | null · date-time

Last update date of the namespace. (RFC 3339 format)

scaleway.functions.v1beta1.Namespace.Status

string · enum
Enum values:
unknown
ready
deleting
error
locked
creating
pending
Default: unknown

scaleway.functions.v1beta1.Runtime

name
​string
language
​string
version
​string
default_handler
​string
code_sample
​string
status
​scaleway.functions.v1beta1.Runtime.Status · enum
Enum values:
unknown_status
beta
available
deprecated
end_of_support
end_of_life
Default: unknown_status
status_message
​string
extension
​string
implementation
​string
logo_url
​string

scaleway.functions.v1beta1.Runtime.Status

string · enum
Enum values:
unknown_status
beta
available
deprecated
end_of_support
end_of_life
Default: unknown_status

scaleway.functions.v1beta1.Secret

key
​string

scaleway.functions.v1beta1.SecretHashedValue

key
​string
hashed_value
​string

scaleway.functions.v1beta1.Token

id
​string

UUID of the token.

token
​string

String of the token.

function_id
​string | null

UUID of the function the token is associated with.

namespace_id
​string | null

UUID of the namespace the token is associated with.

status
​scaleway.functions.v1beta1.Token.Status · enum

Status of the token.

Enum values:
unknown
ready
deleting
error
creating
Default: unknown
description
​string | null

Description of the token.

expires_at
​string | null · date-time

Date on which the token expires. (RFC 3339 format)

scaleway.functions.v1beta1.Token.Status

string · enum
Enum values:
unknown
ready
deleting
error
creating
Default: unknown

scaleway.functions.v1beta1.Trigger

id
​string

ID of the trigger.

srn
​string · pattern: ^srn://functions\.[^…

SRN of the trigger.

name
​string

Name of the trigger.

description
​string

Description of the trigger.

function_id
​string

ID of the function to trigger.

input_type
​scaleway.functions.v1beta1.Trigger.InputType · enum

Type of the input.

Enum values:
unknown_input_type
sqs
scw_sqs
nats
scw_nats
Default: unknown_input_type
status
​scaleway.functions.v1beta1.Trigger.Status · enum

Status of the trigger.

Enum values:
unknown_status
ready
deleting
error
creating
pending
Default: unknown_status
error_message
​string | null

Error message of the trigger.

​

Configuration for a Scaleway Messaging and Queuing SQS queue.

​

Configuration for a Scaleway Messaging and Queuing NATS subject.

region
​string

Region in which the trigger is located.

scaleway.functions.v1beta1.Trigger.InputType

string · enum
Enum values:
unknown_input_type
sqs
scw_sqs
nats
scw_nats
Default: unknown_input_type

scaleway.functions.v1beta1.Trigger.MnqNatsClientConfig

subject
​string

Name of the NATS subject the trigger listens to.

mnq_nats_account_id
​string

ID of the Messaging and Queuing NATS account.

mnq_project_id
​string

ID of the Messaging and Queuing project.

mnq_region
​string

Region in which the Messaging and Queuing project is activated. Currently, only the fr-par and nl-ams regions are available.

mnq_credential_id
​string | null

ID of the Messaging and Queuing credentials used to subscribe to the NATS subject.

scaleway.functions.v1beta1.Trigger.MnqSqsClientConfig

queue
​string

Name of the SQS queue the trigger listens to.

mnq_project_id
​string

ID of the Messaging and Queuing project.

mnq_region
​string

Region in which the Messaging and Queuing project is activated. Currently, only the fr-par and nl-ams regions are available.

mnq_credential_id
​string | null

ID of the Messaging and Queuing credentials used to read from the SQS queue.

scaleway.functions.v1beta1.Trigger.Status

string · enum
Enum values:
unknown_status
ready
deleting
error
creating
pending
Default: unknown_status

scaleway.functions.v1beta1.UploadURL

url
​string

Upload URL to upload the function to.

​object

HTTP headers.

scaleway.std.StringsValue