Search K
Appearance
Get project by ID or name.
GET
/backend/v1/projects/{project}
Retrieves a project by its ID or name.
Authorizations
HTTPBearer
Type
HTTP (bearer)
Parameters
Path Parameters
project*
Required
Query Parameters
configAt
Get the config at a given point in time.
includeAdded
Include full guardrail, guardrail package, and provider objects added to the project.
Type
boolean
Default
falseResponses
Successful Response
application/json
JSON "project": { "adminCount": 0, "adminRoleId": "string", "agentSessionCount": 0, "botType": "string", "chatbotId": "string", "config": { "id": "string", "packages": [ { "blocking": true, "direction": "string", "enabled": true, "flagMessage": "string", "force": true, "id": "string", "mode": "string", "version": "string" } ], "providers": [ { "capabilities": [ "string" ], "default": true, "enabled": true, "id": "string", "name": "string", "type": "string" } ], "scanners": [ { "blocking": true, "direction": "string", "enabled": true, "flagMessage": "string", "force": true, "id": "string", "mode": "string", "version": "string" } ] }, "createdAt": "string", "createdBy": "string", "deploymentStatus": "draft", "friendlyId": "string", "id": "string", "memberCount": 0, "memberRoleId": "string", "name": "string", "providerCount": 0, "scannerCount": 0, "tokenCount": 0, "type": "string", "updatedAt": "string" }, "providers": [ { "authTemplate": null, "availability": { "global": false, "projectIds": [ [ ] ] }, "capabilities": [ "string" ], "hasLogo": false, "id": "string", "inputs": { "additionalProperties": "string" }, "maxRequestsPerSecond": 0, "name": "string", "projectId": "string", "redTeam": false, "requestConcurrencyLimit": { "decayPerSecond": 0, "requests": 0 }, "secrets": { "additionalProperties": "string" }, "siem": false, "systemProviderId": "string", "tag": "string", "template": { "awsAuth": { "accessKey": "string", "region": "string", "secretKey": "string", "service": "string", "token": "string" }, "body": "string", "headers": { "additionalProperties": "string" }, "json": "string", "method": "string", "ociAuth": { "keyId": "string", "passphrase": "string", "privateKeyPem": "string" }, "outputs": { }, "queryParams": { "additionalProperties": "string" }, "timeout": 20, "type": "request", "url": "string" }, "type": "string" } ], "scannerPackages": [ { "availability": { "global": false, "projectIds": [ [ ] ] }, "direction": "string", "id": "string", "name": "string", "performanceScannerIds": [ "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 } } ], "truncated": true
{
}