List namespaces

curl --request GET \
  --url https://api.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id} \
  --header 'Authorization: <api-key>'

{
  "count": 1,
  "results": [
    {
      "created_at": "<string>",
      "functions": [
        {
          "autoscaling": {
            "max_instances": 25,
            "min_instances": 25
          },
          "build_message": "<string>",
          "build_status": "<string>",
          "code_text": "<string>",
          "created_at": "<string>",
          "dependencies": "<string>",
          "deploy_status": {},
          "description": "<string>",
          "endpoint": "<string>",
          "flavor": "<string>",
          "id": "<string>",
          "main_method": "<string>",
          "name": "<string>",
          "runtime": "<string>",
          "status": "<string>",
          "timeout": 90,
          "enable_api_key": true,
          "envs": {
            "ENV_VAR": "value"
          }
        }
      ],
      "functions_deploy_status": {},
      "name": "<string>",
      "status": "<string>",
      "description": "This is a sample namespace.",
      "envs": {
        "ENV_VAR": "value"
      }
    }
  ]
}

GET

cloud

faas

namespaces

{project_id}

{region_id}

List namespaces

curl --request GET \
  --url https://api.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id} \
  --header 'Authorization: <api-key>'

{
  "count": 1,
  "results": [
    {
      "created_at": "<string>",
      "functions": [
        {
          "autoscaling": {
            "max_instances": 25,
            "min_instances": 25
          },
          "build_message": "<string>",
          "build_status": "<string>",
          "code_text": "<string>",
          "created_at": "<string>",
          "dependencies": "<string>",
          "deploy_status": {},
          "description": "<string>",
          "endpoint": "<string>",
          "flavor": "<string>",
          "id": "<string>",
          "main_method": "<string>",
          "name": "<string>",
          "runtime": "<string>",
          "status": "<string>",
          "timeout": 90,
          "enable_api_key": true,
          "envs": {
            "ENV_VAR": "value"
          }
        }
      ],
      "functions_deploy_status": {},
      "name": "<string>",
      "status": "<string>",
      "description": "This is a sample namespace.",
      "envs": {
        "ENV_VAR": "value"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

project_id

integer

required

Project ID

region_id

integer

required

Region ID

Query Parameters

limit

integer

default:1000

Optional. Limit the number of returned items

Required range: x <= 1000

offset

integer

default:0

Optional. Offset value is used to exclude the first set of records from the result

Required range: x >= 0

order_by

enum<string>

default:created_at.desc

Ordering fields and directions.

Available options:

created_at.asc,

created_at.desc,

name.asc,

name.desc

string

Search through which value

Response

200 - application/json

count

integer

required

Number of objects

Required range: x >= 0

results

NamespaceSerializer · object[]

required

Objects

Show child attributes

results.created_at

string

required

Namespace creation date.

results.functions

FunctionSerializer · object[]

required

Namespace functions.

Show child attributes

results.functions.autoscaling

FaasAutoscalingSerializer · object

required

Autoscaling configuration for the function. Keys must be 'min_instances' or 'max_instances', and values must be integers between 0 and 50.

Show child attributes

results.functions.autoscaling.max_instances

integer

required

The maximum number of instances to run.

Required range: 1 <= x <= 50

results.functions.autoscaling.min_instances

integer

required

The minimum number of instances to run.

Required range: 0 <= x <= 50

results.functions.build_message

string

required

Function build message.

results.functions.build_status

string

required

Function build status.

results.functions.code_text

string

required

Function code text.

Required string length: 1 - 100000

results.functions.created_at

string

required

Function creation date.

results.functions.dependencies

string

required

Dependencies for the function to install.

Maximum string length: 100000

results.functions.deploy_status

Deploy Status · object

required

Function deploy status.

Show child attributes

results.functions.deploy_status.{key}

integer

results.functions.description

string

required

Description of the function.

Maximum string length: 255

results.functions.endpoint

string

required

Function endpoint.

results.functions.flavor

string

required

The name of the flavor associated with the function.

results.functions.id

string

required

Function ID.

results.functions.main_method

string

required

The main startup method name.

Required string length: 1 - 100

results.functions.name

string

required

Function name.

results.functions.runtime

string

required

Function runtime.

results.functions.status

string

required

Function status.

results.functions.timeout

integer

required

Function timeout in seconds.

Required range: 0 <= x <= 180

results.functions.enable_api_key

boolean | null

Enable or disable API key authentication.

Example:

true

results.functions.envs

Envs · object

Environment variables for the function. Keys must match a specific regex pattern and be 1-255 characters long, and values must be 0-255 characters long.

Example:

{ "ENV_VAR": "value" }

results.functions_deploy_status

Functions Deploy Status · object

required

Deploy status of namespace functions.

Show child attributes

results.functions_deploy_status.{key}

integer

results.name

string

required

Namespace name.

results.status

string

required

Namespace status.

results.description

string | null

Namespace description.

Maximum string length: 255

Example:

"This is a sample namespace."

results.envs

Envs · object

Namespace environment variables. Keys must match a specific regex pattern and be 1-255 characters long, and values must be 0-255 characters long.

Example:

{ "ENV_VAR": "value" }

Update API key Create namespace

⌘I

Overview

IAM

CDN

Managed DNS

Cloud

DDoS Protection

FastEdge

WAAP

Streaming

Object Storage

Resellers

List namespaces

Authorizations

Path Parameters

Query Parameters

Response