Search

Search for system log exports matching the specified filters.

POST /api/v1/search/systemlog/exports

Search

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.ExportsSearch.Search(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.ExportsSearchServiceSearchResponse != 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.exportsSearch.search();

  console.log(result);
}

run();

curl --request POST \
  --url https://{tenantDomain}.conductor.one/api/v1/search/systemlog/exports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "pageSize": 123,
  "pageToken": "<string>",
  "query": "<string>",
  "refs": [
    {
      "exportId": "<string>"
    }
  ]
}
'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/search/systemlog/exports"

payload = {
    "displayName": "<string>",
    "pageSize": 123,
    "pageToken": "<string>",
    "query": "<string>",
    "refs": [{ "exportId": "<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({
    displayName: '<string>',
    pageSize: 123,
    pageToken: '<string>',
    query: '<string>',
    refs: [{exportId: '<string>'}]
  })
};

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

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/search/systemlog/exports")

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  \"displayName\": \"<string>\",\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\",\n  \"query\": \"<string>\",\n  \"refs\": [\n    {\n      \"exportId\": \"<string>\"\n    }\n  ]\n}"

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

200

{
  "list": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "datasource": {
        "datasourceId": "<string>",
        "prefix": "<string>"
      },
      "deletedAt": "2023-11-07T05:31:56Z",
      "displayName": "<string>",
      "exportId": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "watermarkEventId": "<string>"
    }
  ],
  "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.

Body

application/json

ExportsSearchServiceSearchRequest is the request for searching system log exports.

displayName · string

Search for system log exporters with a case insensitive match on the display name.

pageSize · integer<int32>

The pageSize field.

pageToken · string

The pageToken field.

query · string

The query field.

refs · Exporter Ref · object[] | null

The refs field.

Show child attributes

Response

200 - application/json

ExportsSearchServiceSearchResponse is the response for searching system log exports.

ExportsSearchServiceSearchResponse is the response for searching system log exports.

list · Exporter · object[] | null

The list of system log exports matching the search criteria.

Show child attributes

nextPageToken · string

The token to retrieve the next page of results, or empty if there are no more results.