Namespaces

A namespace is a logical concept that allows you to group your containers.

Containers in the same namespace can share environment variables, defined only once, at the namespace level.

List all namespaces the caller can access (read permission).

GET

https://api.scaleway.com

/containers/v1/regions/{region}/namespaces

By default, the namespaces listed are ordered by creation date in ascending order. This can be modified via the order_by field.

Additional parameters can be set in the query to filter, such as organization_id, project_id, and name.

List all namespaces the caller can access (read permission). › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

List all namespaces the caller can access (read permission). › query Parameters

page

integer · int32

page_size

integer · uint32

order_by

scaleway.containers.v1.ListNamespacesRequest.OrderBy · enum

Enum values:

created_at_asc

created_at_desc

name_asc

name_desc

Default: created_at_asc

organization_id

string

project_id

string

name

string

List all namespaces the caller can access (read permission). › Responses

200

scaleway.containers.v1.ListNamespacesResponse

scaleway.containers.v1.Namespace[]

total_count

integer · uint64

GET/containers/v1/regions/{region}/namespaces

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

Example Responses

{
  "namespaces": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "name": "name",
      "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
      "project_id": "6170692e-7363-616c-6577-61792e636f6d",
      "description": "description",
      "status": "unknown_status",
      "error_message": "error_message",
      "environment_variables": {
        "<environment_variableKey>": "<environment_variableKey>"
      },
      "secret_environment_variables": {
        "<secret_environment_variableKey>": "<secret_environment_variableKey>"
      },
      "tags": [
        "string"
      ],
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "region": "region"
    }
  ],
  "total_count": 0
}

json

application/json

Create a new namespace.

POST

https://api.scaleway.com

/containers/v1/regions/{region}/namespaces

Namespace name must be unique inside a project.

Create a new namespace. › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

Create a new namespace. › Request Body

project_id

string · required

Unique ID of the Project the namespace belongs to.

name

string · required

Namespace name.

description

string

Namespace description.

object

Namespace environment variables.

object

Namespace secret environment variables.

tags

string[]

A list of arbitrary tags associated with the namespace.

Create a new namespace. › Responses

200

scaleway.containers.v1.Namespace

id

string

Namespace unique ID. (UUID format)

name

string

Namespace name.

organization_id

string

Unique ID of the Organization the namespace belongs to. (UUID format)

project_id

string

Unique ID of the Project the namespace belongs to. (UUID format)

description

string

Namespace description.

status

string · enum

Namespace status.

Enum values:

unknown_status

updating

deleting

locking

ready

error

locked

creating

Default: unknown_status

error_message

string

Namespace last error message.

object

Namespace environment variables.

object

Namespace secret environment variables.

tags

string[]

A list of arbitrary tags associated with the namespace.

created_at

string · date-time

Namespace creation date. (RFC 3339 format)

updated_at

string · date-time

Namespace last update date. (RFC 3339 format)

region

string

Region in which the namespace will be created.

POST/containers/v1/regions/{region}/namespaces

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "environment_variables": {
        "<environment_variableKey>": "string"
    },
    "name": "string",
    "project_id": "string",
    "secret_environment_variables": {
        "<secret_environment_variableKey>": "string"
    }
  }' \
  "https://api.scaleway.com/containers/v1/regions/{region}/namespaces"

Example Request Body

{
  "project_id": "project_id",
  "name": "name",
  "description": "description",
  "environment_variables": {
    "<environment_variableKey>": "<environment_variableKey>"
  },
  "secret_environment_variables": {
    "<secret_environment_variableKey>": "<secret_environment_variableKey>"
  },
  "tags": [
    "string"
  ]
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "description": "description",
  "status": "unknown_status",
  "error_message": "error_message",
  "environment_variables": {
    "<environment_variableKey>": "<environment_variableKey>"
  },
  "secret_environment_variables": {
    "<secret_environment_variableKey>": "<secret_environment_variableKey>"
  },
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "region": "region"
}

json

application/json

Get the namespace associated with the specified ID.

GET

https://api.scaleway.com

/containers/v1/regions/{region}/namespaces/{namespace_id}

Get the namespace associated with the specified ID. › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

namespace_id

string · required

Get the namespace associated with the specified ID. › Responses

200

scaleway.containers.v1.Namespace

id

string

Namespace unique ID. (UUID format)

name

string

Namespace name.

organization_id

string

Unique ID of the Organization the namespace belongs to. (UUID format)

project_id

string

Unique ID of the Project the namespace belongs to. (UUID format)

description

string

Namespace description.

status

string · enum

Namespace status.

Enum values:

unknown_status

updating

deleting

locking

ready

error

locked

creating

Default: unknown_status

error_message

string

Namespace last error message.

object

Namespace environment variables.

object

Namespace secret environment variables.

tags

string[]

A list of arbitrary tags associated with the namespace.

created_at

string · date-time

