Get guardrail package.

GET

/backend/v1/scanner-packages/{scannerPackageId}

Retrieves a guardrail package by ID.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

scannerPackageId*

Type

string

Required

Format

"uuid"

Responses

Successful Response

Content-Type

application/json

{

  

"package": {

  

  

"availability": {

  

  

  

"global": false,

  

  

  

"projectIds": [

  

  

  

  

[

  

  

  

  

]

  

  

  

]

  

  

},

  

  

"direction": "string",

  

  

"id": "string",

  

  

"name": "string",

  

  

"projectId": "string",

  

  

"scannerCounts": {

  

  

  

"additionalProperties": 0

  

  

},

  

  

"scannerIds": [

  

  

  

"string"

  

  

],

  

  

"source": {

  

  

  

"type": "internal"

  

  

},

  

  

"vendored": true

  

},

  

"scanners": [

  

  

{

  

  

  

"availability": {

  

  

  

  

"global": false,

  

  

  

  

"projectIds": [

  

  

  

  

  

[

  

  

  

  

  

]

  

  

  

  

]

  

  

  

},

  

  

  

"config": {

  

  

  

  

"pattern": "string",

  

  

  

  

"type": "regex"

  

  

  

},

  

  

  

"direction": "request",

  

  

  

"id": "string",

  

  

  

"name": "string",

  

  

  

"packageId": "string",

  

  

  

"projectId": "string",

  

  

  

"scannerTemplateId": "string",

  

  

  

"source": {

  

  

  

  

"type": "internal"

  

  

  

},

  

  

  

"tags": [

  

  

  

  

[

  

  

  

  

]

  

  

  

],

  

  

  

"vendored": true,

  

  

  

"versionMeta": {

  

  

  

  

"createdAt": "string",

  

  

  

  

"createdBy": "string",

  

  

  

  

"description": "string",

  

  

  

  

"direction": "string",

  

  

  

  

"f1Score": 0,

  

  

  

  

"id": "string",

  

  

  

  

"latestDatasetResult": {

  

  

  

  

  

"datasetRunId": "string",

  

  

  

  

  

"f1Score": 0

  

  

  

  

},

  

  

  

  

"name": "string",

  

  

  

  

"published": true

  

  

  

}

  

  

}

  

]

}

GET

/backend/v1/scanner-packages/{scannerPackageId}

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

scannerPackageId*

Samples

Powered by VitePress OpenAPI