Reports the official provider CLI candidates this node observes for one provider profile, grouped into closed codes; it installs nothing, probes nothing and authorizes nothing.

GET

/v1/m/sessions/provider-profiles/{ref}/host-tools

curl --request GET \
  --url https://example.com/v1/m/sessions/provider-profiles/example/host-tools \
  --header 'Authorization: Bearer <token>'

• this engine

Reports the official provider CLI candidates this node observes for one provider profile, grouped into closed codes; it installs nothing, probes nothing and authorizes nothing.

Authorizations

• bearerAuth
• browserSession

Parameters

Path Parameters

ref

required

string

Path parameter ref.

Header Parameters

X-Olivares-Tenant

string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Responses

200

The official provider CLI candidates this node observed for the profile, counted into closed groups. It is a dated observation and grants nothing: it starts no launch, installs nothing and registers nothing. Cache-Control: no-store is returned on every answer, so a client must not cache it.

Media type application/json

object

driver

required

The profile’s normalized driver key. The set is open; observation support depends on the node’s wired observer.

string

environment_ref

required

The execution environment that administers this profile.

string

evaluated_environment_ref

required

The execution environment that answered. ALWAYS present, and empty when this node has no persistent execution-environment identity — the case state reports as not_checked_in_this_environment. An empty string is the answer, not a missing field.

string

groups

required

The counted groups, sorted. Non-empty only when state is observed; an empty array in every other state. A group counts candidates and never names them: this read publishes no path and no program argument.

Array<object>

object

configured

required

Whether the candidate is the program this profile is effectively configured to run. same and different are both observations; unknown means the comparison could not be made.

string

Allowed values: same different unknown

count

required

How many candidates fell into this group. A group is only published when it counted at least one candidate.

integer

>= 1

executable

required

Whether the observed file has an execute permission bit set. This metadata check does not prove that the current user can execute the file or that a launch will succeed.

boolean

match

required

How the candidate relates to the installation evidence. registered and manifest-corroborated describe matching evidence; unregistered-observed means a candidate was found without that evidence; unverified means verification could not be completed; damaged means an integrity or installation check failed; unknown means the observer could not classify it. These observations do not authorize a launch.

string

Allowed values: registered manifest-corroborated unregistered-observed unverified damaged unknown

origin

required

Where the candidate was found. managed is an installation this deployment administers; vendor-default is the provider’s own default location; path is a PATH lookup; named is an explicitly configured program; unknown is a candidate whose origin the observer could not classify.

string

Allowed values: managed vendor-default path named unknown

observed_at

required

string format: date-time

profile_ref

required

string

profile_version

required

integer format: int64

state

required

Observed means candidates were counted and groups is non-empty. none_observed means the observation completed and found no candidate; it is not proof of absence elsewhere on the host or in another environment. unsupported_driver means this runtime has no observer for the profile’s driver. unknown is an INCOMPLETE observation — the adapter could not answer — and is never rewritten as an absence. not_checked_in_this_environment means the node is non-local or has no persistent execution-environment identity, so no observer was called at all. In every state other than observed, groups is an empty array.

string

Allowed values: observed none_observed unsupported_driver unknown not_checked_in_this_environment

Example

{
  "groups": [
    {
      "configured": "same",
      "match": "registered",
      "origin": "managed"
    }
  ],
  "state": "observed"
}

400

Malformed profile reference, or a non-empty query string: this route declares no query parameters and does not ignore one

Media type application/json

object

Example ^generated

{}

401

Unauthenticated

Media type application/json

object

Example ^generated

{}

403

The caller lacks sessions:profile:read; nothing was inspected

Media type application/json

object

Example ^generated

{}

404

No such profile in this tenant (a profile of another tenant is indistinguishable from an absent one)

Media type application/json

object

Example ^generated

{}

409

The profile changed during the observation, so it straddled two states; it was discarded and must be read again. The body carries the same ratified stable identifier profile_changed the readiness sibling uses, so a client detects this conflict by code and never by matching the message text.

Media type application/json

object

error

required

object

code

required

Stable conflict identifier; detect the conflict by this value, never by the message text.

string

Allowed values: profile_changed

message

required

Human-readable explanation. It is localizable and may change; it is not an identifier.

string

Example

{
  "error": {
    "code": "profile_changed"
  }
}

429

Rate limited

Media type application/json

object

Example ^generated

{}

503

The profile store is unavailable, or the request was canceled before the observation completed; no observation result was published

Media type application/json

object

Example ^generated

{}