Get guardrail.

GET

/backend/v1/scanners/{scannerId}

Retrieves a guardrail by ID.

Authorizations

HTTPBearer

TypeHTTP (bearer)

Parameters

Path Parameters

scannerId*

Typestring

Required

formatuuid

Query Parameters

configAt

Get the config at a given point in time.

version

Get the guardrail at a specific version

Responses

Successful Response

Content-Type

application/json

{

"scanner": {

"availability": {

"global": false,

"projectIds": [

[

]

]

},

"availableUpdate": "string",

"config": "string",

"direction": "string",

"id": "string",

"name": "string",

"packageId": "string",

"projectId": "string",

"scannerTemplateId": "string",

"shared": false,

"source": {

"type": "internal"

},

"tags": [

[

]

],

"vendored": false,

"versionMeta": {

"createdAt": "string",

"createdBy": "string",

"description": "string",

"direction": "string",

"f1Score": "string",

"id": "string",

"latestDatasetResult": "string",

"name": "string",

"published": true

}

}

}

GET

/backend/v1/scanners/{scannerId}

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

scannerId*

configAt

version

Samples

Powered by VitePress OpenAPI