Namespaces

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

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.

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)

POST/functions/v1beta1/regions/{region}/namespaces

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "activate_vpc_integration": false,
    "name": "string",
    "project_id": "string"
  }' \
  "https://api.scaleway.com/functions/v1beta1/regions/{region}/namespaces"

Example Request Body

{
  "name": "name",
  "environment_variables": {
    "<key>": "<key>"
  },
  "project_id": "project_id",
  "description": "description",
  "secret_environment_variables": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "tags": [
    "string"
  ],
  "activate_vpc_integration": true
}

json

Example Responses

{
  "id": "id",
  "srn": "srn",
  "name": "name",
  "environment_variables": {
    "<environment_variableKey>": "<environment_variableKey>"
  },
  "organization_id": "organization_id",
  "project_id": "project_id",
  "status": "unknown",
  "registry_namespace_id": "registry_namespace_id",
  "error_message": "error_message",
  "registry_endpoint": "registry_endpoint",
  "description": "description",
  "secret_environment_variables": [
    {
      "key": "key",
      "hashed_value": "hashed_value"
    }
  ],
  "region": "region",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "vpc_integration_activated": true
}

json

application/json

Get a namespace

GET

https://api.scaleway.com

/functions/v1beta1/regions/{region}/namespaces/{namespace_id}

Get the namespace associated with the specified ID.

Get a namespace › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

namespace_id

string · required

UUID of the namespace.

Get a namespace › Responses

200

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

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.Secret[]

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)

GET/functions/v1beta1/regions/{region}/namespaces/{namespace_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/functions/v1beta1/regions/{region}/namespaces/{namespace_id}"

Example Responses

{
  "id": "id",
  "srn": "srn",
  "name": "name",
  "environment_variables": {
    "<environment_variableKey>": "<environment_variableKey>"
  },
  "organization_id": "organization_id",
  "project_id": "project_id",
  "status": "unknown",
  "registry_namespace_id": "registry_namespace_id",
  "error_message": "error_message",
  "registry_endpoint": "registry_endpoint",
  "description": "description",
  "secret_environment_variables": [
    {
      "key": "key",
      "hashed_value": "hashed_value"
    }
  ],
  "region": "region",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "vpc_integration_activated": true
}

json

application/json

Update an existing namespace

PATCH

https://api.scaleway.com

/functions/v1beta1/regions/{region}/namespaces/{namespace_id}

Update the namespace associated with the specified ID.

Update an existing namespace › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

namespace_id

string · required

UUID of the namespapce.

Update an existing namespace › Request Body

environment_variables

object | null

Environment variables of the namespace.

description

string | null

Description of the namespace.

Secret environment variables of the namespace.

tags

array | null

Tags of the Serverless Function Namespace.

Update an existing namespace › Responses

200

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

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.

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)

PATCH/functions/v1beta1/regions/{region}/namespaces/{namespace_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/functions/v1beta1/regions/{region}/namespaces/{namespace_id}"

Example Request Body

{
  "environment_variables": {
    "<key>": "<key>"
  },
  "description": "description",
  "secret_environment_variables": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "tags": []
}

json

Example Responses

{
  "id": "id",
  "srn": "srn",
  "name": "name",
  "environment_variables": {
    "<environment_variableKey>": "<environment_variableKey>"
  },
  "organization_id": "organization_id",
  "project_id": "project_id",
  "status": "unknown",
  "registry_namespace_id": "registry_namespace_id",
  "error_message": "error_message",
  "registry_endpoint": "registry_endpoint",
  "description": "description",
  "secret_environment_variables": [
    {
      "key": "key",
      "hashed_value": "hashed_value"
    }
  ],
  "region": "region",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "vpc_integration_activated": true
}

json

application/json

Delete an existing namespace

DELETE

https://api.scaleway.com

/functions/v1beta1/regions/{region}/namespaces/{namespace_id}

Delete the namespace associated with the specified ID.

Delete an existing namespace › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

namespace_id

string · required

UUID of the namespace.

Delete an existing namespace › Responses

200

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

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.