Backends

GET /bastion/backends

Get the list of backends

Response JSON Object:
 
  • [key].id (string) – The backend ID
  • [key].type (string) – The backend type
  • [key].config[key].id (string) – The variable ID
  • [key].config[key].editable (boolean) – If the variable is editable of not
  • [key].config[key].asArgument (boolean) – If the variable is passed as argument to terraform or in a configuration file
  • [key].config[key].protected (boolean) – If the variable is shown as a password in the GUI
  • [key].config[key].value (string) – The variable value

Example response:

{}
GET /bastion/backend/{backendID}

Get a backend

Parameters:
  • backendID – The backend ID
Response JSON Object:
 
  • id (string) – The backend ID
  • type (string) – The backend type
  • config[key].id (string) – The variable ID
  • config[key].editable (boolean) – If the variable is editable of not
  • config[key].asArgument (boolean) – If the variable is passed as argument to terraform or in a configuration file
  • config[key].protected (boolean) – If the variable is shown as a password in the GUI
  • config[key].value (string) – The variable value

Example response:

{
  "config": {}
}
POST /bastion/backend/{backendID}

Create a backend.

Parameters:
  • backendID – The backend ID
Request JSON Object:
 
  • id (string) – The backend ID
  • type (string) – The backend type
  • config[key].id (string) – The variable ID
  • config[key].editable (boolean) – If the variable is editable of not
  • config[key].asArgument (boolean) – If the variable is passed as argument to terraform or in a configuration file
  • config[key].protected (boolean) – If the variable is shown as a password in the GUI
  • config[key].value (string) – The variable value

Example query:

{
  "config": {}
}
PUT /bastion/backend/{backendID}

Update a backend.

Parameters:
  • backendID – The backend ID
Request JSON Object:
 
  • id (string) – The backend ID
  • type (string) – The backend type
  • config[key].id (string) – The variable ID
  • config[key].editable (boolean) – If the variable is editable of not
  • config[key].asArgument (boolean) – If the variable is passed as argument to terraform or in a configuration file
  • config[key].protected (boolean) – If the variable is shown as a password in the GUI
  • config[key].value (string) – The variable value

Example query:

{
  "config": {}
}
DELETE /bastion/backend/{backendID}

Delete a backend

Parameters:
  • backendID – The backend ID