Agent Secrets API
List all agent secrets of the environment
| Path | Method | Protected |
|---|---|---|
/v1/envs/{environment_id}/agent-secrets | GET | Yes |
Example Response JSON
{
"values": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
"path": [
"string"
],
"revision": 0,
"secretType": {
"defs": [
{
"id": "string",
"name": "string",
"body": {
"kind": "ref",
"value": {
"id": "string",
"metadata": {
"doc": "string",
"aliases": [
"string"
],
"examples": [
"string"
],
"deprecated": "string",
"role": {
"tag": "multimodal"
}
}
}
}
}
],
"root": {
"kind": "ref",
"value": {
"id": "string",
"metadata": {
"doc": "string",
"aliases": [
"string"
],
"examples": [
"string"
],
"deprecated": "string",
"role": {
"tag": "multimodal"
}
}
}
}
},
"secretValue": {
"kind": "bool",
"value": true
}
}
]
}Create a new agent secret
| Path | Method | Protected |
|---|---|---|
/v1/envs/{environment_id}/agent-secrets | POST | Yes |
Example Request JSON
{
"path": [
"string"
],
"secretType": {
"defs": [
{
"id": "string",
"name": "string",
"body": {
"kind": "ref",
"value": {
"id": "string",
"metadata": {
"doc": "string",
"aliases": [
"string"
],
"examples": [
"string"
],
"deprecated": "string",
"role": {
"tag": "multimodal"
}
}
}
}
}
],
"root": {
"kind": "ref",
"value": {
"id": "string",
"metadata": {
"doc": "string",
"aliases": [
"string"
],
"examples": [
"string"
],
"deprecated": "string",
"role": {
"tag": "multimodal"
}
}
}
}
},
"secretValue": {
"kind": "bool",
"value": true
}
}Example Response JSON
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
"path": [
"string"
],
"revision": 0,
"secretType": {
"defs": [
{
"id": "string",
"name": "string",
"body": {
"kind": "ref",
"value": {
"id": "string",
"metadata": {
"doc": "string",
"aliases": [
"string"
],
"examples": [
"string"
],
"deprecated": "string",
"role": {
"tag": "multimodal"
}
}
}
}
}
],
"root": {
"kind": "ref",
"value": {
"id": "string",
"metadata": {
"doc": "string",
"aliases": [
"string"
],
"examples": [
"string"
],
"deprecated": "string",
"role": {
"tag": "multimodal"
}
}
}
}
},
"secretValue": {
"kind": "bool",
"value": true
}
}Get an agent secret in an environment by its path segments.
| Path | Method | Protected |
|---|---|---|
/v1/envs/{environment_id}/agent-secrets/by-path | GET | Yes |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| path | array | Yes | - |
Example Response JSON
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
"path": [
"string"
],
"revision": 0,
"secretType": {
"defs": [
{
"id": "string",
"name": "string",
"body": {
"kind": "ref",
"value": {
"id": "string",
"metadata": {
"doc": "string",
"aliases": [
"string"
],
"examples": [
"string"
],
"deprecated": "string",
"role": {
"tag": "multimodal"
}
}
}
}
}
],
"root": {
"kind": "ref",
"value": {
"id": "string",
"metadata": {
"doc": "string",
"aliases": [
"string"
],
"examples": [
"string"
],
"deprecated": "string",
"role": {
"tag": "multimodal"
}
}
}
}
},
"secretValue": {
"kind": "bool",
"value": true
}
}Get agent secret by id.
| Path | Method | Protected |
|---|---|---|
/v1/agent-secrets/{agent_secret_id} | GET | Yes |
Example Response JSON
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
"path": [
"string"
],
"revision": 0,
"secretType": {
"defs": [
{
"id": "string",
"name": "string",
"body": {
"kind": "ref",
"value": {
"id": "string",
"metadata": {
"doc": "string",
"aliases": [
"string"
],
"examples": [
"string"
],
"deprecated": "string",
"role": {
"tag": "multimodal"
}
}
}
}
}
],
"root": {
"kind": "ref",
"value": {
"id": "string",
"metadata": {
"doc": "string",
"aliases": [
"string"
],
"examples": [
"string"
],
"deprecated": "string",
"role": {
"tag": "multimodal"
}
}
}
}
},
"secretValue": {
"kind": "bool",
"value": true
}
}Update agent secret
| Path | Method | Protected |
|---|---|---|
/v1/agent-secrets/{agent_secret_id} | PATCH | Yes |
Example Request JSON
{
"currentRevision": 0,
"secretValue": {
"op": "set",
"value": {
"kind": "bool",
"value": true
}
}
}Example Response JSON
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
"path": [
"string"
],
"revision": 0,
"secretType": {
"defs": [
{
"id": "string",
"name": "string",
"body": {
"kind": "ref",
"value": {
"id": "string",
"metadata": {
"doc": "string",
"aliases": [
"string"
],
"examples": [
"string"
],
"deprecated": "string",
"role": {
"tag": "multimodal"
}
}
}
}
}
],
"root": {
"kind": "ref",
"value": {
"id": "string",
"metadata": {
"doc": "string",
"aliases": [
"string"
],
"examples": [
"string"
],
"deprecated": "string",
"role": {
"tag": "multimodal"
}
}
}
}
},
"secretValue": {
"kind": "bool",
"value": true
}
}Delete agent secret
| Path | Method | Protected |
|---|---|---|
/v1/agent-secret/{agent_secret_id} | DELETE | Yes |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| current_revision | integer | Yes | - |
Example Response JSON
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
"path": [
"string"
],
"revision": 0,
"secretType": {
"defs": [
{
"id": "string",
"name": "string",
"body": {
"kind": "ref",
"value": {
"id": "string",
"metadata": {
"doc": "string",
"aliases": [
"string"
],
"examples": [
"string"
],
"deprecated": "string",
"role": {
"tag": "multimodal"
}
}
}
}
}
],
"root": {
"kind": "ref",
"value": {
"id": "string",
"metadata": {
"doc": "string",
"aliases": [
"string"
],
"examples": [
"string"
],
"deprecated": "string",
"role": {
"tag": "multimodal"
}
}
}
}
},
"secretValue": {
"kind": "bool",
"value": true
}
}Agent Secrets API Errors
| Status Code | Description | Body |
|---|---|---|
| 400 | Invalid request, returning with a list of issues detected in the request | {"code":"string","errors":["string"]} |
| 401 | Unauthorized request | {"code":"string","error":"string"} |
| 403 | Forbidden Request | {"code":"string","error":"string"} |
| 404 | Entity not found | {"code":"string","error":"string"} |
| 409 | {"code":"string","error":"string"} | |
| 422 | Limits of the plan exceeded | {"code":"string","error":"string"} |
| 500 | Internal server error | {"code":"string","error":"string"} |