Create
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.Hooks.Create(ctx, nil)
if err != nil {
log.Fatal(err)
}
if res.HooksServiceCreateResponse != 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.hooks.create();
console.log(result);
}
run();curl --request POST \
--url https://{tenantDomain}.conductor.one/api/v1/hooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"displayName": "<string>",
"builtinPattern": {
"blockOutput": {
"message": "<string>",
"surfaces": []
},
"blockToolCall": {
"message": "<string>"
},
"creditCardBlocking": {},
"encodedContentGuard": {
"flagOnly": true,
"minBase64Run": 123,
"minHexRun": 123
},
"linkFilter": {
"allowedHosts": [
"<string>"
],
"blockImages": true
},
"piiRedaction": {
"redactFields": [
"<string>"
],
"replacement": "<string>"
},
"preToolBlock": {
"message": "<string>"
},
"promptInjectionScan": {
"flagOnly": true
},
"queryScopeLimit": {
"fields": [
"<string>"
],
"maxLimit": 123
},
"secretsMasking": {
"additionalPatterns": [
"<string>"
],
"placeholder": "<string>"
},
"sensitiveFileGuard": {
"blockedDirectories": [
"<string>"
],
"blockedPatterns": [
"<string>"
]
},
"toolOutputSizeGuard": {
"maxBytes": 123
},
"writeAuthorization": {
"blockedClassifications": [],
"businessHours": {
"days": [
123
],
"end": "<string>",
"start": "<string>",
"timezone": "<string>"
}
}
},
"description": "<string>",
"enabled": true,
"filter": {
"celExpression": "<string>"
},
"function": {
"commitId": "<string>",
"functionId": "<string>"
},
"jsonPatch": {
"celExpression": "<string>",
"staticOverlay": {}
},
"managedByGuardrails": true,
"priority": 123
}
'import requests
url = "https://{tenantDomain}.conductor.one/api/v1/hooks"
payload = {
"displayName": "<string>",
"builtinPattern": {
"blockOutput": {
"message": "<string>",
"surfaces": []
},
"blockToolCall": { "message": "<string>" },
"creditCardBlocking": {},
"encodedContentGuard": {
"flagOnly": True,
"minBase64Run": 123,
"minHexRun": 123
},
"linkFilter": {
"allowedHosts": ["<string>"],
"blockImages": True
},
"piiRedaction": {
"redactFields": ["<string>"],
"replacement": "<string>"
},
"preToolBlock": { "message": "<string>" },
"promptInjectionScan": { "flagOnly": True },
"queryScopeLimit": {
"fields": ["<string>"],
"maxLimit": 123
},
"secretsMasking": {
"additionalPatterns": ["<string>"],
"placeholder": "<string>"
},
"sensitiveFileGuard": {
"blockedDirectories": ["<string>"],
"blockedPatterns": ["<string>"]
},
"toolOutputSizeGuard": { "maxBytes": 123 },
"writeAuthorization": {
"blockedClassifications": [],
"businessHours": {
"days": [123],
"end": "<string>",
"start": "<string>",
"timezone": "<string>"
}
}
},
"description": "<string>",
"enabled": True,
"filter": { "celExpression": "<string>" },
"function": {
"commitId": "<string>",
"functionId": "<string>"
},
"jsonPatch": {
"celExpression": "<string>",
"staticOverlay": {}
},
"managedByGuardrails": True,
"priority": 123
}
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>',
builtinPattern: {
blockOutput: {message: '<string>', surfaces: []},
blockToolCall: {message: '<string>'},
creditCardBlocking: {},
encodedContentGuard: {flagOnly: true, minBase64Run: 123, minHexRun: 123},
linkFilter: {allowedHosts: ['<string>'], blockImages: true},
piiRedaction: {redactFields: ['<string>'], replacement: '<string>'},
preToolBlock: {message: '<string>'},
promptInjectionScan: {flagOnly: true},
queryScopeLimit: {fields: ['<string>'], maxLimit: 123},
secretsMasking: {additionalPatterns: ['<string>'], placeholder: '<string>'},
sensitiveFileGuard: {blockedDirectories: ['<string>'], blockedPatterns: ['<string>']},
toolOutputSizeGuard: {maxBytes: 123},
writeAuthorization: {
blockedClassifications: [],
businessHours: {days: [123], end: '<string>', start: '<string>', timezone: '<string>'}
}
},
description: '<string>',
enabled: true,
filter: {celExpression: '<string>'},
function: {commitId: '<string>', functionId: '<string>'},
jsonPatch: {celExpression: '<string>', staticOverlay: {}},
managedByGuardrails: true,
priority: 123
})
};
fetch('https://{tenantDomain}.conductor.one/api/v1/hooks', 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/hooks",
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>',
'builtinPattern' => [
'blockOutput' => [
'message' => '<string>',
'surfaces' => [
]
],
'blockToolCall' => [
'message' => '<string>'
],
'creditCardBlocking' => [
],
'encodedContentGuard' => [
'flagOnly' => true,
'minBase64Run' => 123,
'minHexRun' => 123
],
'linkFilter' => [
'allowedHosts' => [
'<string>'
],
'blockImages' => true
],
'piiRedaction' => [
'redactFields' => [
'<string>'
],
'replacement' => '<string>'
],
'preToolBlock' => [
'message' => '<string>'
],
'promptInjectionScan' => [
'flagOnly' => true
],
'queryScopeLimit' => [
'fields' => [
'<string>'
],
'maxLimit' => 123
],
'secretsMasking' => [
'additionalPatterns' => [
'<string>'
],
'placeholder' => '<string>'
],
'sensitiveFileGuard' => [
'blockedDirectories' => [
'<string>'
],
'blockedPatterns' => [
'<string>'
]
],
'toolOutputSizeGuard' => [
'maxBytes' => 123
],
'writeAuthorization' => [
'blockedClassifications' => [
],
'businessHours' => [
'days' => [
123
],
'end' => '<string>',
'start' => '<string>',
'timezone' => '<string>'
]
]
],
'description' => '<string>',
'enabled' => true,
'filter' => [
'celExpression' => '<string>'
],
'function' => [
'commitId' => '<string>',
'functionId' => '<string>'
],
'jsonPatch' => [
'celExpression' => '<string>',
'staticOverlay' => [
]
],
'managedByGuardrails' => true,
'priority' => 123
]),
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/hooks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"displayName\": \"<string>\",\n \"builtinPattern\": {\n \"blockOutput\": {\n \"message\": \"<string>\",\n \"surfaces\": []\n },\n \"blockToolCall\": {\n \"message\": \"<string>\"\n },\n \"creditCardBlocking\": {},\n \"encodedContentGuard\": {\n \"flagOnly\": true,\n \"minBase64Run\": 123,\n \"minHexRun\": 123\n },\n \"linkFilter\": {\n \"allowedHosts\": [\n \"<string>\"\n ],\n \"blockImages\": true\n },\n \"piiRedaction\": {\n \"redactFields\": [\n \"<string>\"\n ],\n \"replacement\": \"<string>\"\n },\n \"preToolBlock\": {\n \"message\": \"<string>\"\n },\n \"promptInjectionScan\": {\n \"flagOnly\": true\n },\n \"queryScopeLimit\": {\n \"fields\": [\n \"<string>\"\n ],\n \"maxLimit\": 123\n },\n \"secretsMasking\": {\n \"additionalPatterns\": [\n \"<string>\"\n ],\n \"placeholder\": \"<string>\"\n },\n \"sensitiveFileGuard\": {\n \"blockedDirectories\": [\n \"<string>\"\n ],\n \"blockedPatterns\": [\n \"<string>\"\n ]\n },\n \"toolOutputSizeGuard\": {\n \"maxBytes\": 123\n },\n \"writeAuthorization\": {\n \"blockedClassifications\": [],\n \"businessHours\": {\n \"days\": [\n 123\n ],\n \"end\": \"<string>\",\n \"start\": \"<string>\",\n \"timezone\": \"<string>\"\n }\n }\n },\n \"description\": \"<string>\",\n \"enabled\": true,\n \"filter\": {\n \"celExpression\": \"<string>\"\n },\n \"function\": {\n \"commitId\": \"<string>\",\n \"functionId\": \"<string>\"\n },\n \"jsonPatch\": {\n \"celExpression\": \"<string>\",\n \"staticOverlay\": {}\n },\n \"managedByGuardrails\": true,\n \"priority\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenantDomain}.conductor.one/api/v1/hooks")
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 \"builtinPattern\": {\n \"blockOutput\": {\n \"message\": \"<string>\",\n \"surfaces\": []\n },\n \"blockToolCall\": {\n \"message\": \"<string>\"\n },\n \"creditCardBlocking\": {},\n \"encodedContentGuard\": {\n \"flagOnly\": true,\n \"minBase64Run\": 123,\n \"minHexRun\": 123\n },\n \"linkFilter\": {\n \"allowedHosts\": [\n \"<string>\"\n ],\n \"blockImages\": true\n },\n \"piiRedaction\": {\n \"redactFields\": [\n \"<string>\"\n ],\n \"replacement\": \"<string>\"\n },\n \"preToolBlock\": {\n \"message\": \"<string>\"\n },\n \"promptInjectionScan\": {\n \"flagOnly\": true\n },\n \"queryScopeLimit\": {\n \"fields\": [\n \"<string>\"\n ],\n \"maxLimit\": 123\n },\n \"secretsMasking\": {\n \"additionalPatterns\": [\n \"<string>\"\n ],\n \"placeholder\": \"<string>\"\n },\n \"sensitiveFileGuard\": {\n \"blockedDirectories\": [\n \"<string>\"\n ],\n \"blockedPatterns\": [\n \"<string>\"\n ]\n },\n \"toolOutputSizeGuard\": {\n \"maxBytes\": 123\n },\n \"writeAuthorization\": {\n \"blockedClassifications\": [],\n \"businessHours\": {\n \"days\": [\n 123\n ],\n \"end\": \"<string>\",\n \"start\": \"<string>\",\n \"timezone\": \"<string>\"\n }\n }\n },\n \"description\": \"<string>\",\n \"enabled\": true,\n \"filter\": {\n \"celExpression\": \"<string>\"\n },\n \"function\": {\n \"commitId\": \"<string>\",\n \"functionId\": \"<string>\"\n },\n \"jsonPatch\": {\n \"celExpression\": \"<string>\",\n \"staticOverlay\": {}\n },\n \"managedByGuardrails\": true,\n \"priority\": 123\n}"
response = http.request(request)
puts response.read_body{
"hook": {
"builtinPattern": {
"blockOutput": {
"message": "<string>",
"surfaces": []
},
"blockToolCall": {
"message": "<string>"
},
"creditCardBlocking": {},
"encodedContentGuard": {
"flagOnly": true,
"minBase64Run": 123,
"minHexRun": 123
},
"linkFilter": {
"allowedHosts": [
"<string>"
],
"blockImages": true
},
"piiRedaction": {
"redactFields": [
"<string>"
],
"replacement": "<string>"
},
"preToolBlock": {
"message": "<string>"
},
"promptInjectionScan": {
"flagOnly": true
},
"queryScopeLimit": {
"fields": [
"<string>"
],
"maxLimit": 123
},
"secretsMasking": {
"additionalPatterns": [
"<string>"
],
"placeholder": "<string>"
},
"sensitiveFileGuard": {
"blockedDirectories": [
"<string>"
],
"blockedPatterns": [
"<string>"
]
},
"toolOutputSizeGuard": {
"maxBytes": 123
},
"writeAuthorization": {
"blockedClassifications": [],
"businessHours": {
"days": [
123
],
"end": "<string>",
"start": "<string>",
"timezone": "<string>"
}
}
},
"createdAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"displayName": "<string>",
"enabled": true,
"filter": {
"celExpression": "<string>"
},
"function": {
"commitId": "<string>",
"functionId": "<string>"
},
"id": "<string>",
"jsonPatch": {
"celExpression": "<string>",
"staticOverlay": {}
},
"managedByGuardrails": true,
"priority": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}
}Hook
Create
Invokes the c1.api.hooks.v1.HooksService.Create method.
POST
/
api
/
v1
/
hooks
Create
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.Hooks.Create(ctx, nil)
if err != nil {
log.Fatal(err)
}
if res.HooksServiceCreateResponse != 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.hooks.create();
console.log(result);
}
run();curl --request POST \
--url https://{tenantDomain}.conductor.one/api/v1/hooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"displayName": "<string>",
"builtinPattern": {
"blockOutput": {
"message": "<string>",
"surfaces": []
},
"blockToolCall": {
"message": "<string>"
},
"creditCardBlocking": {},
"encodedContentGuard": {
"flagOnly": true,
"minBase64Run": 123,
"minHexRun": 123
},
"linkFilter": {
"allowedHosts": [
"<string>"
],
"blockImages": true
},
"piiRedaction": {
"redactFields": [
"<string>"
],
"replacement": "<string>"
},
"preToolBlock": {
"message": "<string>"
},
"promptInjectionScan": {
"flagOnly": true
},
"queryScopeLimit": {
"fields": [
"<string>"
],
"maxLimit": 123
},
"secretsMasking": {
"additionalPatterns": [
"<string>"
],
"placeholder": "<string>"
},
"sensitiveFileGuard": {
"blockedDirectories": [
"<string>"
],
"blockedPatterns": [
"<string>"
]
},
"toolOutputSizeGuard": {
"maxBytes": 123
},
"writeAuthorization": {
"blockedClassifications": [],
"businessHours": {
"days": [
123
],
"end": "<string>",
"start": "<string>",
"timezone": "<string>"
}
}
},
"description": "<string>",
"enabled": true,
"filter": {
"celExpression": "<string>"
},
"function": {
"commitId": "<string>",
"functionId": "<string>"
},
"jsonPatch": {
"celExpression": "<string>",
"staticOverlay": {}
},
"managedByGuardrails": true,
"priority": 123
}
'import requests
url = "https://{tenantDomain}.conductor.one/api/v1/hooks"
payload = {
"displayName": "<string>",
"builtinPattern": {
"blockOutput": {
"message": "<string>",
"surfaces": []
},
"blockToolCall": { "message": "<string>" },
"creditCardBlocking": {},
"encodedContentGuard": {
"flagOnly": True,
"minBase64Run": 123,
"minHexRun": 123
},
"linkFilter": {
"allowedHosts": ["<string>"],
"blockImages": True
},
"piiRedaction": {
"redactFields": ["<string>"],
"replacement": "<string>"
},
"preToolBlock": { "message": "<string>" },
"promptInjectionScan": { "flagOnly": True },
"queryScopeLimit": {
"fields": ["<string>"],
"maxLimit": 123
},
"secretsMasking": {
"additionalPatterns": ["<string>"],
"placeholder": "<string>"
},
"sensitiveFileGuard": {
"blockedDirectories": ["<string>"],
"blockedPatterns": ["<string>"]
},
"toolOutputSizeGuard": { "maxBytes": 123 },
"writeAuthorization": {
"blockedClassifications": [],
"businessHours": {
"days": [123],
"end": "<string>",
"start": "<string>",
"timezone": "<string>"
}
}
},
"description": "<string>",
"enabled": True,
"filter": { "celExpression": "<string>" },
"function": {
"commitId": "<string>",
"functionId": "<string>"
},
"jsonPatch": {
"celExpression": "<string>",
"staticOverlay": {}
},
"managedByGuardrails": True,
"priority": 123
}
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>',
builtinPattern: {
blockOutput: {message: '<string>', surfaces: []},
blockToolCall: {message: '<string>'},
creditCardBlocking: {},
encodedContentGuard: {flagOnly: true, minBase64Run: 123, minHexRun: 123},
linkFilter: {allowedHosts: ['<string>'], blockImages: true},
piiRedaction: {redactFields: ['<string>'], replacement: '<string>'},
preToolBlock: {message: '<string>'},
promptInjectionScan: {flagOnly: true},
queryScopeLimit: {fields: ['<string>'], maxLimit: 123},
secretsMasking: {additionalPatterns: ['<string>'], placeholder: '<string>'},
sensitiveFileGuard: {blockedDirectories: ['<string>'], blockedPatterns: ['<string>']},
toolOutputSizeGuard: {maxBytes: 123},
writeAuthorization: {
blockedClassifications: [],
businessHours: {days: [123], end: '<string>', start: '<string>', timezone: '<string>'}
}
},
description: '<string>',
enabled: true,
filter: {celExpression: '<string>'},
function: {commitId: '<string>', functionId: '<string>'},
jsonPatch: {celExpression: '<string>', staticOverlay: {}},
managedByGuardrails: true,
priority: 123
})
};
fetch('https://{tenantDomain}.conductor.one/api/v1/hooks', 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/hooks",
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>',
'builtinPattern' => [
'blockOutput' => [
'message' => '<string>',
'surfaces' => [
]
],
'blockToolCall' => [
'message' => '<string>'
],
'creditCardBlocking' => [
],
'encodedContentGuard' => [
'flagOnly' => true,
'minBase64Run' => 123,
'minHexRun' => 123
],
'linkFilter' => [
'allowedHosts' => [
'<string>'
],
'blockImages' => true
],
'piiRedaction' => [
'redactFields' => [
'<string>'
],
'replacement' => '<string>'
],
'preToolBlock' => [
'message' => '<string>'
],
'promptInjectionScan' => [
'flagOnly' => true
],
'queryScopeLimit' => [
'fields' => [
'<string>'
],
'maxLimit' => 123
],
'secretsMasking' => [
'additionalPatterns' => [
'<string>'
],
'placeholder' => '<string>'
],
'sensitiveFileGuard' => [
'blockedDirectories' => [
'<string>'
],
'blockedPatterns' => [
'<string>'
]
],
'toolOutputSizeGuard' => [
'maxBytes' => 123
],
'writeAuthorization' => [
'blockedClassifications' => [
],
'businessHours' => [
'days' => [
123
],
'end' => '<string>',
'start' => '<string>',
'timezone' => '<string>'
]
]
],
'description' => '<string>',
'enabled' => true,
'filter' => [
'celExpression' => '<string>'
],
'function' => [
'commitId' => '<string>',
'functionId' => '<string>'
],
'jsonPatch' => [
'celExpression' => '<string>',
'staticOverlay' => [
]
],
'managedByGuardrails' => true,
'priority' => 123
]),
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/hooks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"displayName\": \"<string>\",\n \"builtinPattern\": {\n \"blockOutput\": {\n \"message\": \"<string>\",\n \"surfaces\": []\n },\n \"blockToolCall\": {\n \"message\": \"<string>\"\n },\n \"creditCardBlocking\": {},\n \"encodedContentGuard\": {\n \"flagOnly\": true,\n \"minBase64Run\": 123,\n \"minHexRun\": 123\n },\n \"linkFilter\": {\n \"allowedHosts\": [\n \"<string>\"\n ],\n \"blockImages\": true\n },\n \"piiRedaction\": {\n \"redactFields\": [\n \"<string>\"\n ],\n \"replacement\": \"<string>\"\n },\n \"preToolBlock\": {\n \"message\": \"<string>\"\n },\n \"promptInjectionScan\": {\n \"flagOnly\": true\n },\n \"queryScopeLimit\": {\n \"fields\": [\n \"<string>\"\n ],\n \"maxLimit\": 123\n },\n \"secretsMasking\": {\n \"additionalPatterns\": [\n \"<string>\"\n ],\n \"placeholder\": \"<string>\"\n },\n \"sensitiveFileGuard\": {\n \"blockedDirectories\": [\n \"<string>\"\n ],\n \"blockedPatterns\": [\n \"<string>\"\n ]\n },\n \"toolOutputSizeGuard\": {\n \"maxBytes\": 123\n },\n \"writeAuthorization\": {\n \"blockedClassifications\": [],\n \"businessHours\": {\n \"days\": [\n 123\n ],\n \"end\": \"<string>\",\n \"start\": \"<string>\",\n \"timezone\": \"<string>\"\n }\n }\n },\n \"description\": \"<string>\",\n \"enabled\": true,\n \"filter\": {\n \"celExpression\": \"<string>\"\n },\n \"function\": {\n \"commitId\": \"<string>\",\n \"functionId\": \"<string>\"\n },\n \"jsonPatch\": {\n \"celExpression\": \"<string>\",\n \"staticOverlay\": {}\n },\n \"managedByGuardrails\": true,\n \"priority\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenantDomain}.conductor.one/api/v1/hooks")
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 \"builtinPattern\": {\n \"blockOutput\": {\n \"message\": \"<string>\",\n \"surfaces\": []\n },\n \"blockToolCall\": {\n \"message\": \"<string>\"\n },\n \"creditCardBlocking\": {},\n \"encodedContentGuard\": {\n \"flagOnly\": true,\n \"minBase64Run\": 123,\n \"minHexRun\": 123\n },\n \"linkFilter\": {\n \"allowedHosts\": [\n \"<string>\"\n ],\n \"blockImages\": true\n },\n \"piiRedaction\": {\n \"redactFields\": [\n \"<string>\"\n ],\n \"replacement\": \"<string>\"\n },\n \"preToolBlock\": {\n \"message\": \"<string>\"\n },\n \"promptInjectionScan\": {\n \"flagOnly\": true\n },\n \"queryScopeLimit\": {\n \"fields\": [\n \"<string>\"\n ],\n \"maxLimit\": 123\n },\n \"secretsMasking\": {\n \"additionalPatterns\": [\n \"<string>\"\n ],\n \"placeholder\": \"<string>\"\n },\n \"sensitiveFileGuard\": {\n \"blockedDirectories\": [\n \"<string>\"\n ],\n \"blockedPatterns\": [\n \"<string>\"\n ]\n },\n \"toolOutputSizeGuard\": {\n \"maxBytes\": 123\n },\n \"writeAuthorization\": {\n \"blockedClassifications\": [],\n \"businessHours\": {\n \"days\": [\n 123\n ],\n \"end\": \"<string>\",\n \"start\": \"<string>\",\n \"timezone\": \"<string>\"\n }\n }\n },\n \"description\": \"<string>\",\n \"enabled\": true,\n \"filter\": {\n \"celExpression\": \"<string>\"\n },\n \"function\": {\n \"commitId\": \"<string>\",\n \"functionId\": \"<string>\"\n },\n \"jsonPatch\": {\n \"celExpression\": \"<string>\",\n \"staticOverlay\": {}\n },\n \"managedByGuardrails\": true,\n \"priority\": 123\n}"
response = http.request(request)
puts response.read_body{
"hook": {
"builtinPattern": {
"blockOutput": {
"message": "<string>",
"surfaces": []
},
"blockToolCall": {
"message": "<string>"
},
"creditCardBlocking": {},
"encodedContentGuard": {
"flagOnly": true,
"minBase64Run": 123,
"minHexRun": 123
},
"linkFilter": {
"allowedHosts": [
"<string>"
],
"blockImages": true
},
"piiRedaction": {
"redactFields": [
"<string>"
],
"replacement": "<string>"
},
"preToolBlock": {
"message": "<string>"
},
"promptInjectionScan": {
"flagOnly": true
},
"queryScopeLimit": {
"fields": [
"<string>"
],
"maxLimit": 123
},
"secretsMasking": {
"additionalPatterns": [
"<string>"
],
"placeholder": "<string>"
},
"sensitiveFileGuard": {
"blockedDirectories": [
"<string>"
],
"blockedPatterns": [
"<string>"
]
},
"toolOutputSizeGuard": {
"maxBytes": 123
},
"writeAuthorization": {
"blockedClassifications": [],
"businessHours": {
"days": [
123
],
"end": "<string>",
"start": "<string>",
"timezone": "<string>"
}
}
},
"createdAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"displayName": "<string>",
"enabled": true,
"filter": {
"celExpression": "<string>"
},
"function": {
"commitId": "<string>",
"functionId": "<string>"
},
"id": "<string>",
"jsonPatch": {
"celExpression": "<string>",
"staticOverlay": {}
},
"managedByGuardrails": true,
"priority": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
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 HooksServiceCreateRequest message.
This message contains a oneof named hook_type. Only a single field of the following list may be set at a time:
- function
- builtinPattern
- jsonPatch
The displayName field.
BuiltInPattern references a ConductorOne-maintained DLP pattern. The specific pattern and its configuration are encoded as a oneof.
This message contains a oneof named config. Only a single field of the following list may be set at a time:
- piiRedaction
- creditCardBlocking
- queryScopeLimit
- writeAuthorization
- sensitiveFileGuard
- toolOutputSizeGuard
- secretsMasking
- linkFilter
- encodedContentGuard
- promptInjectionScan
- blockOutput
- blockToolCall
- preToolBlock
Show child attributes
Show child attributes
The description field.
The enabled field.
The event field.
Available options:
HOOK_EVENT_TYPE_UNSPECIFIED, HOOK_EVENT_TYPE_PRE_TOOL_USE, HOOK_EVENT_TYPE_POST_TOOL_USE, HOOK_EVENT_TYPE_PRE_OUTPUT HookFilter determines which calls (or, for HOOK_EVENT_TYPE_PRE_OUTPUT, which outgoing response chunks) a hook applies to.
Show child attributes
Show child attributes
HookFunctionRef identifies a customer-authored function to invoke.
Show child attributes
Show child attributes
JSONPatchConfig adds, overwrites, or removes fields on a tool call's JSON input, with no function invocation. Only valid on HOOK_EVENT_TYPE_PRE_TOOL_USE. cel_expression is evaluated against ctx/input/caller and must produce a map; static_overlay is a fixed map. Either result is shallow-merged onto the input under RFC 7396 merge patch semantics: a key overwrites or adds that key, a null value removes it, and a nested object replaces rather than merging into the existing one.
This message contains a oneof named source. Only a single field of the following list may be set at a time:
- celExpression
- staticOverlay
Show child attributes
Show child attributes
The managedByGuardrails field.
The priority field.
Response
200 - application/json
Successful response
The HooksServiceCreateResponse message.
Hook represents a customer-configured interception point for tool calls.
This message contains a oneof named hook_type. Only a single field of the following list may be set at a time:
- function
- builtinPattern
- jsonPatch
Show child attributes
Show child attributes
Was this page helpful?
⌘I