Get Function By Name

GET/v1/functions/by-name/{name}

Base URL *

Your instance endpoint, shown on the instance page in the dashboard. Each instance has its own host; there is no shared API host.

Authorization (Bearer token)

name (path) *

tenantId (query)

Parameters

Name	In	Type	Required	Description
`name`	path	`string`	Yes
`tenantId`	query	`string`	No

Responses

200 Get function by name

Property	Type	Description
`function`	`object`

default An unexpected error response.

Property	Type	Description
`code`	`integer`
`message`	`string`
`details`	`object[]`

Request

curl -X GET "http://localhost:8089/v1/functions/by-name/{name}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

const response = await fetch("http://localhost:8089/v1/functions/by-name/{name}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
});
const data = await response.json();

import requests

response = requests.get(
    "http://localhost:8089/v1/functions/by-name/{name}",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
)
data = response.json()

Response

{
  "function": {
    "id": "string",
    "tenantId": "string",
    "name": "string",
    "description": "string",
    "mode": "EXECUTION_MODE_UNSPECIFIED",
    "webhook": {
      "url": "string",
      "method": "string",
      "timeoutMs": 0
    },
    "proxy": {
      "baseUrl": "string",
      "path": "string",
      "method": "string"
    },
    "isolated": {
      "runtime": "string",
      "code": "string",
      "packages": [
        "string"
      ],
      "dockerHost": "string"
    },
    "timeoutMs": 0,
    "memoryMb": 0,
    "maxRetries": 0,
    "enabled": true,
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T00:00:00Z"
  }
}

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}