Get function

Reads one function by id, or by its assigned hostname label.

Authorization

BearerAuth

AuthorizationBearer <token>

A team API token, created by a team owner and presented as Authorization: Bearer fnt_…. The secret is shown once at creation and stored only as a hash.

In: header

Header Parameters

Connect-Protocol-Version*number

Define the version of the Connect protocol

Value in1

Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

functionId?string

Either function_id or name; name is what a human has to hand.

name?string

[key: string]?never

Response Body

`application/json`

curl -X POST "https://functions.xeonr.io/xeonr.functions.v1.FunctionService/GetFunction" \
  -H "Connect-Protocol-Version: 1" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X POST "https://functions.xeonr.io/xeonr.functions.v1.FunctionService/GetFunction" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{}'

{
  "function": {
    "functionId": "string",
    "name": "string",
    "displayName": "string",
    "ownerTeam": "string",
    "kind": "KIND_UNSPECIFIED",
    "build": {
      "packages": [
        "string"
      ],
      "entrypoint": [
        "string"
      ],
      "port": 0,
      "staticDir": "string",
      "mainPackage": "string"
    },
    "scaling": {
      "minInstances": 0,
      "maxInstances": 0,
      "concurrency": 0,
      "idleTimeoutSec": 0,
      "activationTimeoutSec": 0
    },
    "env": {
      "property1": "string",
      "property2": "string"
    },
    "secretKeys": [
      "string"
    ],
    "git": {
      "provider": "GIT_PROVIDER_UNSPECIFIED",
      "repo": "string",
      "branch": "string",
      "subdirectory": "string",
      "webhookUrl": "string",
      "credentialsSet": true,
      "authMode": "AUTH_MODE_UNSPECIFIED",
      "installationId": 0,
      "credentialExpiresAtUnix": 0
    },
    "activeVersionId": "string",
    "filesReadOnly": true,
    "createdAtUnix": 0,
    "updatedAtUnix": 0,
    "activeVersion": {
      "versionId": "string",
      "functionId": "string",
      "state": "VERSION_STATE_UNSPECIFIED",
      "snapshotId": "string",
      "environmentId": "string",
      "appId": "string",
      "staticRoot": "string",
      "gitCommit": "string",
      "gitRef": "string",
      "failureMessage": "string",
      "createdAtUnix": 0
    },
    "latestVersion": {
      "versionId": "string",
      "functionId": "string",
      "state": "VERSION_STATE_UNSPECIFIED",
      "snapshotId": "string",
      "environmentId": "string",
      "appId": "string",
      "staticRoot": "string",
      "gitCommit": "string",
      "gitRef": "string",
      "failureMessage": "string",
      "createdAtUnix": 0
    }
  }
}

{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Get function

Authorization

Header Parameters

Request Body

Response Body

200application/json

defaultapplication/json

`application/json`

`application/json`