GET /api/vault_connections
List VaultConnections

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

search
optional

filter results

Validations:

  • Must be a String

order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
optional

paginate results

Validations:

  • Must be a String

per_page
optional

number of entries per request

Validations:

  • Must be a String


GET /api/vault_connections/:id
Show VaultConnection details

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/vault_connections
Create a Vault Connection

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

vault_connection
required

Validations:

  • Must be a Hash

vault_connection[name]
required

Validations:

  • Must be a String

vault_connection[url]
required

Validations:

  • Must be a String

vault_connection[token]
required

Validations:

  • Must be a String


PUT /api/vault_connections/:id
Update a VaultConnection

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

vault_connection
required

Validations:

  • Must be a Hash

vault_connection[name]
optional

Validations:

  • Must be a String

vault_connection[url]
optional

Validations:

  • Must be a String

vault_connection[token]
optional

Validations:

  • Must be a String


DELETE /api/vault_connections/:id
Delete a VaultConnection

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.