Create Function

CreateFunction registers a new serverless function and creates its initial code commit. Functions run as TypeScript modules in a sandboxed runtime; see initial_content for the entry-file signature and SDK import.

The new function is unpublished. To make the commit the default runnable version (and have the function appear as runnable in the Functions UI), call UpdateFunction with function.published_commit_id set and update_mask=[“published_commit_id”].

POST /api/v1/functions

CreateFunction

Go

package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.Functions.CreateFunction(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.FunctionsServiceCreateFunctionResponse != nil {
        // handle response
    }
}

200

{
  "commit": {
    "author": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "functionId": "<string>",
    "id": "<string>",
    "message": "<string>"
  },
  "function": {
    "createdAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "displayName": "<string>",
    "head": "<string>",
    "id": "<string>",
    "isDraft": true,
    "outboundNetworkAllowlist": [
      "<string>"
    ],
    "publishedCommitId": "<string>",
    "scopedRoleIds": [
      "<string>"
    ],
    "secret": {},
    "updatedAt": "2023-11-07T05:31:56Z",
    "useSpn": true
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization · string · header · required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Body

application/json

The FunctionsServiceCreateFunctionRequest message.

commitMessage · string | null

The commit message describing the initial code submission.

description · string | null

A description of what the function does.

displayName · string | null

The human-readable name for the function.

functionType · enum<string> | null

The type of function to create. Use FUNCTION_TYPE_ANY for user functions — that is the type the Functions UI lists. Do not use any other value.

Available options: FUNCTION_TYPE_UNSPECIFIED, FUNCTION_TYPE_ANY, FUNCTION_TYPE_CODE_MODE

initialContent · object

File map for the initial code commit. Keys are file paths in the function root (e.g. "main.ts", "main.test.ts"); values are file contents as bytes.

Runtime: TypeScript. The entry file MUST be "main.ts" exporting a default async handler:

import { JSONObject } from "@c1/functions-sdk"; export default async function main(input: JSONObject): Promise { return { ok: true, echo: input }; }

The handler MUST return a JSON object — not a primitive, array, or null.

Show child attributes

Response

200 - application/json

Successful response

The FunctionsServiceCreateFunctionResponse message.

commit · Function Commit · object

FunctionCommit represents a single commit in a function's history

Show child attributes

function · Function · object

Function represents a customer-provided code extension in the API

Show child attributes