Update Function

Update an existing function’s metadata. 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.

POST /api/v1/functions/update

UpdateFunction

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.UpdateFunction(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.FunctionsServiceUpdateFunctionResponse != nil {
        // handle response
    }
}

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();

curl --request POST \
  --url https://{tenantDomain}.conductor.one/api/v1/functions/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "function": {
    "description": "<string>",
    "displayName": "<string>",
    "head": "<string>",
    "id": "<string>",
    "isDraft": true,
    "outboundNetworkAllowlist": [
      "<string>"
    ],
    "publishedCommitId": "<string>",
    "scopedRoleIds": [
      "<string>"
    ],
    "secret": {}
  },
  "updateMask": "<string>"
}
'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/functions/update"

payload = {
    "function": {
        "description": "<string>",
        "displayName": "<string>",
        "head": "<string>",
        "id": "<string>",
        "isDraft": True,
        "outboundNetworkAllowlist": ["<string>"],
        "publishedCommitId": "<string>",
        "scopedRoleIds": ["<string>"],
        "secret": {}
    },
    "updateMask": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    function: {
      description: '<string>',
      displayName: '<string>',
      head: '<string>',
      id: '<string>',
      isDraft: true,
      outboundNetworkAllowlist: ['<string>'],
      publishedCommitId: '<string>',
      scopedRoleIds: ['<string>'],
      secret: {}
    },
    updateMask: '<string>'
  })
};

fetch('https://{tenantDomain}.conductor.one/api/v1/functions/update', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}.conductor.one/api/v1/functions/update",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'function' => [
        'description' => '<string>',
        'displayName' => '<string>',
        'head' => '<string>',
        'id' => '<string>',
        'isDraft' => true,
        'outboundNetworkAllowlist' => [
                '<string>'
        ],
        'publishedCommitId' => '<string>',
        'scopedRoleIds' => [
                '<string>'
        ],
        'secret' => [
                
        ]
    ],
    'updateMask' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}.conductor.one/api/v1/functions/update")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"function\": {\n    \"description\": \"<string>\",\n    \"displayName\": \"<string>\",\n    \"head\": \"<string>\",\n    \"id\": \"<string>\",\n    \"isDraft\": true,\n    \"outboundNetworkAllowlist\": [\n      \"<string>\"\n    ],\n    \"publishedCommitId\": \"<string>\",\n    \"scopedRoleIds\": [\n      \"<string>\"\n    ],\n    \"secret\": {}\n  },\n  \"updateMask\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/functions/update")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"function\": {\n    \"description\": \"<string>\",\n    \"displayName\": \"<string>\",\n    \"head\": \"<string>\",\n    \"id\": \"<string>\",\n    \"isDraft\": true,\n    \"outboundNetworkAllowlist\": [\n      \"<string>\"\n    ],\n    \"publishedCommitId\": \"<string>\",\n    \"scopedRoleIds\": [\n      \"<string>\"\n    ],\n    \"secret\": {}\n  },\n  \"updateMask\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

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

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.

function · Function · object | null

Function represents a customer-provided code extension in the API

Show child attributes