Get functions runtime env status

GET

/api/v1/projects/{id}/functions/env/status

curl --request GET \
  --url https://api.deploybase.eu/api/v1/api/v1/projects/example/functions/env/status \
  --header 'Authorization: <Authorization>'

Returns the project’s runtime environment variable keys (never values) and, per active function, whether it runs with the current set. A variable change reaches warm HTTP functions by restarting them, so “applied” turns true once the restart has rolled out; a function scaled to zero picks the new set up when it next starts.

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string

Project ID

Responses

200

OK

Media type application/json

object

data

meta

object

request_id

string

timestamp

string

trace_id

string

data

object

applied_count

integer

functions

Array<object>

object

applied

Applied means the function runs with the project’s current runtime env set: for a deployed HTTP function, its Deployment carries the current env hash and the controller has acted on it; for any other function, its Secret does (every queued invocation reads the Secret fresh).

boolean

function_id

string

kind

string

Allowed values: background http

name

string

ready

Ready is an HTTP function’s serving state, the same answer as its deployment status. Absent for background functions, which run nothing between invocations.

boolean

runtime_keys

Array<string>

Example

{
  "data": {
    "functions": [
      {
        "kind": "background"
      }
    ]
  }
}

401

Unauthorized

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

404

Not Found

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

503

Service Unavailable

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}