Skip to content
deploybase

Get HTTP function deployment status

GET
/api/v1/projects/{id}/functions/{functionId}/deployment
 
curl --request GET \
  --url https://api.deploybase.eu/api/v1/api/v1/projects/example/functions/example/deployment \
  --header 'Authorization: <Authorization>'

Returns the live rollout state of a kind=http function: its URL, whether it is serving, replica counts, the generation the cluster has acted on, and the last rollout transition. Nothing is persisted — every field is read from the cluster on each request.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
id
required
string

Project ID

functionId
required
string

Function ID

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

OK

Media type application/json
object
data
meta
object
request_id
string
timestamp
string
trace_id
string
data
object
available_replicas
integer
deployed_generation

DeployedGeneration is the Deployment generation the controller has acted on. It moves after a redeploy lands, which is how a caller tells “my new code is out” from “the apiserver accepted my update and nothing has happened yet”.

integer
last_transition_reason
string
last_transition_time
string
ready
boolean
ready_replicas
integer
replicas
integer
url
string
Example generated 
{
  "data": {
    "available_replicas": 1,
    "deployed_generation": 1,
    "last_transition_reason": "example",
    "last_transition_time": "example",
    "ready": true,
    "ready_replicas": 1,
    "replicas": 1,
    "url": "example"
  },
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

400

Section titled “ 400 ”

Bad Request

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"
  }
}

401

Section titled “ 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

Section titled “ 404 ”

Function not found, or not deployed yet

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"
  }
}

500

Section titled “ 500 ”

Internal Server Error

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

Section titled “ 503 ”

Deployment status is temporarily 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"
  }
}