Search

Search searches for function invocations with filtering and ordering support

POST /api/v1/functions/{function_id}/invocations/search

Search

Go

package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/operations"
	"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.FunctionsInvocationSearch.Search(ctx, operations.C1APIFunctionsV1FunctionsInvocationSearchServiceSearchRequest{
        FunctionID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.FunctionsInvocationSearchResponse != 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.functionsInvocationSearch.search({
    functionId: "<id>",
  });

  console.log(result);
}

run();

curl --request POST \
  --url https://{tenantDomain}.conductor.one/api/v1/functions/{function_id}/invocations/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pageSize": 123,
  "pageToken": "<string>"
}
'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/functions/{function_id}/invocations/search"

payload = {
    "pageSize": 123,
    "pageToken": "<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({pageSize: 123, pageToken: '<string>'})
};

fetch('https://{tenantDomain}.conductor.one/api/v1/functions/{function_id}/invocations/search', 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/{function_id}/invocations/search",
  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([
    'pageSize' => 123,
    'pageToken' => '<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/{function_id}/invocations/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"pageSize\": 123,\n  \"pageToken\": \"<string>\"\n}"

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

200

{
  "list": [
    {
      "commitId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "error": "<string>",
      "functionId": "<string>",
      "id": "<string>",
      "input": {},
      "output": {},
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "nextPageToken": "<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.

Path Parameters

function_id · string · required

The function ID to search invocations for.

Body

application/json

FunctionsInvocationSearchRequest is the request for searching function invocations. Results are returned in descending order by created_at (newest first).

pageSize · integer<int32> | null

The number of results to return per page.

pageToken · string | null

The pagination token for fetching the next page.

Response

200 - application/json

FunctionsInvocationSearchResponse is the response for searching function invocations.

FunctionsInvocationSearchResponse is the response for searching function invocations.

list · Function Invocation · object[] | null

The list of function invocations, ordered by created_at descending.

Show child attributes

nextPageToken · string | null

The pagination token for fetching the next page.