Skip to main content
PUT
Choose the service behind an application's conventional connection names

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
application_id
string<uuid>
required
cluster_id
string<uuid>
required

The cluster the application environment runs on.

namespace
string
required

The application environment's namespace on that cluster.

protocol
enum<string>
required

The wire protocol whose conventional names are chosen.

Available options:
postgres,
redis,
nats,
opensearch,
s3,
victorialogs,
victoriametrics
instance_id
string<uuid> | null
required

The managed service that provides the names; it must be connected to the environment and speak the protocol. null chooses none: the application reads only each service's prefixed names.

Response

The recorded choice and the names it governs.

application_id
string<uuid>
required
cluster_id
string<uuid>
required
namespace
string
required
protocol
string
required
variables
string[]
required

The conventional names the choice governs.

instance_id
string<uuid> | null
required

The chosen service; null when none was chosen.

service_name
string | null
required

The chosen service's name; null when none was chosen.