Namespace creation date. (RFC 3339 format)

updated_at

string · date-time

Namespace last update date. (RFC 3339 format)

region

string

Region in which the namespace will be created.

GET/containers/v1/regions/{region}/namespaces/{namespace_id}

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

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "description": "description",
  "status": "unknown_status",
  "error_message": "error_message",
  "environment_variables": {
    "<environment_variableKey>": "<environment_variableKey>"
  },
  "secret_environment_variables": {
    "<secret_environment_variableKey>": "<secret_environment_variableKey>"
  },
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "region": "region"
}

json

application/json

Delete the namespace associated with the specified ID.

DELETE

https://api.scaleway.com

/containers/v1/regions/{region}/namespaces/{namespace_id}

It also deletes in cascade any resource inside the namespace.

This action cannot be undone.

Delete the namespace associated with the specified ID. › 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 to delete.

Delete the namespace associated with the specified ID. › Responses

200

scaleway.containers.v1.Namespace

id

string

Namespace unique ID. (UUID format)

name

string

Namespace name.

organization_id

string

Unique ID of the Organization the namespace belongs to. (UUID format)

project_id

string

Unique ID of the Project the namespace belongs to. (UUID format)

description

string

Namespace description.

status

string · enum

Namespace status.

Enum values:

unknown_status

updating

deleting

locking

ready

error

locked

creating

Default: unknown_status

error_message

string

Namespace last error message.

object

Namespace environment variables.

object

Namespace secret environment variables.

tags

string[]

A list of arbitrary tags associated with the namespace.

created_at

string · date-time

Namespace creation date. (RFC 3339 format)

updated_at

string · date-time

Namespace last update date. (RFC 3339 format)

region

string

Region in which the namespace will be created.

DELETE/containers/v1/regions/{region}/namespaces/{namespace_id}

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/containers/v1/regions/{region}/namespaces/{namespace_id}"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "description": "description",
  "status": "unknown_status",
  "error_message": "error_message",
  "environment_variables": {
    "<environment_variableKey>": "<environment_variableKey>"
  },
  "secret_environment_variables": {
    "<secret_environment_variableKey>": "<secret_environment_variableKey>"
  },
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "region": "region"
}

json

application/json

Update the namespace associated with the specified ID.

PATCH

https://api.scaleway.com

/containers/v1/regions/{region}/namespaces/{namespace_id}

Only fields present in the request are updated; others are left untouched.

Update the namespace associated with the specified ID. › 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 to update.

Update the namespace associated with the specified ID. › Request Body

description

string

Namespace description.

object

Namespace environment variables.

object

Namespace secret environment variables.

tags

string[]

A list of arbitrary tags associated with the namespace.

Update the namespace associated with the specified ID. › Responses

200

scaleway.containers.v1.Namespace

id

string

Namespace unique ID. (UUID format)

name

string

Namespace name.

organization_id

string

Unique ID of the Organization the namespace belongs to. (UUID format)

project_id

string

Unique ID of the Project the namespace belongs to. (UUID format)

description

string

Namespace description.

status

string · enum

Namespace status.

Enum values:

unknown_status

updating

deleting

locking

ready

error

locked

creating

Default: unknown_status

error_message

string

Namespace last error message.

object

Namespace environment variables.

object

Namespace secret environment variables.

tags

string[]

A list of arbitrary tags associated with the namespace.

created_at

string · date-time

Namespace creation date. (RFC 3339 format)

updated_at

string · date-time

Namespace last update date. (RFC 3339 format)

region

string

Region in which the namespace will be created.

PATCH/containers/v1/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/containers/v1/regions/{region}/namespaces/{namespace_id}"

Example Request Body

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

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "description": "description",
  "status": "unknown_status",
  "error_message": "error_message",
  "environment_variables": {
    "<environment_variableKey>": "<environment_variableKey>"
  },
  "secret_environment_variables": {
    "<secret_environment_variableKey>": "<secret_environment_variableKey>"
  },
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "region": "region"
}

json

application/json

Containers

List all namespaces the caller can access (read permission).

GET

https://api.scaleway.com

/containers/v1/regions/{region}/namespaces

By default, the namespaces listed are ordered by creation date in ascending order. This can be modified via the order_by field.

Additional parameters can be set in the query to filter, such as organization_id, project_id, and name.

List all namespaces the caller can access (read permission). › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

List all namespaces the caller can access (read permission). › query Parameters

page

integer · int32

page_size

integer · uint32

order_by

scaleway.containers.v1.ListNamespacesRequest.OrderBy · enum

Enum values:

created_at_asc

created_at_desc

name_asc

name_desc

Default: created_at_asc

organization_id

string

project_id

string

name

string

List all namespaces the caller can access (read permission). › Responses

200

scaleway.containers.v1.ListNamespacesResponse

scaleway.containers.v1.Namespace[]

total_count

integer · uint64

