Skip to content

Latest commit

 

History

History
316 lines (224 loc) · 9.29 KB

connection.rst

File metadata and controls

316 lines (224 loc) · 9.29 KB

Connection

Defines the connection between exec-env and network-link.

Schema

Field Type Required Readonly Auto Managed Example
id String True True False http-db-connection
exec_env_id String True True False mysql-server
network_link_id String True True False eth0
description String False False False Connection for the HTTP (HyperText Transfer Protocol) and DB (DataBase) Servers.

Warning

  • It is not possible to update readonly fields.
  • it is not possible to set the auto managed fields.

Note

  • id is required but it is auto-generated if not provided. It is recommended to provide a friendly for simplify the retrieve of connected date in other indices.
  • exec_env_id should be one of those stored in exec-env index.
  • network_link_id should be one of those stored in network-link index.

Create

To create a new connection use the following REST (Representational State Transfer) call:

Read

To get the list of connections:

Update

To update a connection, use:

Delete

To delete connections, use: