Guardrails - TypeScript SDK
The TypeScript SDK and docs are currently in beta. Report issues on GitHub.
Overview
Guardrails endpoints
Available Operations
- list - List guardrails
- create - Create a guardrail
- get - Get a guardrail
- update - Update a guardrail
- delete - Delete a guardrail
- listKeyAssignments - List all key assignments
- listMemberAssignments - List all member assignments
- listGuardrailKeyAssignments - List key assignments for a guardrail
- bulkAssignKeys - Bulk assign keys to a guardrail
- listGuardrailMemberAssignments - List member assignments for a guardrail
- bulkAssignMembers - Bulk assign members to a guardrail
- bulkUnassignKeys - Bulk unassign keys from a guardrail
- bulkUnassignMembers - Bulk unassign members from a guardrail
list
List all guardrails for the authenticated user. Provisioning key required.
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Response
Promise<operations.ListGuardrailsResponse>
Errors
create
Create a new guardrail for the authenticated user. Provisioning key required.
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Response
Promise<operations.CreateGuardrailResponse>
Errors
get
Get a single guardrail by ID. Provisioning key required.
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Response
Promise<operations.GetGuardrailResponse>
Errors
update
Update an existing guardrail. Provisioning key required.
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Response
Promise<operations.UpdateGuardrailResponse>
Errors
delete
Delete an existing guardrail. Provisioning key required.
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Response
Promise<operations.DeleteGuardrailResponse>
Errors
listKeyAssignments
List all API key guardrail assignments for the authenticated user. Provisioning key required.
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Response
Promise<operations.ListKeyAssignmentsResponse>
Errors
listMemberAssignments
List all organization member guardrail assignments for the authenticated user. Provisioning key required.
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Response
Promise<operations.ListMemberAssignmentsResponse>
Errors
listGuardrailKeyAssignments
List all API key assignments for a specific guardrail. Provisioning key required.
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Response
Promise<operations.ListGuardrailKeyAssignmentsResponse>
Errors
bulkAssignKeys
Assign multiple API keys to a specific guardrail. Provisioning key required.
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Response
Promise<operations.BulkAssignKeysToGuardrailResponse>
Errors
listGuardrailMemberAssignments
List all organization member assignments for a specific guardrail. Provisioning key required.
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Response
Promise<operations.ListGuardrailMemberAssignmentsResponse>
Errors
bulkAssignMembers
Assign multiple organization members to a specific guardrail. Provisioning key required.
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Response
Promise<operations.BulkAssignMembersToGuardrailResponse>
Errors
bulkUnassignKeys
Unassign multiple API keys from a specific guardrail. Provisioning key required.
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Response
Promise<operations.BulkUnassignKeysFromGuardrailResponse>
Errors
bulkUnassignMembers
Unassign multiple organization members from a specific guardrail. Provisioning key required.
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Response
Promise<operations.BulkUnassignMembersFromGuardrailResponse>