Update Function

Update an existing function’s metadata, code, or both. Also the publish path: set function.published_commit_id and include “published_commit_id” in update_mask to make a commit the default runnable version. To push a new code commit, set content (and optionally commit_message); this is independent of update_mask, since commits are versioned separately from function metadata. A single request cannot publish the commit it just created, since published_commit_id is validated against existing commits before content is committed: publishing new code takes two calls, push then publish with the returned commit.id.

POST /api/v1/functions/update

Typescript (SDK)

TypeScript

import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    oauth: "<YOUR_OAUTH_HERE>",
  },
});

async function run() {
  const result = await conductoroneSDKTypescript.functions.updateFunction();

  console.log(result);
}

run();

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>",
    "hookRefs": [
      "<string>"
    ],
    "id": "<string>",
    "isDraft": true,
    "outboundNetworkAllowlist": [
      "<string>"
    ],
    "provisionedConcurrency": 123,
    "publishedCommitId": "<string>",
    "scopedRoleIds": [
      "<string>"
    ],
    "secret": {},
    "updatedAt": "2023-11-07T05:31:56Z",
    "useSpn": true,
    "workflowTemplateRefs": [
      "<string>"
    ]
  }
}

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 FunctionsServiceUpdateFunctionRequest message.

commitMessage · string

The commit message describing this code update. Defaults to a generic message if content is set and this is empty. Ignored if content is empty.

content · object

File map for a new code commit, applied as the function's new head commit. Keys are file paths in the function root; values are file contents as bytes. See CreateFunctionRequest.initial_content for the required entry-file signature. Independent of update_mask.

Show child attributes

function · Function · object | null

Function represents a customer-provided code extension in the API

Show child attributes

updateMask · string | null

Response

200 - application/json

Successful response

The FunctionsServiceUpdateFunctionResponse message.

commit · Function Commit · object | null

FunctionCommit represents a single commit in a function's history

Show child attributes

function · Function · object | null

Function represents a customer-provided code extension in the API

Show child attributes