Create a new namespace.

POST

https://api.scaleway.com

/containers/v1/regions/{region}/namespaces

Namespace name must be unique inside a project.

Create a new namespace. › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

Create a new namespace. › Request Body

project_id

string · required

Unique ID of the Project the namespace belongs to.

name

string · required

Namespace name.

description

string

Namespace description.

object

Namespace environment variables.

object

Namespace secret environment variables.

tags

string[]

A list of arbitrary tags associated with the namespace.

Create a new namespace. › Responses

200

scaleway.containers.v1.Namespace

id

string

Namespace unique ID. (UUID format)

name

string

Namespace name.

organization_id

string

Unique ID of the Organization the namespace belongs to. (UUID format)

project_id

string

Unique ID of the Project the namespace belongs to. (UUID format)

description

string

Namespace description.

status

string · enum

Namespace status.

Enum values:

unknown_status

updating

deleting

locking

ready

error

locked

creating

Default: unknown_status

error_message

string

Namespace last error message.

object

Namespace environment variables.

object

Namespace secret environment variables.

tags

string[]

A list of arbitrary tags associated with the namespace.

created_at

string · date-time

Namespace creation date. (RFC 3339 format)

updated_at

string · date-time

Namespace last update date. (RFC 3339 format)

region

string

Region in which the namespace will be created.

Get the namespace associated with the specified ID.

GET

https://api.scaleway.com

/containers/v1/regions/{region}/namespaces/{namespace_id}

Get the namespace associated with the specified ID. › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

namespace_id

string · required

Get the namespace associated with the specified ID. › Responses

200

scaleway.containers.v1.Namespace

id

string

Namespace unique ID. (UUID format)

name

string

Namespace name.

organization_id

string

Unique ID of the Organization the namespace belongs to. (UUID format)

project_id

string

Unique ID of the Project the namespace belongs to. (UUID format)

description

string

Namespace description.

status

string · enum

Namespace status.

Enum values:

unknown_status

updating

deleting

locking

ready

error

locked

creating

Default: unknown_status

error_message

string

Namespace last error message.

object

Namespace environment variables.

object

Namespace secret environment variables.

tags

string[]

A list of arbitrary tags associated with the namespace.

created_at

string · date-time

Namespace creation date. (RFC 3339 format)

updated_at

string · date-time

Namespace last update date. (RFC 3339 format)

region

string

Region in which the namespace will be created.

Delete the namespace associated with the specified ID.

DELETE

https://api.scaleway.com

/containers/v1/regions/{region}/namespaces/{namespace_id}

It also deletes in cascade any resource inside the namespace.

This action cannot be undone.

Delete the namespace associated with the specified ID. › 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 to delete.

Delete the namespace associated with the specified ID. › Responses

200

scaleway.containers.v1.Namespace

id

string

Namespace unique ID. (UUID format)

name

string

Namespace name.

organization_id

string

Unique ID of the Organization the namespace belongs to. (UUID format)

project_id

string

Unique ID of the Project the namespace belongs to. (UUID format)

description

string

Namespace description.

status

string · enum

Namespace status.

Enum values:

unknown_status

updating

deleting

locking

ready

error

locked

creating

Default: unknown_status

error_message

string

Namespace last error message.

object

Namespace environment variables.

object

Namespace secret environment variables.

tags

string[]

A list of arbitrary tags associated with the namespace.

created_at

string · date-time

Namespace creation date. (RFC 3339 format)

updated_at

string · date-time

Namespace last update date. (RFC 3339 format)

region

string

Region in which the namespace will be created.

Update the namespace associated with the specified ID.

PATCH

https://api.scaleway.com

/containers/v1/regions/{region}/namespaces/{namespace_id}

Only fields present in the request are updated; others are left untouched.

Update the namespace associated with the specified ID. › 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 to update.

Update the namespace associated with the specified ID. › Request Body

description

string

Namespace description.

object

Namespace environment variables.

object

Namespace secret environment variables.

tags

string[]

A list of arbitrary tags associated with the namespace.

Update the namespace associated with the specified ID. › Responses

200

scaleway.containers.v1.Namespace

id

string

Namespace unique ID. (UUID format)

name

string

Namespace name.

organization_id

string

Unique ID of the Organization the namespace belongs to. (UUID format)

project_id

string

Unique ID of the Project the namespace belongs to. (UUID format)

description

string

Namespace description.

status

string · enum

Namespace status.

Enum values:

unknown_status

updating

deleting

locking

ready

error

locked

creating

Default: unknown_status

error_message

string

Namespace last error message.

object

Namespace environment variables.

object

Namespace secret environment variables.

tags

string[]

A list of arbitrary tags associated with the namespace.

created_at

string · date-time

Namespace creation date. (RFC 3339 format)

updated_at

string · date-time

Namespace last update date. (RFC 3339 format)

region

string

Region in which the namespace will be created.