Update guardrail.

PATCH

/backend/v1/scanners/{scannerId}

Updates a guardrail's configuration, name, files, tags and direction.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

scannerId*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"config": null,

  

"direction": "string",

  

"name": "string",

  

"published": true,

  

"tags": [

  

  

"string"

  

],

  

"version": {

  

  

"description": "string",

  

  

"name": "string",

  

  

"published": true,

  

  

"push": false

  

}

}

Responses

Successful Response

Content-Type

application/json

{

  

"message": "string",

  

"versionMeta": {

  

  

"createdAt": "string",

  

  

"createdBy": "string",

  

  

"description": "string",

  

  

"direction": "string",

  

  

"f1Score": 0,

  

  

"id": "string",

  

  

"latestDatasetResult": {

  

  

  

"datasetRunId": "string",

  

  

  

"f1Score": 0

  

  

},

  

  

"name": "string",

  

  

"published": true

  

}

}

PATCH

/backend/v1/scanners/{scannerId}

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

scannerId*

Body

Samples

Powered by VitePress OpenAPI