For the complete documentation index, see llms.txt. This page is also available as Markdown.

Provisioning State

Get provisioning state information

get

Gets the provisioning state information (DEPRECATED: Use GET /api/v1/state/connections instead)

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Responses
200Success
application/json
get/api/v1/environments/{environment}/proxy/api/v1/state

Get raw provisioning file contents

get

Gets the raw provisioning.yaml file contents

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Responses
200Success
application/yaml

YAML manifest describing the desired connection state of the agent. Top-level keys group connections by kind; each item describes a single connection. Properties may be supplied inline (value), as a reference to another connection (reference), or as a path to an attached file (file).

get/api/v1/environments/{environment}/proxy/api/v1/state/connections

Upload complete provisioning manifest with files

post

Uploads a complete provisioning manifest as YAML along with referenced files to the configured scanner folder. This replaces the entire connection state - any existing connections not in the manifest will be deleted. If no 'lensesHq' section is provided in the manifest, the existing HQ connection will be automatically preserved.

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Body
attachedFilestring · binaryOptional

Optional file part(s) referenced from the manifest by their multipart name (e.g. SSL keystores, kerberos keytabs).

Responses
201Success
application/json
validbooleanRequired
messagestringRequired
post/api/v1/environments/{environment}/proxy/api/v1/state/connections/upload

Validate provisioning manifest with files

post

Validates a provisioning manifest with uploaded files without applying changes. Uses full upload validation (replaces entire state).

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Body
attachedFilestring · binaryOptional

Optional file part(s) referenced from the manifest by their multipart name (e.g. SSL keystores, kerberos keytabs).

Responses
200Success
application/json
validbooleanRequired
messagestringRequired
post/api/v1/environments/{environment}/proxy/api/v1/state/connections/validate/upload

Last updated

Was this helpful?