Skip to content
Kindgi

List the values a deployment needs in a project

View as Markdown
GET
/v1/deployments/{deploymentId}/values
curl --request GET \
  --url https://example.com/v1/deployments/example/values \
  --header 'Authorization: Bearer <token>'

Every value the deployment needs set in the project before it serves there: each tool’s secrets and env values with no default, a model key for each agent version it ships or carries, and the pack service’s own env. Each is read where a run in that project reads it, under the env the runtime serves: foundAt says where it’s set, and problem why it isn’t ready. Names only, never a value. In the deployment’s own project, a value is found wherever it’s set. In another project, the one a promotion would take it to, a tool’s secret counts only at a scope the caller administers, as a promotion by the caller would record it, so the list says what that promotion’s check would say. Needs what listing secrets in that project needs (admin on it), read on the project the deployment serves, and read on the tenant, as every deployments route does.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
deploymentId
required
string
>= 1 characters

Deployment id assigned by the ledger at register time.

Query Parameters

Section titled “Query Parameters”
projectId
string format: uuid

The project the values are needed in. Default: the deployment’s own project (the tenant’s Default project for a tenant-wide deployment).

Responses

Section titled “Responses”

200

Section titled “200”

The values, names only.

Media typeapplication/json
object
data
required

Every value the deployment needs in the project: each tool’s secrets and env values (in the deployment’s order), then each model key by provider, then the pack service’s env.

Array<object>
object
name
required

The secret’s or env value’s name; for a model key, the key’s secret name, or any provider when none is registered.

string
kind
required

secret, env, model-key or pack-env; a later runtime may add kinds, so treat an unknown one as a value not yet named.

string
neededBy
required
object
type
required

tool, agent, provider or pack; a later runtime may add kinds, so treat an unknown one as a need not yet named.

string
id
required
string
version
string
foundAt

Where a run finds it, when it is set: the project, else its org, else the tenant.

string
Allowed values: project org tenant
problem

Why it isn’t ready; absent when it is. One of a fixed list; a later runtime may add problems, so treat an unknown one as a reason not yet named. missing: set nowhere a run looks. secret-not-yet: a pack env name set only as a secret, which isn’t given into a pack service’s environment yet. ambiguous: a pack env name set both as a secret and as a plain value. revoked: a tool’s secret revoked where it’s recorded, or a model key revoked where a run looks first (a run refuses rather than read a wider one). no-provider: an agent that runs on any provider (it names none, or names one that isn’t registered), with no provider registered in the tenant, so a run has none to call.

string
Example
{
  "data": [
    {
      "foundAt": "project"
    }
  ]
}

400

Section titled “400”

A projectId that isn’t a project id, or none for a deployment whose project this runtime doesn’t record (bad-input).

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

401

Section titled “401”

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

403

Section titled “403”

No admin on the project, or no read on the tenant.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

404

Section titled “404”

No deployment with that id under this tenant, or one in a project the caller doesn’t read (deployment-not-found), or projectId names no project of this tenant (project-not-found).

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

See also