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

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

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

GET /api/v1/environments/{environment}/proxy/api/v1/state HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "connections": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "name": "text",
        "version": 1,
        "tags": [
          "text"
        ]
      }
    ]
  }
}

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

text/plain

stringOptional

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

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

GET /api/v1/environments/{environment}/proxy/api/v1/state/connections HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text

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

string · binaryOptional

Responses

201Success

application/json

validbooleanRequired

messagestringRequired

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

409

The supplied identifier is already being used by another resource

application/json

500

An internal server error has occurred

application/json

post/api/v1/environments/{environment}/proxy/api/v1/state/connections/upload

POST /api/v1/environments/{environment}/proxy/api/v1/state/connections/upload HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 8

"binary"

{
  "valid": true,
  "message": "text",
  "connections": [
    {
      "name": "text",
      "valid": true,
      "error": "text",
      "lineNumbers": [
        1
      ],
      "fieldPaths": [
        "text"
      ]
    }
  ],
  "summary": {
    "created": [
      "text"
    ],
    "updated": [
      "text"
    ],
    "deleted": [
      "text"
    ]
  }
}

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

string · binaryOptional

Responses

200Success

application/json

validbooleanRequired

messagestringRequired

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

post/api/v1/environments/{environment}/proxy/api/v1/state/connections/validate/upload

POST /api/v1/environments/{environment}/proxy/api/v1/state/connections/validate/upload HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 8

"binary"

{
  "valid": true,
  "message": "text",
  "connections": [
    {
      "name": "text",
      "valid": true,
      "error": "text",
      "lineNumbers": [
        1
      ],
      "fieldPaths": [
        "text"
      ]
    }
  ],
  "summary": {
    "created": [
      "text"
    ],
    "updated": [
      "text"
    ],
    "deleted": [
      "text"
    ]
  }
}